@manyos/smileconnect-api 1.55.5 → 1.57.0

package/conf/mapping.json

@@ -77,6 +77,12 @@
       "newName": "macAddress"
     }
   ],
+  "cmdbobject_AST:Cluster": [
+    {
+      "oldName": "InstanceId",
+      "newName": "id"
+    }
+  ],
   "change": [
     {
       "oldName": "Infrastructure Change ID",

package/controller/cmdbobjectController.js

@@ -342,7 +342,7 @@ async function updateCmdbObject(ticketConfig, clientConfig, id, ciData, classId,
         await scriptController.runScripts(scripts.postMapping, ciData, clientConfig.clientId, globalScriptParams);
     }
 
-    const update = await arquery.updateEntry(formName, ci['Request ID'], ciData);
+    const update = await arquery.updateEntry(formName, ci['Request ID'], ciData, clientConfig.options);
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {
@@ -403,27 +403,34 @@ async function createCmdbObject(assetConfig, clientConfig, classId, ciData, glob
 
     const mapping = getClassMapping(classId);
 
-    const classFields = getClassFields(clientConfig, classId)
+    const classFields = getClassFields(clientConfig, classId);
 
-    //Constants work only on new.
-    ciData = mappingUtil.applyMapping2Remedy(ciData, mapping, undefined, classFields);
+    const reconIdField = await config.getFormFieldById(classId, 400129200);
+    const instanceIdField = await config.getFormFieldById(classId, 179);
+    const dataSetIdField = await config.getFormFieldById(classId, 400127400);
 
-    //run postMapping
-    if (scripts && scripts.postMapping) {
-        await scriptController.runScripts(scripts.postMapping, ciData, clientConfig.clientId, globalScriptParams);
+    if (!reconIdField || !instanceIdField || !dataSetIdField) {
+        throw ({message: "RecondId, InstanceId or Dataset not found on form", field:{reconIdField, instanceIdField, dataSetIdField}})
     }
+    //Constants work only on new.
+    ciData = mappingUtil.applyMapping2Remedy(ciData, mapping, undefined, classFields);
 
     //Default to BMC.ASSET if no Dataset is provided
-    if (!ciData['Data Set Id']) {
-        ciData['Data Set Id'] = "BMC.ASSET"
+    if (!ciData[dataSetIdField.name]) {
+        ciData[dataSetIdField.name] = "BMC.ASSET"
     }
     //Add reconId only for Asset Dataset
-    if (ciData['Data Set Id'] === "BMC.ASSET") {
-        ciData['400129200'] = reconId;
+    if (ciData[dataSetIdField.name] === "BMC.ASSET") {
+        ciData[reconIdField.name] = reconId;
+    }
+    ciData[instanceIdField.name] = instanceId;
+
+    //run postMapping
+    if (scripts && scripts.postMapping) {
+        await scriptController.runScripts(scripts.postMapping, ciData, clientConfig.clientId, globalScriptParams);
     }
-    ciData['Instance Id'] = instanceId;
 
-    const update = await arquery.createEntry(classId, ciData);
+    const update = await arquery.createEntry(classId, ciData, clientConfig.options);
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {

package/controller/customFormController.js

@@ -181,7 +181,7 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
 
     const internalId = await getInternalId(formConfig, clientConfig, id)
 
-    const update = await arquery.updateEntry(formConfig.formName, internalId, recordData);
+    const update = await arquery.updateEntry(formConfig.formName, internalId, recordData, clientConfig.options);
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {

package/controller/eventLogController.js

@@ -64,6 +64,10 @@ function setEventData(req, eventBase, eventAction, schemaName, ticketNumber, jso
         "ticketNumber3": ticketNumber3,
         "jsonData" : jsonData
     };
+    if (!req.globalScriptParams) {
+        req.globalScriptParams = {}
+    }
+    req.globalScriptParams.event = req.eventData.event;
 }
 
 function setTicketId(req, ticketNumber) {

package/controller/scriptController.js

@@ -9,7 +9,7 @@ const basePathGlobalScripts = basePath + '/scripts';
 const fetch = require('node-fetch');
 const xmlParser = require('fast-xml-parser')
 
-const {getClients} = require('../util/config');
+const {getClients, getClient, setClient} = require('../util/config');
 
 require('dotenv').config();
 const {NodeVM} = require('vm2');
@@ -118,6 +118,31 @@ async function getGlobalScript(scriptId) {
     return readScriptFromFile(fileName);
 }
 
+async function renameScript(scriptIdOld, scriptIdNew) {
+    const script = await getGlobalScript(scriptIdOld)
+    const usages = await getUsage(scriptIdOld)
+    await deleteGlobalScript(scriptIdOld)
+    await setGlobalScript(scriptIdNew, script)
+    //rename references
+    for (let x=0; x< usages.length; x++) {
+        const usage = usages[x]
+        const clientConfig = await getClient(usage.client)
+        const configItem = clientConfig.config[usage.key]
+        const scriptDefOps = configItem.scripts[usage.operation]
+        const scriptDef = scriptDefOps[usage.scriptType]
+        if (scriptDef) {
+            const scriptDefNew = scriptDef.map(item => {
+                if (item === scriptIdOld)
+                    return scriptIdNew
+                else return item
+            })
+            scriptDefOps[usage.scriptType] = scriptDefNew
+        }
+        setClient(usage.client, clientConfig)
+    }
+    return true;
+}
+
 async function setGlobalScript(scriptId, code) {
     return setScript(basePathGlobalScripts, scriptId, code);
 }
@@ -263,6 +288,7 @@ module.exports = {
     getGlobalScript,
     getGlobalScripts,
     setGlobalScript,
+    renameScript,
     deleteGlobalScript,
     runScripts,
     getUsage

package/controller/taskController.js

@@ -445,7 +445,7 @@ async function updateTask(clientConfig, id, taskData, globalScriptParams) {
         await scriptController.runScripts(scripts.postMapping, taskData, clientConfig.clientId, globalScriptParams);
     }
 
-    const result = await arquery.updateEntry('TMS:Task', id, taskData);
+    const result = await arquery.updateEntry('TMS:Task', id, taskData, clientConfig.options);
 
     //flow update
     const taskQuery = `'1' = "${id}"`

package/controller/ticketController.js

@@ -24,7 +24,7 @@ async function createTicket(ticketConfig, clientConfig, data, globalScriptParams
     const relations = data.relations || {}
     //run preScripts
     if (scripts && scripts.preMapping) {
-        await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId);
+        await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId, globalScriptParams);
     }
 
     const requestType = ticketConfig.requestType;
@@ -123,6 +123,8 @@ async function handleTicket(ticketConfig, ticket, mapping, clientConfig, include
         scripts = allScripts.GET || [];
     }
 
+    globalScriptParams.id = ticket[ticketConfig.requestIdField]
+
     const requestType = ticketConfig.requestType;
     if (requestType === 'incident') {
         checkFieldsIncident(ticket, globalRelationObjects);
@@ -312,7 +314,7 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalSc
         relations.keepCIs = [ticket.data.serviceReconId]
     }
     //todo Abfangen wenn getTicket nichts liefert.
-    const update = await arquery.updateEntry(ticketConfig.forms.regular, ticket.data.internalId, ticketData);
+    const update = await arquery.updateEntry(ticketConfig.forms.regular, ticket.data.internalId, ticketData, clientConfig.options);
     await ticketCIRelationController.updateRelations(ticketConfig, clientConfig, id, relations);
     //run afterExecution
     if (scripts && scripts.afterExecution) {

package/docs/_sidebar.md

@@ -11,6 +11,7 @@
   - [Mapping](configuration/mapping)
   - [Client Configuration](configuration/clients)
   - [Events](configuration/events)
+  - [Webhooks](configuration/webhooks)
 
 - Data manipulation
 

package/docs/adapter.md

@@ -308,6 +308,9 @@ e.g.
 }
 ```
 
+* impersonateUser
+
+Can be used to set the user during adapter calls.
 
 * countOnly (only search)
 
@@ -320,6 +323,7 @@ const options = {
     limit: 100,
     offset: 100,
     dafeFormat: "yyyy-MM-dd HH:mm:ss.SSSZ",
+    impersonateUser: "Allen",
     sort: {
         "Name": 1,
         "Status": -1

package/docs/configuration/config.md

@@ -312,6 +312,21 @@ ADMIN_USERS=username1, username2
 
 Loglevel of the api. Defaults to *error*
 
+## Certificates
+
+### NODE_EXTRA_CA_CERTS
+
+If you need to validate custom certificates in your webhooks you can define a file with them here.
+
+Sample:
+
+*NODE_EXTRA_CA_CERTS = "/home/node/app/ssl/Chain.crt"*
+
+This file needs to be available within the container.
+
+[See also](https://nodejs.org/api/cli.html#node_extra_ca_certsfile)
+
+
 # GUI
 
 ## SMILEconnect
@@ -381,3 +396,15 @@ Use this to disable modules in SMILEconnect.
 
 Sample:
 *REACT_APP_DISABLED_MODULES=workOrder,problem*
+
+### REACT_APP_MAPPING_SYNC
+If you need to disable the Field Sync from Form mapping to new mapping (for example incident to newIncident),
+you can set this parameter to DISABLE
+Sample:
+*REACT_APP_MAPPING_SYNC=DISABLE*
+
+### REACT_APP_MAPPING_SYNC_CHECK 
+If you need to disable the Field Sync Warning From form mapping to new mapping (for example incident to newIncident),
+you can set this parameter to DISABLE.
+Sample:
+*REACT_APP_MAPPING_SYNC_CHECK=DISABLE*

package/docs/configuration/webhooks.md

@@ -0,0 +1,97 @@
+# Webhooks
+
+## Sample
+
+```json
+[
+  {
+  "client": "isms",
+  "webhooks": [
+    {
+      "name": "allInc",
+      "url": "https://myUrl.example.com",
+      "event": "INC",
+      "secret": "123geheim",
+      "insecure": false,
+      "jsonSpace": 2,
+      "auth": {
+        "type": "basic",
+        "user": "user123",
+        "password": "pass123"
+      },
+      "scripts": [
+        "p1",
+        "p4"
+      ]
+    }
+  ]
+  }
+]
+```
+
+## Configuration Options
+
+### name
+
+Name of the webhook.
+
+### url
+
+Url that will be called. All webhooks will be sent as POST requests.
+
+### event
+
+The event that the webhook subscribed to. The system will check if the definition is contained in the actual event.
+
+e.g. 
+
+* INC will capture all Incident events.
+* modified will capture all modified events.
+
+### secret
+
+This mechanism can be used if the webhook endpoint does not support authentication but still wants to verify that the sent webhook is valid and was sent by your system.
+
+If set the body of the request will hashed and the signature will be added to the header as *x-isapi-signature* in the format *algorithm:signature*
+
+e.g. The following body with the secret *123geheim* will generate the below signature header.
+
+```json
+{
+  "event": "TestOnly",
+  "objectId": "Test1234",
+  "objectId2": "Test1234.3"
+}
+```
+
+"x-isapi-signature": "sha256:66976bf984b48cd18441b489c50a886dcf51f910e82d3736e8c5e00110c3df95"
+
+### insecure
+
+Disables SSL certification validation. Use this with caution.
+
+### jsonSpace
+
+When set the body of the webhook will be formatted with spaces.
+
+### auth
+
+If your endpoint requires authentication this can be used.
+
+#### type
+
+Type of authentication. Currently only basic is supported.
+
+#### user
+
+Username for basic authentication.
+
+#### password
+
+Passwort for basic authentication.
+
+###
+
+### scripts
+
+An array of scripts that are executed when the webhook is fired. Can be used to transform data or to populate the outbound request with ticket data.

package/docs/releases.md

@@ -2,6 +2,19 @@
 
 ## API 
 
+### 1.57.0 - 25.03.22
+
+Add impersonate to update requests.
+Impersonate works not on the following requests:
+- Add/Read Attachments
+- Ticket/CI Relations
+
+Make DatasetId-, ReconId- & InstanceId-Fields dynamic on CMDBCreate Operations
+
+### 1.56.0 - 03.03.22
+Support Script Rename with references
+Add event to globalScriptParams
+
 ### 1.55.5 - 03.03.22
 Allow startup with broken SMILEconnect Adapter SSO Url.
 
@@ -147,6 +160,9 @@ e.g.
 
 ## Event Manager
 
+### 1.22.0 - 03.03.22
+Add updateScriptReference
+
 ### 1.21.0 - 14.02.22
 Add Auto Resolve to Scripts
 
@@ -175,12 +191,16 @@ Update Record added to [Remedy Adapter](adapter#remedy).
 The eventmanager will check all outbound webhooks for an event. If one fails, the whole Event will be set to error and the details will be added to the error message.
 
 ## GUI
+### 1.9.2 - 08.03.22
+Fixed: Sync mapping not working correctly in some situations
+Feat: Mapping: Added warning to "new" Form mapping, if a mapping is missing (you can disble this with parameter REACT_APP_MAPPING_SYNC_CHECK=DISABLE
+Feat: Use the following Parameter to disable sync from module mapping to new mapping REACT_APP_MAPPING_SYNC=DISABLE
 
-### 1.8.2 - 2.3.22
+### 1.8.2 - 02.03.22
 Fixed: delete webhooks for client when client is deleted
 Fixed: delete button / menu is hidden when client or scriptname is too long 
 
-### 1.8.0 - 3.2.22
+### 1.8.0 - 03.02.22
 Fixed wrong Script Config for Custom Form Scripts (attribute clients instead of scripts)
 Fixed Scrolling
 Fixed navigation error from "Import/Export" to a client

package/docs/scripts.md

@@ -115,8 +115,12 @@ Global script params are set by the application and handed over to the script. T
 
 **classId**: the classId of cmdbobjects. Only set in POST & PUT actions
 
+**event**: the event that this transaction creates. e.g. INC_Create, CHG_TAS_Modify
+
 **sourceData**: Contains the original body for PUT/POST request. This can be used scripts to access custom data that was removed during mapping.
 
+**user**: Contains the full configuration of the client. The attribute user.config.options.impersonateUser might be overwritten by the dynamic passed value if user.config.options.allowDynamicImpersonate ist set to true. 
+
 ```json
 {
     "query": {
@@ -127,13 +131,42 @@ Global script params are set by the application and handed over to the script. T
     "sourceData": {
         "data": {
           "summary": "Short summary",
-          "notes": "Some details here",
+          "notes": "Some details here"
         },
         "customData": {
           "foo": "bar"
         }
     },
-    "id": "INC000000001507"
+    "event": "INC_Modify",
+    "id": "INC000000001507",
+    "user": {
+      "id": "255e90dc-73ab-42d9-b952-60cec716c4e8",
+      "azp": "isms",
+      "scope": "profile issm",
+      "exp": 1648203329,
+      "config": {
+        "options": {
+          "dateFormat": "dd.MM.yyyy HH:mm.ss",
+          "clientLimit": 100000,
+          "impersonateUser": "Bob",
+          "allowDynamicImpersonate": true,
+          "translateSelectionFields": false
+        },
+        "custom_Sample:Enrollments": {
+          "basequery": "1=1",
+          "fields": [
+            "Enrollment ID",
+            "Enrollee Login",
+            "Class ID",
+            "Class Title",
+            "Class Location",
+            "Class Cost",
+            "Department",
+            "Class Start Date & Time"
+          ]
+        }
+      }
+    }
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.55.5",
+  "version": "1.57.0",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {

package/routes/scriptRoutes.js

@@ -4,6 +4,7 @@ const scriptController = require('../controller/scriptController');
 const eventLog = require('../controller/eventLogController');
 const CONSTANTS = require('../util/constants');
 const scriptDefinitionSchema = require('../util/schemas/scriptDefinitionSchema');
+const scriptRenameSchema = require('../util/schemas/scriptRenameSchema');
 const {isAuthorizedAdmin} = require('../util/auth');
 
 const {checkSchema, validationResult} = require('express-validator');
@@ -38,6 +39,7 @@ module.exports = (function() {
         });
     });
 
+    //
     scriptRoutes.get('/:scriptId*', isAuthorizedAdmin, async function (req, res, next) {
         const scriptId = decodeScriptName(req.path);
         eventLog.setEventData(
@@ -70,6 +72,42 @@ module.exports = (function() {
         }
     }
 
+    //
+    scriptRoutes.post('/rename',
+        isAuthorizedAdmin,
+        checkSchema(scriptRenameSchema),
+        async function (req, res, next) {
+
+            //validate schema
+            const errors = validationResult(req);
+
+            try {
+                throwSchemaError(errors);
+            } catch (error) {
+                next(error)
+            }
+
+
+            const scriptIdOld = req.body.scriptNameOld;
+            const scriptIdNew = req.body.scriptNameNew;
+            eventLog.setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_SCRIPT,
+                CONSTANTS.EVENT_ACTION_MODIFY,
+                CONSTANTS.FORM_SCRIPTS,
+                scriptIdOld
+            );
+            try {
+                const script = await scriptController.getGlobalScript(scriptIdOld)
+                const res = await scriptController.renameScript(scriptIdOld, scriptIdNew)
+                const usage = await scriptController.getUsage(scriptIdNew)
+                req.result = {id: scriptIdNew, script, usage};
+            } catch (error) {
+                next(error)
+            }
+            next();
+    });
+
     scriptRoutes.put('/:scriptId*',
         isAuthorizedAdmin,
         checkSchema(scriptDefinitionSchema),

package/util/arquery.js

@@ -362,7 +362,7 @@ function applyMapping(entryData, mapping, constants) {
     return entryData;
 }
 
-function updateEntry(form, id, entryData) {
+function updateEntry(form, id, entryData, clientOptions) {
     let port = 0;
     if (process.env.AR_PORT && process.env.AR_PORT != undefined)
         port = process.env.AR_PORT;
@@ -376,13 +376,16 @@ function updateEntry(form, id, entryData) {
     log.debug('New Entry', myEntry);
     //log.debug('object', Object.keys(entryData));
     return new Promise((resolve, reject) => {
-        const uri = process.env.BASEURL
+        let uri = process.env.BASEURL
             + "/" + process.env.AR_SERVER
             + "/" + form
             + "?port=" + port;
 
+        if (clientOptions && clientOptions.impersonateUser) {
+            uri = uri + "&impersonateUser=" + clientOptions.impersonateUser;
+        }
 
-        var options = {
+        const options = {
             method: 'PUT',
             uri: uri,
             body: myEntry,

package/util/config.js

@@ -583,6 +583,15 @@ function getFields(form) {
     });
 }
 
+async function getFormFieldById(form, fieldId) {
+    const formFields = await getFields(form);
+    if (formFields && Array.isArray(formFields)) {
+        return formFields.find(item => item.fieldId === fieldId)
+    } else {
+        return null
+    }
+}
+
 const ticketConfig = {
     "workorders": {
         "forms": {
@@ -689,5 +698,6 @@ module.exports = {
     ticketConfig,
     getCustomFormMapping,
     setCustomFormMapping,
-    getDesignPackage
+    getDesignPackage,
+    getFormFieldById
 };

package/util/schemas/scriptRenameSchema.js

@@ -0,0 +1,14 @@
+module.exports = {
+    'scriptNameOld': {
+        in: ['body'],
+        exists: {
+            errorMessage: 'Is required'
+        }
+    },
+    'scriptNameNew': {
+        in: ['body'],
+        exists: {
+            errorMessage: 'Is required'
+        }
+    }
+};

package/conf/scripts/INC_CreateWorklog_OnCreate.js

@@ -1,10 +0,0 @@
-log.debug('ID of my new Ticket:', globalScriptParams, clientId)
-
-const worklogData = {
-    summary: 'New SMILEconnect Ticket',
-    text: `Dieses Ticket wurde ueber SMILEconnect (${clientId}) angelegt.`
-}
-const result = await adapter.smileconnect.createTicketWorklog('incidents', globalScriptParams.id, {data: worklogData})
-log.debug(result);
-
-resolve()

package/conf/scripts/attachi.js

@@ -1,2 +0,0 @@
-log.debug('globalScriptParams', globalScriptParams)
-log.debug('file', requestData)

package/conf/scripts/checkGlobalParams.js

@@ -1,3 +0,0 @@
-//requestData.Name = "Horstdidü";
-requestData.globalScriptParams = globalScriptParams
-resolve();

package/conf/scripts/count.js

@@ -1,2 +0,0 @@
-const result = await adapter.remedy.search("MYS:SMILEconnect_QueueData", '1=1', "", {countOnly:true, bypassCache:true});
-reject(result)

package/conf/scripts/folder1/p1.js

@@ -1,11 +0,0 @@
-const allowedCats = [
-    "Request",
-    "Failure"
-];
-
-//Validate opsCat1
-if (requestData.opsCat1 && !allowedCats.find(element => element === requestData.opsCat1)) {
-    reject(`opsCat1 ${requestData.opsCat1} not in allowed values ${allowedCats}`);
-}
-requestData.summary = `Da kam an: ${requestData.summary}`
-resolve();

package/conf/scripts/p2.js

@@ -1,15 +0,0 @@
-const weatherResponse = await fetch('https://api.openweathermap.org/data/2.5/weather?q=Klagenfurt&appid=bab78e38577c73eeb20ca872998a43dd');
-const remedyResult = await adapter.remedy.search("CTM:People", `'Remedy Login ID' = "Allen"`, "Full Name, Remedy Login ID")
-
-if (remedyResult) {
-    requestData.remedyQueryResult = remedyResult;
-}
-
-if (weatherResponse) {
-    requestData.weather = await weatherResponse.json()
-}
-log.debug('testMessage')
-
-requestData.scResults = await adapter.smileconnect.getTicket('incidents', requestData.id, {clientId:'idm'})
-
-resolve();

package/conf/scripts/p3.js

@@ -1 +0,0 @@
-resolve();

package/conf/scripts/p4.js

@@ -1,27 +0,0 @@
-reject(globalScriptParams)
-
-try {
-    const settings = {
-        "createForm":"HPD:IncidentInterface_Create",
-        "entry": {
-            "Description": "incident01_new",
-            "Detailed_Decription": "new ticket creation 02_08_2021",
-            "Impact": "4-Minor/Localized",
-            "Urgency": "4-Low",
-            "Priority": "Low",
-            "Status": "Assigned",
-            "Service_Type": 0,
-            "Reported Source": 1000,
-            "Login_ID": "Allen"
-        }
-    };
-//Create Request
-    const resultCreate = await adapter.remedy.create(settings.createForm, settings.entry);
-} catch (e) {
-    log.debug(`>>> in FCT_TEST: ERROR: ` + e)
-    //console.log(requestData.token)
-    reject (e)
-}
-
-
-resolve();

package/conf/scripts/reject.js

@@ -1 +0,0 @@
-reject(requestData);