@manyos/smileconnect-api 1.39.1 → 1.40.1

package/docs/howto/sample-config.md

@@ -1,518 +0,0 @@
----
-layout: page
-title: Sample Config
-subtitle: The following config will allow you to use all our samples from the how-to guides.
-use-site-title: true
----
-
-You need to a *client.json* and a *mapping.json* file in your /conf folder.
-
-The *client.json* file is for authorisation purposes. It lets you define to which records (row-level) and to which fields (attribute-level) a client has access.
-
-e.g. Client A should only have access to the incident that it has submitted and you only want to expose the fields id, summary and status. 
-
-Client B should have access to all incidents of support group ABC and you want to expose the fields id, summary, status, detailedDescription, assignee, resolution 
-
-The *mapping.json* files defines a global mapping of field names. 
-
-e.g. if you map the incident field *Detailed Decription* to *detailedDescription* than this mapping will be used inbound and outbound for all clients.
-
-# Username, ClientId & Company
-
-For all our expamples we assume that your clientId is *isapi* and that there is also a User in ITSM with the Remedy Login ID *isapi* that should be used to create new tickets. We also assume that you use BMCs Test-Company *Calbro Services*
-
-# clients.json
-{% highlight json linenos %}
-[
-  {
-    "name": "isapi",
-    "config": {
-      "options" : {
-        "dateFormat" : "dd.MM.yyyy HH:mm.ss"
-      },
-      "cmdbobject": {
-        "basequery": "'Data Set Id' = \"BMC.ASSET\" AND ('Mark As Deleted' = \"No\" OR 'Mark As Deleted' = $NULL$) AND 'Class Id' = \"BMC_COMPUTERSYSTEM\"",
-        "fields": [
-          "Instance Id",
-          "Tag Number",
-          "Name",
-          "AssetLifecycleStatus",
-          "Category",
-          "Item",
-          "Type",
-          "Availability",
-          "Confidentiality",
-          "Integrity",
-          "Authenticity",
-          "Model Number",
-          "Class Id",
-          "Reconciliation Identity",
-          "Short Description"
-        ]
-      },
-      "orgdata": {
-        "basequeryPeople": "'Profile Status' = \"Enabled\"",
-        "basequeryOrganisation": "'Status'=\"Enabled\"",
-        "basequerySupportGroup": "'Status'=\"Enabled\""
-      },
-      "change": {
-        "fields": [
-          "Infrastructure Change ID",
-          "Categorization Tier 1",
-          "Categorization Tier 2",
-          "Categorization Tier 3",
-          "Product Cat Tier 1",
-          "Product Cat Tier 2",
-          "Product Cat Tier 3",
-          "Product Name (2)",
-          "Description",
-          "Detailed Description",
-          "Status Reason",
-          "Change Request Status",
-          "Requested Start Date",
-          "Requested End Date",
-          "Scheduled Start Date",
-          "Scheduled End Date",
-          "Support Group ID",
-          "Support Group ID 2",
-          "Customer Person ID",
-          "Requested By Person ID"
-        ],
-        "constants" : [
-          {"name": "Location Company", "value" : "Calbro Services"},
-          {"name": "Company", "value" : "Calbro Services"},
-          {"name": "RequesterLoginID", "value" : "isapi"}
-        ]
-      },
-      "changeWorklog": {
-        "fields": [
-          "Description",
-          "Detailed Description"
-        ],
-        "constants" : [
-          {"name": "Status", "value" : "Enabled"},
-          {"name": "Work Log Type", "value" : "General Information"},
-          {"name": "Communication Source", "value" : "Other"},
-          {"name": "View Access", "value" : "Internal"}
-        ]
-      },
-      "workOrder": {
-        "fields": [
-          "Work Order ID",
-          "Status",
-          "InstanceId",
-          "WO Type Field 2",
-          "Categorization Tier 1",
-          "Categorization Tier 2",
-          "Categorization Tier 3",
-          "Product Cat Tier 1(2)",
-          "Product Cat Tier 2(2)",
-          "Product Cat Tier 3(2)",
-          "Product Name",
-          "Summary",
-          "Detailed Description",
-          "Status Reason",
-          "Scheduled Start Date",
-          "Scheduled End Date",
-          "Support Group ID",
-          "Support Group ID 2",
-          "Customer Person ID",
-          "Requested By Person ID"
-        ],
-        "constants" : [
-          {"name": "Location Company", "value" : "Calbro Services"},
-          {"name": "Company", "value" : "Calbro Services"},
-          {"name": "RequesterLoginID", "value" : "isapi"}
-        ]
-      },
-      "incident": {
-        "fields": [
-          "Incident Number",
-          "Status",
-          "WO Type Field 2",
-          "Categorization Tier 1",
-          "Categorization Tier 2",
-          "Categorization Tier 3",
-          "Product Categorization Tier 1",
-          "Product Categorization Tier 2",
-          "Product Categorization Tier 3",
-          "Product Name",
-          "Manufacturer",
-          "Detailed Decription",
-          "Description",
-          "Status Reason",
-          "Impact",
-          "Urgency",
-          "Priority",
-          "Assigned Group ID",
-          "Owner Group ID",
-          "Vendor Group ID",
-          "Person ID",
-          "Direct Contact Person ID"
-        ],
-        "constants" : [
-          {"name": "Impact", "value" : "4000"},
-          {"name": "Urgency", "value" : "4000"},
-          {"name": "Login_ID", "value" : "isapi"},
-          {"name": "Service_Type", "value" : "0"},
-          {"name": "Reported Source", "value" : "1000"},
-          {"name": "Status", "value" : "0"}
-        ]
-      },
-      "problem": {
-        "fields": [
-          "Problem Investigation ID",
-          "Status",
-          "WO Type Field 2",
-          "Categorization Tier 1",
-          "Categorization Tier 2",
-          "Categorization Tier 3",
-          "Product Categorization Tier 1",
-          "Product Categorization Tier 2",
-          "Product Categorization Tier 3",
-          "Product Name",
-          "Manufacturer",
-          "Detailed Decription",
-          "Description",
-          "Status Reason",
-          "Impact",
-          "Urgency",
-          "Priority",
-          "Assigned Group ID",
-          "Owner Group ID",
-          "Vendor Group ID",
-          "Person ID",
-          "Direct Contact Person ID"
-        ],
-        "constants" : [
-          {"name": "Impact", "value" : "4000"},
-          {"name": "Urgency", "value" : "4000"},
-          {"name": "Login_ID", "value" : "isapi"},
-          {"name": "Service_Type", "value" : "0"},
-          {"name": "Reported Source", "value" : "1000"},
-          {"name": "Status", "value" : "0"}
-        ]
-      },
-      "workOrderWorklog": {
-        "fields": [
-          "Description",
-          "Detailed Description"
-        ],
-        "constants" : [
-          {"name": "Status", "value" : "Enabled"},
-          {"name": "Work Log Type", "value" : "General Information"},
-          {"name": "Communication Source", "value" : "Other"}
-        ]
-    },
-      "incidentWorklog": {
-        "fields": [
-          "Description",
-          "Detailed Description"
-        ],
-        "constants" : [
-          {"name": "Status", "value" : "Enabled"},
-          {"name": "Work Log Type", "value" : "General Information"},
-          {"name": "Communication Source", "value" : "Other"}
-        ]
-      },
-      "problemWorklog": {
-        "fields": [
-          "Description",
-          "Detailed Description"
-        ],
-        "constants" : [
-          {"name": "Status", "value" : "Enabled"},
-          {"name": "Work Log Type", "value" : "General Information"},
-          {"name": "Communication Source", "value" : "Other"}
-        ]
-      },
-      "task": {
-        "basequery" : "1=1",
-        "fields": [
-          "Status",
-          "InstanceId",
-          "Sequence",
-          "Service Cat Tier 1",
-          "Service Cat Tier 2",
-          "Service Cat Tier 3",
-          "Product Cat Tier 1",
-          "Product Cat Tier 2",
-          "Product Cat Tier 3",
-          "Product Name",
-          "Summary",
-          "Notes",
-          "StatusReasonSelection",
-          "Scheduled Start Date",
-          "Scheduled End Date",
-          "Assignee Group ID",
-          "Customer Person ID",
-          "Requested By Person ID",
-          "Actual Start Date",
-          "Actual End Date",
-          "Character 06",
-          "Character 01",
-          "Support Company",
-          "Assignee Organization",
-          "Assignee Group"
-        ],
-        "constants" : [
-          {"name": "Location Company", "value" : "Calbro Services"},
-          {"name": "TaskType", "value" : "2000"},
-          {"name": "Status", "value" : "1000"}
-        ]
-      },
-      "taskWorklog": {
-        "constants" : [
-          {"name": "Status", "value" : "Enabled"},
-          {"name": "WorkInfoType", "value" : "General Information"},
-          {"name": "Communication Source", "value" : "Other"},
-          {"name": "View Access", "value" : "Internal"}
-        ]
-      },
-      "flowBuilder": {
-        "constants" : [
-          {"name": "Location Company", "value" : "Calbro Services"}
-        ]
-      }
-  }
-  }
-]
-{% endhighlight %}
-
-# mapping.json
-
-{% highlight json linenos %}
-{
-  "cmdbobject":[
-    {"oldName":"Instance Id", "newName" : "id"},
-    {"oldName":"Tag Number", "newName" : "tagNumber"},
-    {"oldName":"Name", "newName" : "name"},
-    {"oldName":"AssetLifecycleStatus", "newName" : "assetlifecycleStatus"},
-    {"oldName":"Category", "newName" : "category"},
-    {"oldName":"Item", "newName" : "item"},
-    {"oldName":"Type", "newName" : "type"},
-    {"oldName":"Availability", "newName" : "availability"},
-    {"oldName":"Confidentiality", "newName" : "confidentiality"},
-    {"oldName":"Integrity", "newName" : "integrity"},
-    {"oldName":"Authenticity", "newName" : "authenticity"},
-    {"oldName":"Model Number", "newName" : "productName"},
-    {"oldName":"Class Id", "newName" : "classId"},
-    {"oldName":"Reconciliation Identity", "newName" : "reconId"},
-    {"oldName":"Short Description", "newName" : "shortDescription"}
-  ],
-  "change":[
-    {"oldName":"Infrastructure Change ID", "newName" : "id"},
-    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
-    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
-    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
-    {"oldName":"Product Cat Tier 1", "newName" : "prodCat1"},
-    {"oldName":"Product Cat Tier 2", "newName" : "prodCat2"},
-    {"oldName":"Product Cat Tier 3", "newName" : "prodCat3"},
-    {"oldName":"Product Name (2)", "newName" : "productName"},
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
-    {"oldName":"Status Reason", "newName" : "statusReason"},
-    {"oldName":"Change Request Status", "newName" : "status"},
-    {"oldName":"Requested Start Date", "newName" : "requestedStartDate"},
-    {"oldName":"Requested End Date", "newName" : "requestedEndDate"},
-    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
-    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
-    {"oldName":"Support Group ID", "newName" : "managerGroup"},
-    {"oldName":"Support Group ID 2", "newName" : "coordinatorGroup"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"},
-    {"oldName":"Requested By Person ID", "newName" :  "requestorId"}
-  ],
-  "newChange":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"TemplateID", "newName" : "template"}
-  ],
-  "changeWorklog":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "text"},
-    {"oldName":"Infrastructure Change ID", "newName" : "Infrastructure Change ID"},
-    {"oldName":"Infra. Change Entry ID", "newName" : "Infra. Change Entry ID"},
-    {"oldName":"Work Log ID", "newName" : "worklogId"}
-  ],
-  "workOrder":[
-    {"oldName":"Work Order ID", "newName" : "id"},
-    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
-    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
-    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
-    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
-    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
-    {"oldName":"Product Cat Tier 1(2)", "newName" : "prodCat1"},
-    {"oldName":"Product Cat Tier 2(2)", "newName" : "prodCat2"},
-    {"oldName":"Product Cat Tier 3(2)", "newName" : "prodCat3"},
-    {"oldName":"Product Name", "newName" : "productName"},
-    {"oldName":"Summary", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
-    {"oldName":"Status Reason", "newName" : "statusReason"},
-    {"oldName":"Status", "newName" : "status"},
-    {"oldName":"Support Group ID", "newName" : "managerGroup"},
-    {"oldName":"Support Group ID 2", "newName" : "coordinatorGroup"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"},
-    {"oldName":"Requested By Person ID", "newName" :  "requestorId"}
-  ],
-  "newWorkOrder":[
-    {"oldName":"Summary", "newName" : "summary"},
-    {"oldName":"TemplateID", "newName" : "template"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"},
-    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
-    {"oldName":"Vendor Ticket Number", "newName" : "vendorTicketId"}
-  ],
-  "workOrderWorklog":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "text"},
-    {"oldName":"WorkOrder_EntryID", "newName" : "WorkOrder_EntryID"},
-    {"oldName":"Work Order ID", "newName" : "Work Order ID"},
-    {"oldName":"Work Log ID", "newName" : "worklogId"}
-  ],
-  "incidentWorklog":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "text"},
-    {"oldName":"Incident Number", "newName" : "Incident Number"},
-    {"oldName":"Incident Entry ID", "newName" : "Incident Entry ID"},
-    {"oldName":"Work Log ID", "newName" : "id"}
-  ],
-  "problemWorklog":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "text"},
-    {"oldName":"Problem Investigation ID", "newName" : "Problem Investigation ID"},
-    {"oldName":"Problem Investigation Entry ID", "newName" : "Problem Investigation Entry ID"},
-    {"oldName":"Work Log ID", "newName" :  "worklogId"}
-  ],
-  "incident":[
-    {"oldName":"Incident Number", "newName" : "id"},
-    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
-    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
-    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
-    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
-    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
-    {"oldName":"Resolution Category", "newName" : "resolutionCat1"},
-    {"oldName":"Resolution Category Tier 2", "newName" : "resolutionCat2"},
-    {"oldName":"Resolution Category Tier 3", "newName" : "resolutionCat3"},
-    {"oldName":"Product Categorization Tier 1", "newName" : "prodCat1"},
-    {"oldName":"Product Categorization Tier 2", "newName" : "prodCat2"},
-    {"oldName":"Product Categorization Tier 3", "newName" : "prodCat3"},
-    {"oldName":"Product Name", "newName" : "productName"},
-    {"oldName":"Manufacturer", "newName" : "manufacturer"},
-    {"oldName":"Detailed Decription", "newName" : "detailedDescription"},
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Status_Reason", "newName" : "statusReason"},
-    {"oldName":"Status", "newName" : "status"},
-    {"oldName":"Assigned Group ID", "newName" : "assignedGroup"},
-    {"oldName":"Owner Group ID", "newName" : "ownerGroup"},
-    {"oldName":"Vendor Group ID", "newName" : "vendorGroup"},
-    {"oldName":"Person ID", "newName" : "customerId"},
-    {"oldName":"Direct Contact Person ID", "newName" : "contactId"},
-    {"oldName":"Requested By Person ID", "newName" :  "requestorId"},
-    {"oldName":"Impact", "newName" :  "impact"},
-    {"oldName":"Urgency", "newName" :  "urgency"},
-    {"oldName":"Priority", "newName" :  "priority"},
-    {"oldName":"Vendor Ticket Number", "newName" : "vendorTicketId"},
-    {"oldName":"Resolution", "newName":"resolution"}
-  ],
-  "newIncident":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"TemplateID", "newName" : "template"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"},
-    {"oldName":"Detailed_Decription", "newName" : "detailedDescription"},
-    {"oldName":"Vendor Ticket Number", "newName" : "vendorTicketId"}
-  ],
-   "problem":[
-    {"oldName":"Problem Investigation ID", "newName" : "id"},
-    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
-    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
-    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
-    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
-    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
-    {"oldName":"Product Categorization Tier 1", "newName" : "prodCat1"},
-    {"oldName":"Product Categorization Tier 2", "newName" : "prodCat2"},
-    {"oldName":"Product Categorization Tier 3", "newName" : "prodCat3"},
-    {"oldName":"Product Name", "newName" : "productName"},
-    {"oldName":"Manufacturer", "newName" : "manufacturer"},
-    {"oldName":"Detailed Decription", "newName" : "detailedDescription"},
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Status Reason", "newName" : "statusReason"},
-    {"oldName":"Status", "newName" : "status"},
-    {"oldName":"Assigned Group ID", "newName" : "assignedGroup"},
-    {"oldName":"Owner Group ID", "newName" : "ownerGroup"},
-    {"oldName":"Vendor Group ID", "newName" : "vendorGroup"},
-    {"oldName":"Person ID", "newName" : "customerId"},
-    {"oldName":"Direct Contact Person ID", "newName" : "contactId"},
-    {"oldName":"Requested By Person ID", "newName" :  "requestorId"},
-    {"oldName":"Impact", "newName" :  "impact"},
-    {"oldName":"Urgency", "newName" :  "urgency"},
-    {"oldName":"Priority", "newName" :  "priority"}
-  ],
-  "newProblem":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"TemplateID", "newName" : "template"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"},
-    {"oldName":"Detailed Decription", "newName" : "detailedDescription"}
-  ],
-  "task":[
-    {"oldName":"Summary", "newName" : "summary"},
-    {"oldName":"Notes", "newName" : "notes"},
-    {"oldName":"Task ID", "newName" : "id"},
-    {"oldName":"Status", "newName" : "status"},
-    {"oldName":"StatusReasonSelection", "newName" : "statusReason"},
-    {"oldName":"Actual Start Date", "newName" : "actualStartDate"},
-    {"oldName":"Actual End Date", "newName" : "actualEndDate"},
-    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
-    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
-    {"oldName":"InstanceId", "newName" : "instanceId"},
-    {"oldName":"RootRequestFormName", "newName" : "rootRequestForm"},
-    {"oldName":"RootRequestID", "newName" : "rootRequest"},
-    {"oldName":"Sequence", "newName" : "sequence"},
-    {"oldName":"Service Cat Tier 1", "newName" : "opsCat1"},
-    {"oldName":"Service Cat Tier 2", "newName" : "opsCat2"},
-    {"oldName":"Service Cat Tier 3", "newName" : "opsCat3"},
-    {"oldName":"Product Cat Tier 1", "newName" : "prodCat1"},
-    {"oldName":"Product Cat Tier 2", "newName" : "prodCat2"},
-    {"oldName":"Product Cat Tier 3", "newName" : "prodCat3"},
-    {"oldName":"Product Name", "newName" : "productName"},
-    {"oldName":"Assignee Group ID", "newName" : "assignedGroup"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"},
-    {"oldName":"Requested By Person ID", "newName" :  "requestorId"},
-    {"oldName":"Character 01", "newName" :  "character01"},
-    {"oldName":"Character 06", "newName" :  "character06"},
-    {"oldName":"Support Company", "newName" : "supportCompany"},
-    {"oldName":"Assignee Organization", "newName" : "supportOrganization"},
-    {"oldName":"Assignee Group", "newName" : "supportGroup"}
-  ],
-  "newTask":[
-    {"oldName":"Summary", "newName" : "summary"},
-    {"oldName":"Notes", "newName" : "notes"},
-    {"oldName":"Support Company", "newName" : "supportCompany"},
-    {"oldName":"Assignee Organization", "newName" : "supportOrganization"},
-    {"oldName":"Assignee Group", "newName" : "supportGroup"},
-    {"oldName":"RootRequestFormName", "newName" : "RootRequestFormName"},
-    {"oldName":"RootRequestName", "newName" : "RootRequestName"},
-    {"oldName":"RootRequestMode", "newName" : "RootRequestMode"},
-    {"oldName":"RootRequestInstanceId", "newName" : "RootRequestInstanceId"},
-    {"oldName":"Sequence", "newName" : "Sequence"},
-    {"oldName":"TaskName", "newName" : "TaskName"},
-    {"oldName":"Character 01", "newName" :  "character01"},
-    {"oldName":"Character 06", "newName" :  "character06"}
-  ],
-  "taskWorkLog":[
-    {"oldName":"Summary", "newName" : "Summary"},
-    {"oldName":"Notes", "newName" : "Notes"},
-    {"oldName":"Secure Log", "newName" : "Secure Log"},
-    {"oldName":"Communication Source", "newName" : "Communication Source"},
-    {"oldName":"WorkInfoType", "newName" : "WorkInfoType"},
-    {"oldName":"TaskOrTaskGroupID", "newName" : "TaskOrTaskGroupID"},
-    {"oldName":"TaskOrTaskGroupInstanceId", "newName" : "TaskOrTaskGroupInstanceId"}
-  ],
-  "flowBuilder":[
-    {"oldName":"RootRequestFormName", "newName" : "RootRequestFormName"},
-    {"oldName":"RootRequestName", "newName" : "RootRequestName"},
-    {"oldName":"RootRequestInstanceId", "newName" : "RootRequestInstanceId"},
-    {"oldName":"zTmpInternalCommand", "newName" : "zTmpInternalCommand"},
-    {"oldName":"Parent Type", "newName" : "Parent Type"},
-    {"oldName":"ParentID", "newName" : "ParentID"},
-    {"oldName":"Parent Name", "newName" : "Parent Name"}
-  ]
-}
-{% endhighlight %}