@manyos/smileconnect-api 1.39.1 → 1.40.1

package/docs/configuration/clients.md

@@ -0,0 +1,589 @@
+# Client Config
+
+On a per client base it can be configured which fields are returned for each object and if a basequery is applied. This expose certain fields only dedicated clients. It also allows to define which rows a client can access. Clients are configured in conf/clients.json
+
+Client configurations are stored in the /conf/clients.json file. They can be managed in the GUI.
+
+## Manage client configs
+
+![Client Configuration](../_media/gui_client_fields.png)
+
+## Sample client config
+
+```json
+[
+  {
+    "name": "jira",
+    "config": {
+      "options": {
+        "dateFormat": "dd.MM.yyyy HH:mm.ss",
+        "clientLimit": 1000,
+        "impersonateUser": "Allen",
+        "allowDynamicImpersonate": true,
+        "translateSelectionFields": false
+      },
+      "custom_Sample:Enrollments": {
+        "formName": "Sample:Enrollments",
+        "basequery": "1=1",
+        "fields": [
+          "Enrollment ID",
+          "Enrollee Login",
+          "Class ID",
+          "Class Title",
+          "Class Location",
+          "Class Cost",
+          "Department",
+          "Class Start Date & Time"
+        ]
+      },
+      "cmdbobject": {
+        "basequery": "'Data Set Id' = \"BMC.ASSET\" AND ('Mark As Deleted' = \"No\" OR 'Mark As Deleted' = $NULL$)",
+        "fields": [
+          "Instance Id",
+          "Tag Number",
+          "Name",
+          "AssetLifecycleStatus",
+          "Category",
+          "Item",
+          "Type",
+          "Availability",
+          "Confidentiality",
+          "Class Id",
+          "Authenticity",
+          "Model Number",
+          "Reconciliation Identity",
+          "Short Description"
+        ],
+        "fields_AST:ComputerSystem": [
+          "DNS Host Name"
+        ],
+        "fields_AST:LANEndpoint": [
+          "MACAddress"
+        ],
+        "constants": [
+          {
+            "name": "Location Company",
+            "value": "Calbro Services and Weapons"
+          }
+        ],
+        "scripts": {
+          "GET": {
+            "preMapping": [
+              "script1",
+              "script2"
+            ],
+            "postMapping": [
+              "script2"
+            ]
+          },
+          "POST": {
+            "preMapping": [
+              "scriptPutPre"
+            ],
+            "postMapping": [
+              "scriptPutPost"
+            ]
+          }
+        }
+      },
+      "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",
+          "Change Target Date"
+        ],
+        "constants": [
+          {
+            "name": "Location Company",
+            "value": "Calbro Services"
+          },
+          {
+            "name": "Company",
+            "value": "Calbro Services"
+          },
+          {
+            "name": "RequesterLoginID",
+            "value": "Allen"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "person": {
+        "basequery": "1=1",
+        "fields": [
+          "Person ID",
+          "Full Name",
+          "Remedy Login ID",
+          "Internet E-mail",
+          "Department"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "supportGroup": {
+        "basequery": "1=1",
+        "fields": [
+          "Support Group ID",
+          "Company",
+          "Support Organization",
+          "Support Group Name",
+          "Support Group Role"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "organisation": {
+        "basequery": "1=1",
+        "fields": [
+          "People Organization ID",
+          "Company",
+          "Organization",
+          "Department"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "changeWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description",
+          "Work Log Date"
+        ],
+        "constants": [
+          {
+            "name": "Status",
+            "value": "Enabled"
+          },
+          {
+            "name": "Work Log Type",
+            "value": "General Information"
+          },
+          {
+            "name": "Communication Source",
+            "value": "Other"
+          },
+          {
+            "name": "View Access",
+            "value": "Internal"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "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": "Allen"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "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",
+          "Submit Date",
+          "Last Modified Date",
+          "Resolution"
+        ],
+        "constants": [
+          {
+            "name": "Impact",
+            "value": "4000"
+          },
+          {
+            "name": "Urgency",
+            "value": "4000"
+          },
+          {
+            "name": "Login_ID",
+            "value": "Allen"
+          },
+          {
+            "name": "Service_Type",
+            "value": "0"
+          },
+          {
+            "name": "Reported Source",
+            "value": "1000"
+          },
+          {
+            "name": "Status",
+            "value": "0"
+          }
+        ],
+        "basequery": "1=1",
+        "scripts": {
+          "GET": {
+            "preMapping": [
+              "checkGlobalParams"
+            ],
+            "postMapping": [
+              "p2"
+            ],
+            "afterExecution": [
+              "script3"
+            ]
+          },
+          "POST": {
+            "preMapping": [
+              "p1"
+            ],
+            "postMapping": [
+              "p3"
+            ],
+            "afterExecution": [
+              "p4"
+            ]
+          },
+          "PUT": {
+            "preMapping": [],
+            "postMapping": [
+              "p3"
+            ],
+            "afterExecution": [
+              "p4"
+            ]
+          }
+        }
+      },
+      "problem": {
+        "fields": [
+          "Problem Investigation ID",
+          "Investigation 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",
+          "Target Resolution Date"
+        ],
+        "constants": [
+          {
+            "name": "Impact",
+            "value": "4000"
+          },
+          {
+            "name": "Urgency",
+            "value": "4000"
+          },
+          {
+            "name": "Status",
+            "value": "0"
+          },
+          {
+            "name": "Investigation Driver",
+            "value": "High Impact Incident"
+          },
+          {
+            "name": "Requestor ID",
+            "value": "Allen"
+          },
+          {
+            "name": "Company",
+            "value": "Calbro Services"
+          },
+          {
+            "name": "z1D_Action",
+            "value": "PROBLEM"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "workOrderWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants": [
+          {
+            "name": "Status",
+            "value": "Enabled"
+          },
+          {
+            "name": "Work Log Type",
+            "value": "General Information"
+          },
+          {
+            "name": "Communication Source",
+            "value": "Other"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "incidentWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants": [
+          {
+            "name": "Status",
+            "value": "Enabled"
+          },
+          {
+            "name": "Work Log Type",
+            "value": "General Information"
+          },
+          {
+            "name": "Communication Source",
+            "value": "Other"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "problemWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants": [
+          {
+            "name": "Status",
+            "value": "Enabled"
+          },
+          {
+            "name": "Work Log Type",
+            "value": "General Information"
+          },
+          {
+            "name": "Communication Source",
+            "value": "Other"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "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"
+          }
+        ],
+        "scripts": {}
+      },
+      "taskWorklog": {
+        "fields": [
+          "Summary",
+          "Notes"
+        ],
+        "constants": [
+          {
+            "name": "Status",
+            "value": "Enabled"
+          },
+          {
+            "name": "WorkInfoType",
+            "value": "General Information"
+          },
+          {
+            "name": "Communication Source",
+            "value": "Other"
+          },
+          {
+            "name": "View Access",
+            "value": "Internal"
+          }
+        ],
+        "basequery": "",
+        "scripts": {}
+      },
+      "flowBuilder": {
+        "constants": [
+          {
+            "name": "Location Company",
+            "value": "Calbro Services"
+          }
+        ],
+        "basequery": "",
+        "fields": [],
+        "scripts": {}
+      },
+      "changeTemplate": {
+        "basequery": "1=1",
+        "fields": [
+          "Template Name",
+          "Description",
+          "Detailed Description",
+          "InstanceId"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "incidentTemplate": {
+        "basequery": "1=1",
+        "fields": [
+          "InstanceId",
+          "Template Name",
+          "Description",
+          "Detailed Decription"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "problemTemplate": {
+        "basequery": "1=1",
+        "fields": [
+          "InstanceId",
+          "Template Name",
+          "Description",
+          "Detailed Decription"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrderTemplate": {
+        "basequery": "1=1",
+        "fields": [
+          "GUID",
+          "Summary",
+          "Notes",
+          "Template Name"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "taskTemplate": {
+        "basequery": "1=1",
+        "fields": [
+          "InstanceId",
+          "TaskName",
+          "Summary",
+          "Notes",
+          "Company",
+          "Assignee Organization",
+          "Assignee Group"
+        ],
+        "constants": [],
+        "scripts": {}
+      }
+    }
+  }
+]
+```