@manyos/smileconnect-api 1.69.1 → 1.71.0

package/app.js

@@ -1,6 +1,8 @@
 
 const app = require('express')();
 
+require('dotenv').config();
+
 const path = require('path');
 const log = require('@manyos/logger').setupLog('SMILEconnect', path.basename(__filename));
 
@@ -33,6 +35,7 @@ const ciRelationRoutes = require('./routes/ciRelationRoutes');
 const peopleRelationRoutes = require('./routes/peopleRelationRoutes');
 const appConfigRoutes = require('./routes/appConfigRoutes');
 const scriptRoutes = require('./routes/scriptRoutes');
+const scriptEndpointRoutes = require('./routes/scriptEndpointRoutes');
 const customFormRoutes = require('./routes/customFormRoutes');
 const relatedObjectsController = require('./controller/relatedObjectsController');
 const addRequestId = require('express-request-id')();
@@ -57,8 +60,6 @@ https.globalAgent.maxSockets = maxHTTPSockets;
 
 log.info('Set max HTTP(S) Sockets to', maxHTTPSockets);
 
-require('dotenv').config();
-
 // The signals we want to handle
 // NOTE: although it is tempting, the SIGKILL signal (9) cannot be intercepted and handled
 var signals = {
@@ -345,6 +346,18 @@ app.use('/v1/customForms/:formAlias', async function(req, res, next) {
     next();
 }, customFormRoutes);
 
+app.use('/v1/scriptEndpoints/:endpointName', async function(req, res, next) {
+    const endpointName = req.params.endpointName
+    req.formConfig = {
+        formName: endpointName,
+        endpointName,
+        configName: endpointName,
+    }
+    req.globalScriptParams.formConfig = req.formConfig
+    req.parentEventBase = 'scriptEndoint'
+    next();
+}, scriptEndpointRoutes);
+
 //tickethandling worklogs
 app.use('/v1/:ticketType/:parentId/worklogs', function(req, res, next) {
     log.debug('params1', req.params);
@@ -418,4 +431,4 @@ server.timeout = 6000000;
 //check config on startuo
 config.checkConfig();
 //for testing only
-module.exports = app;
+module.exports = app;

package/conf/clients.json

@@ -462,7 +462,8 @@
         "fields": [],
         "constants": [],
         "scripts": {}
-      }
+      },
+      "scriptEndpoints": {}
     }
   },
   {
@@ -923,7 +924,8 @@
         "fields": [],
         "constants": [],
         "scripts": {}
-      }
+      },
+      "scriptEndpoints": {}
     }
   },
   {
@@ -1383,7 +1385,144 @@
         "fields": [],
         "constants": [],
         "scripts": {}
-      }
+      },
+      "scriptEndpoints": {}
+    }
+  },
+  {
+    "name": "horsti",
+    "config": {
+      "cmdbobject": {
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "basequery": ""
+      },
+      "change": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "changeWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "incident": {
+        "basequery": "1=1",
+        "fields": [
+          "Description"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "incidentWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "person": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "problem": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "problemWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "supportGroup": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "organisation": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrder": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrderWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "task": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "taskWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "flowBuilder": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "changeTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "incidentTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "problemTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrderTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "taskTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "options": {
+        "translateSelectionFields": true
+      },
+      "scriptEndpoints": {}
     }
   },
   {
@@ -1843,7 +1982,8 @@
         "fields": [],
         "constants": [],
         "scripts": {}
-      }
+      },
+      "scriptEndpoints": {}
     }
   },
   {
@@ -1854,7 +1994,8 @@
         "clientLimit": 100000,
         "impersonateUser": "rhannemann",
         "allowDynamicImpersonate": true,
-        "translateSelectionFields": true
+        "translateSelectionFields": true,
+        "openAPIDescription": "Custom text to be included in customer documentation."
       },
       "custom_Sample:Enrollments": {
         "basequery": "1=1",
@@ -2548,142 +2689,15 @@
         ],
         "constants": [],
         "scripts": {}
-      }
-    }
-  },
-  {
-    "name": "horsti",
-    "config": {
-      "cmdbobject": {
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "basequery": ""
-      },
-      "change": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "changeWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "incident": {
-        "basequery": "1=1",
-        "fields": [
-          "Description"
-        ],
-        "constants": [],
-        "scripts": {}
-      },
-      "incidentWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "person": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
       },
-      "problem": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "problemWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "supportGroup": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "organisation": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "workOrder": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "workOrderWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "task": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "taskWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "flowBuilder": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "changeTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "incidentTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "problemTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "workOrderTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "taskTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "options": {
-        "translateSelectionFields": true
+      "scriptEndpoints": {
+        "personData": {
+          "options": {},
+          "scripts": [
+            "script1"
+          ]
+        }
       }
     }
   }
-]
+]

package/conf/mapping.json

@@ -1025,4 +1025,4 @@
       "newName": "assigneeGroup"
     }
   ]
-}
+}

package/controller/cmdbobjectController.js

@@ -41,6 +41,7 @@ function getCmdbObjects(config, category, ciIds, includeString, options, globalS
 }
 
 function getCIRelations(clientConfig, id) {
+    log.error('Search relations with', id);
     const query = `('Source.InstanceId'=\"${id}\" OR 'Destination.InstanceId'=\"${id}\")AND('MarkAsDeleted'=$NULL$ OR 'MarkAsDeleted'=\"No\")`;
     return cmdbCache.get(query, function () {
         return new Promise((resolve, reject) => {
@@ -131,11 +132,35 @@ function queryCMDBObject(clientConfig, query, customFields, customOptions, inclu
         fields = customFields;
     }
 
+    const deleteFields = [];
+
+    const internalFieldsRequired = ['Class Id', 'Instance Id', 'Reconciliation Identity'];
+
+    internalFieldsRequired.forEach(internalRequiredField => {
+        if (!fields.includes(internalRequiredField)) {
+            fields.push(internalRequiredField);
+            deleteFields.push(internalRequiredField);
+        }
+    });
+
+    /*
     if (!fields.includes('Class Id') && includeArray.includes('classAttributes')) {
         fields.push('Class Id');
         deleteClassId = true;
         log.debug('Add classId');
+        deleteFields.push('Class Id');
+    }
+
+    if (!fields.includes('Instance Id')) {
+        fields.push('Instance Id');
+        deleteFields.push('Instance Id');
+    }
+
+    if (!fields.includes('Reconciliation Identity')) {
+        fields.push('Reconciliation Identity');
+        deleteFields.push('Reconciliation Identity');
     }
+     */
 
     const options = {
         ...clientConfig.options, ...customOptions
@@ -158,7 +183,7 @@ function queryCMDBObject(clientConfig, query, customFields, customOptions, inclu
         if (result && result.data && result.data.length) {
             let x = 0;
             for (x=0; x< result.data.length; x++) {
-                const cmdbObject = await handleCMDBObjectResult(result.data[x], mapping, clientConfig, includeArray, globalRelationObjects, deleteClassId, globalScriptParams);
+                const cmdbObject = await handleCMDBObjectResult(result.data[x], mapping, clientConfig, includeArray, globalRelationObjects, deleteFields, globalScriptParams);
                 cmdbObjects.push(cmdbObject);
             }
         }
@@ -170,12 +195,13 @@ function queryCMDBObject(clientConfig, query, customFields, customOptions, inclu
     });
 }
 
-async function handleCMDBObjectResult(cmdbObject, mapping, clientConfig, includeArray, globalRelationObjects, deleteClassId, globalScriptParams) {
-    //get class form
-    const classId = cmdbObject['Class Id'];
-    if (deleteClassId === true) {
-        delete cmdbObject[CMDBOBJECT];
-    }
+async function handleCMDBObjectResult(cmdbObject, mapping, clientConfig, includeArray, globalRelationObjects, deleteFields, globalScriptParams) {
+    const internalReconId = cmdbObject['Reconciliation Identity'];
+    const internalId = cmdbObject['Instance Id'];
+
+    deleteFields.forEach(internalRequiredField => {
+        delete cmdbObject[internalRequiredField];
+    });
 
     const scripts = clientConfig[CMDBOBJECT].scripts.GET;
     //const fields = clientConfig[ticketConfig.requestType].fields
@@ -203,30 +229,30 @@ async function handleCMDBObjectResult(cmdbObject, mapping, clientConfig, include
     cmdbObject.relations = {};
 
     if (includeArray.includes('ciRelations')) {
-        const relations = await getCIRelations(clientConfig, cmdbObject.id);
+        const relations = await getCIRelations(clientConfig, internalId);
         cmdbObject.relations.ciRelations = relations;
     }
     if (includeArray.includes('ticketRelations')) {
-        const relations = await ticketCIRelationController.getCITicketRelations(cmdbObject.id, undefined, log);
+        const relations = await ticketCIRelationController.getCITicketRelations(internalId, undefined, log);
         cmdbObject.relations.ticketRelations = relations;
     }
     if (includeArray.includes('personRelations')) {
-        const relations = await getPeopleRelations(clientConfig, cmdbObject.reconId, 'People');
+        const relations = await getPeopleRelations(clientConfig, internalReconId, 'People');
         cmdbObject.relations.personRelations = relations;
     }
 
     if (includeArray.includes('supportGroupRelations')) {
-        const relations = await getPeopleRelations(clientConfig, cmdbObject.reconId, 'Support Group');
+        const relations = await getPeopleRelations(clientConfig, internalReconId, 'Support Group');
         cmdbObject.relations.supportGroupRelations = relations;
     }
 
     if (includeArray.includes('organisationRelations')) {
-        const relations = await getPeopleRelations(clientConfig, cmdbObject.reconId, 'People Organization');
+        const relations = await getPeopleRelations(clientConfig, internalReconId, 'People Organization');
         cmdbObject.relations.organisationRelations = relations;
     }
 
     if (includeArray.includes('classAttributes')) {
-        const classAttributes = await getCMDBObjectClassAttributes(cmdbObject.id,classId, clientConfig);
+        const classAttributes = await getCMDBObjectClassAttributes(internalId, classId, clientConfig);
         cmdbObject = {
             ...cmdbObject, ...classAttributes
         }
@@ -450,4 +476,4 @@ module.exports = {
     applyMapping,
     updateCmdbObject,
     createCmdbObject
-};
+};

package/controller/relatedObjectsController.js

@@ -9,157 +9,161 @@ const config = require('../util/config');
 const {getEventLog} = require("../util/eventLog");
 
 async function getRelatedObjects(req, res, next) {
-    const log = getEventLog(req.log, path.basename(__filename));
-    log.debug('include Data', req.includeArray);
-    log.debug('include Objects', req.includeObjectsList);
-
-    if (req.result && req.includeObjectsList && req.includeArray) {
-        let result = {};
-        const includedObjects = req.includeObjectsList;
-        const clientConfig = req.user.config;
-
-        if (req.includeArray.includes('persons') && includedObjects.persons) {
-            const persons = [];
-            const personArray = Array.from(includedObjects.persons);
-            let x=0;
-            for (x=0; x < personArray.length; x++) {
-                const personId = personArray[x];
-                log.debug('searchPeople', personId);
-                const result = await orgdata.getPerson(clientConfig, personId);
-                const person = result.data;
-                log.debug('pers', person);
-                if (person) {
-                    persons.push(person);
+    if (req.noInclude === true) {
+        next();
+    } else {
+        const log = getEventLog(req.log, path.basename(__filename));
+        log.debug('include Data', req.includeArray);
+        log.debug('include Objects', req.includeObjectsList);
+
+        if (req.result && req.includeObjectsList && req.includeArray) {
+            let result = {};
+            const includedObjects = req.includeObjectsList;
+            const clientConfig = req.user.config;
+
+            if (req.includeArray.includes('persons') && includedObjects.persons) {
+                const persons = [];
+                const personArray = Array.from(includedObjects.persons);
+                let x=0;
+                for (x=0; x < personArray.length; x++) {
+                    const personId = personArray[x];
+                    log.debug('searchPeople', personId);
+                    const result = await orgdata.getPerson(clientConfig, personId);
+                    const person = result.data;
+                    log.debug('pers', person);
+                    if (person) {
+                        persons.push(person);
+                    }
                 }
+                result.persons = persons;
             }
-            result.persons = persons;
-        }
 
-        if (req.includeArray.includes('organisations') && includedObjects.organisations) {
-            const organisations = [];
-            const organisationArray = Array.from(includedObjects.organisations);
-            let x=0;
-            for (x=0; x < organisationArray.length; x++) {
-                const orgId = organisationArray[x];
-                log.debug('searchOrganisation', orgId);
-                const result = await orgdata.getOrganisation(clientConfig, orgId);
-                const org = result.data;
-                if (org) {
-                    organisations.push(org);
+            if (req.includeArray.includes('organisations') && includedObjects.organisations) {
+                const organisations = [];
+                const organisationArray = Array.from(includedObjects.organisations);
+                let x=0;
+                for (x=0; x < organisationArray.length; x++) {
+                    const orgId = organisationArray[x];
+                    log.debug('searchOrganisation', orgId);
+                    const result = await orgdata.getOrganisation(clientConfig, orgId);
+                    const org = result.data;
+                    if (org) {
+                        organisations.push(org);
+                    }
                 }
+                result.organisations = organisations;
             }
-            result.organisations = organisations;
-        }
 
-        if (req.includeArray.includes('supportGroups') && includedObjects.supportgroups) {
-            const supportGroups = [];
-            const supportGroupArray = Array.from(includedObjects.supportgroups);
-            let x=0;
-            for (x=0; x < supportGroupArray.length; x++) {
-                const groupId = supportGroupArray[x];
-                log.debug('searchSupportGroup', groupId);
-                const result = await orgdata.getSupportGroup(clientConfig, groupId);
-                const supportGroup = result.data;
-                if (supportGroup) {
-                    supportGroups.push(supportGroup);
+            if (req.includeArray.includes('supportGroups') && includedObjects.supportgroups) {
+                const supportGroups = [];
+                const supportGroupArray = Array.from(includedObjects.supportgroups);
+                let x=0;
+                for (x=0; x < supportGroupArray.length; x++) {
+                    const groupId = supportGroupArray[x];
+                    log.debug('searchSupportGroup', groupId);
+                    const result = await orgdata.getSupportGroup(clientConfig, groupId);
+                    const supportGroup = result.data;
+                    if (supportGroup) {
+                        supportGroups.push(supportGroup);
+                    }
                 }
+                result.supportgroups = supportGroups;
             }
-            result.supportgroups = supportGroups;
-        }
 
-        if (req.includeArray.includes('cmdbObjects') && includedObjects.cmdbObjects) {
-            const cmdbObjects = [];
-            let x=0;
-            const cmdbObjectArray = Array.from(includedObjects.cmdbObjects);
-            log.debug(cmdbObjectArray);
-            for (x=0; x < cmdbObjectArray.length; x++) {
-                const ciId = cmdbObjectArray[x];
-                log.debug('searchCMDBObject', ciId);
-                const cmdbObject = await cmdbObjectController.getCmdbObject(clientConfig, ciId, undefined, undefined, req.globalScriptParams);
-                if (cmdbObjects !== null && cmdbObjects !== undefined && cmdbObject && cmdbObject.data) {
-                    cmdbObjects.push(cmdbObject.data);
+            if (req.includeArray.includes('cmdbObjects') && includedObjects.cmdbObjects) {
+                const cmdbObjects = [];
+                let x=0;
+                const cmdbObjectArray = Array.from(includedObjects.cmdbObjects);
+                log.debug(cmdbObjectArray);
+                for (x=0; x < cmdbObjectArray.length; x++) {
+                    const ciId = cmdbObjectArray[x];
+                    log.debug('searchCMDBObject', ciId);
+                    const cmdbObject = await cmdbObjectController.getCmdbObject(clientConfig, ciId, undefined, undefined, req.globalScriptParams);
+                    if (cmdbObjects !== null && cmdbObjects !== undefined && cmdbObject && cmdbObject.data) {
+                        cmdbObjects.push(cmdbObject.data);
+                    }
                 }
+                result.cmdbObjects = cmdbObjects;
             }
-            result.cmdbObjects = cmdbObjects;
-        }
 
-        if (req.includeArray.includes('incidents') && includedObjects.incidents) {
-            const incidents = [];
-            const incidentArray = Array.from(includedObjects.incidents);
-            let x=0;
-            for (x=0; x < incidentArray.length; x++) {
-                const id = incidentArray[x];
-                log.debug('searchIncident', id);
-                const ticketConfig = config.ticketConfig["incidents"];
-                const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams);
-                if (result && result.data) {
-                    incidents.push(result.data);
+            if (req.includeArray.includes('incidents') && includedObjects.incidents) {
+                const incidents = [];
+                const incidentArray = Array.from(includedObjects.incidents);
+                let x=0;
+                for (x=0; x < incidentArray.length; x++) {
+                    const id = incidentArray[x];
+                    log.debug('searchIncident', id);
+                    const ticketConfig = config.ticketConfig["incidents"];
+                    const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams);
+                    if (result && result.data) {
+                        incidents.push(result.data);
+                    }
                 }
+                result.incidents = incidents;
             }
-            result.incidents = incidents;
-        }
 
-        if (req.includeArray.includes('workOrders') && includedObjects.workOrders) {
-            const tickets = [];
-            const ticketIdArray = Array.from(includedObjects.workOrders);
-            let x=0;
-            for (x=0; x < ticketIdArray.length; x++) {
-                const id = ticketIdArray[x];
-                log.debug('searchWorkOrder', id);
-                const ticketConfig = config.ticketConfig["workorders"];
-                const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams)
-                if (result && result.data) {
-                    tickets.push(result.data);
+            if (req.includeArray.includes('workOrders') && includedObjects.workOrders) {
+                const tickets = [];
+                const ticketIdArray = Array.from(includedObjects.workOrders);
+                let x=0;
+                for (x=0; x < ticketIdArray.length; x++) {
+                    const id = ticketIdArray[x];
+                    log.debug('searchWorkOrder', id);
+                    const ticketConfig = config.ticketConfig["workorders"];
+                    const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams)
+                    if (result && result.data) {
+                        tickets.push(result.data);
+                    }
                 }
+                result.workOrders = tickets;
             }
-            result.workOrders = tickets;
-        }
 
-        if (req.includeArray.includes('problems') && includedObjects.problems) {
-            const tickets = [];
-            const ticketIdArray = Array.from(includedObjects.problems);
-            let x=0;
-            for (x=0; x < ticketIdArray.length; x++) {
-                const id = ticketIdArray[x];
-                log.debug('searchProblem', id);
-                const ticketConfig = config.ticketConfig["problems"];
-                const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams)
-                if (result && result.data) {
-                    tickets.push(result.data);
+            if (req.includeArray.includes('problems') && includedObjects.problems) {
+                const tickets = [];
+                const ticketIdArray = Array.from(includedObjects.problems);
+                let x=0;
+                for (x=0; x < ticketIdArray.length; x++) {
+                    const id = ticketIdArray[x];
+                    log.debug('searchProblem', id);
+                    const ticketConfig = config.ticketConfig["problems"];
+                    const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams)
+                    if (result && result.data) {
+                        tickets.push(result.data);
+                    }
                 }
+                result.problems = tickets;
             }
-            result.problems = tickets;
-        }
 
-        if (req.includeArray.includes('changes') && includedObjects.changes) {
-            const tickets = [];
-            const ticketIdArray = Array.from(includedObjects.changes);
-            let x=0;
-            for (x=0; x < ticketIdArray.length; x++) {
-                const id = ticketIdArray[x];
-                log.debug('searchChange', id);
-                const ticketConfig = config.ticketConfig["changes"];
-                const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams)
-                if (result && result.data) {
-                    tickets.push(result.data);
+            if (req.includeArray.includes('changes') && includedObjects.changes) {
+                const tickets = [];
+                const ticketIdArray = Array.from(includedObjects.changes);
+                let x=0;
+                for (x=0; x < ticketIdArray.length; x++) {
+                    const id = ticketIdArray[x];
+                    log.debug('searchChange', id);
+                    const ticketConfig = config.ticketConfig["changes"];
+                    const result = await ticketController.getTicket(ticketConfig, clientConfig, id, undefined, undefined, req.globalScriptParams)
+                    if (result && result.data) {
+                        tickets.push(result.data);
+                    }
                 }
+                result.changes = tickets;
             }
-            result.changes = tickets;
-        }
 
-        log.debug('done');
+            log.debug('done');
 
-        //backward compatibility
-        if (req.includeObjects || (req.body && req.body.getRelations)) {
-            replaceAllKeys(req.result.data);
-        }
-        req.result.included = result || {};
-        next();
-    } else {
-        if (req.result) {
-            req.result.included = {};
+            //backward compatibility
+            if (req.includeObjects || (req.body && req.body.getRelations)) {
+                replaceAllKeys(req.result.data);
+            }
+            req.result.included = result || {};
+            next();
+        } else {
+            if (req.result) {
+                req.result.included = {};
+            }
+            next();
         }
-        next();
     }
 }
 
@@ -223,4 +227,4 @@ async function addLinks(req, res, next) {
 
 module.exports = {
     getRelatedObjects, addLinks
-}
+}

package/controller/scriptController.js

@@ -56,7 +56,7 @@ function recFindByExt(base,ext,files,result) {
     return result
 }
 
-async function executeScriptInternal(scriptId, requestData, params, executedByScript, clientId, globalScriptParams) {
+async function executeScriptInternal(scriptId, requestData, params, executedByScript, clientId, globalScriptParams, customResponse) {
 
     const code = await getGlobalScript(scriptId);
 
@@ -64,14 +64,14 @@ async function executeScriptInternal(scriptId, requestData, params, executedBySc
         throw (`Script ${scriptId} does not exist!`);
     }
 
-    return executeCode(code, requestData, params, null, executedByScript, clientId, scriptId, globalScriptParams);
+    return executeCode(code, requestData, params, null, executedByScript, clientId, scriptId, globalScriptParams, customResponse);
 }
 
-async function executeScript(scriptId, requestData, params, clientId, globalScriptParams) {
-    return executeScriptInternal(scriptId, requestData, params, false, clientId, globalScriptParams)
+async function executeScript(scriptId, requestData, params, clientId, globalScriptParams, customResponse) {
+    return executeScriptInternal(scriptId, requestData, params, false, clientId, globalScriptParams, customResponse)
 }
 
-async function executeCode(code, requestData, params, logStream, executedByScript, clientId, scriptId, globalScriptParams) {
+async function executeCode(code, requestData, params, logStream, executedByScript, clientId, scriptId, globalScriptParams, customResponse) {
     const log = require('@manyos/logger').setupLog('SMILEconnect_Script_' + scriptId);
     //todo should only be added once
     /*if (logStream) {
@@ -81,7 +81,7 @@ async function executeCode(code, requestData, params, logStream, executedByScrip
     //try to set user data for sandbox
 
     async function executeScriptByScript(scriptId, requestData, params) {
-        return executeScriptInternal(scriptId, requestData, params, true, clientId, globalScriptParams)
+        return executeScriptInternal(scriptId, requestData, params, true, clientId, globalScriptParams, customResponse)
     }
 
     const sandbox = {
@@ -98,7 +98,8 @@ async function executeCode(code, requestData, params, logStream, executedByScrip
         globalScriptParams,
         env: process.env,
         fetch:fetch,
-        uid:v4
+        uid:v4,
+        customResponse
     };
 
     sandbox.executedByScript = executedByScript === true;
@@ -255,6 +256,29 @@ async function getUsage(scriptId) {
                 })
             }
         })
+        //log.debug("ScriptEndpoints: ", client.config.scriptEndpoints);
+        if (client.config && client.config.scriptEndpoints) {
+            //log.debug("ScriptEndpoints: ", client.config.scriptEndpoints);
+            Object.keys(client.config.scriptEndpoints).forEach(scriptEndpoint => {
+                const endpointScripts = client.config.scriptEndpoints[scriptEndpoint].scripts;
+                log.debug("EndpointScripts", scriptEndpoint, endpointScripts);
+                if (endpointScripts && Array.isArray(endpointScripts)) {
+                    endpointScripts.forEach(script => {
+                        if (script === scriptId) {
+                            const usage = {
+                                client: client.name,
+                                key: scriptEndpoint,
+                                operation: "POST",
+                                scriptType: "SCRIPTENDPOINT",
+                                script
+                            }
+                            log.debug('script found', usage);
+                            usages.push(usage);
+                        }
+                    });
+                }
+            });
+        }
     });
     return usages;
 }
@@ -288,13 +312,16 @@ async function getGlobalScripts() {
 }
 
 async function runScripts(scripts, data, clientId, globalScriptParams) {
+    let customResponse = {};
     try {
         for (let x = 0; x < scripts.length; x++) {
-            await executeScript(scripts[x], data, undefined, clientId, globalScriptParams);
+            await executeScript(scripts[x], data, undefined, clientId, globalScriptParams, customResponse);
         }
     } catch (error) {
         throw error;
     }
+    log.debug("customResponse:", customResponse);
+    return customResponse;
 }
 
 module.exports = {

package/controller/scriptEndpointController.js

@@ -0,0 +1,25 @@
+require('dotenv').config();
+const path = require('path');
+const log = require('@manyos/logger').setupLog('SMILEconnect', path.basename(__filename));
+const config = require('../util/config');
+const CONSTANTS = require('../util/constants');
+const scriptController = require('./scriptController');
+
+async function executeScripts(clientConfig, endpointName, data, globalScriptParams) {
+    if (!clientConfig.scriptEndpoints || !clientConfig.scriptEndpoints[endpointName]) {
+        throw new Error("No Endpoint config found for endpoint " + endpointName);
+    }
+    const scripts = clientConfig.scriptEndpoints[endpointName].scripts;
+    if (!scripts || !Array.isArray(scripts)) {
+        throw new Error("No Scripts defined for endpoint " + endpointName);
+    } else if (scripts.length === 0) {
+        return {message: "No scripts defined. Nothing to do."}
+    } else {
+        log.debug(`Run scripts for endpoint ${exports} -> ${scripts}`);
+        return await scriptController.runScripts(scripts, data, clientConfig.clientId, globalScriptParams);
+    }
+}
+
+module.exports = {
+    executeScripts
+};

package/docs/_sidebar.md

@@ -12,6 +12,7 @@
   - [Client Configuration](configuration/clients)
   - [Events](configuration/events)
   - [Webhooks](configuration/webhooks)
+  - [ScriptEndpoints](configuration/scriptEndpoints)
 
 - Data manipulation
 

package/docs/configuration/scriptEndpoints.md

@@ -0,0 +1,64 @@
+# ScriptEnpoints
+
+Script Endpoints in SMILEconnect enable you to define custom API endpoints that execute JavaScript logic directly upon invocation. This allows you to automate complex processes, integrate external systems, and respond with dynamic results — all without external middleware.
+
+They are accessible at the url: */v1/scriptEndpoints/endpointName* via POST Action.
+
+Sample Script:
+
+```javascript
+// Access incoming request data
+let userInput = requestData.name;
+
+// Process data (example logic)
+let greeting = "Hello, " + userInput + "!";
+
+// Define custom response
+customResponse.data = {
+    "message": greeting,
+    "timestamp": new Date().toISOString()
+}
+customResponse.code = 200;
+```
+
+The incoming request payload is automatically available via the variable requestData.
+
+Data can be used for validation, processing, or triggering actions within BMC ITSM.
+
+Use the global customResponse object to return results:
+
+* customResponse.data -> JSON object returned in the HTTP response body.
+* customResponse.code -> HTTP status code to return (e.g., 200, 400, 500). Defaults to 200.
+
+Advanced Sample Script:
+
+```javascript
+//Advanced script example
+
+const persons = await adapter.remedy.search('CTM:People', `1=1`, "Full Name, Organization", {limit:1000});
+const organisations = await adapter.remedy.search('CTM:People Organization', `1=1`, "Full Name, Organization", {limit:1000});
+
+function lookupOrgId(orgName) {
+    for (let y = 0; y < organisations.data.length; y++) {
+        const organisation = organisations.data[y];
+        if (organisation['Organization'] === orgName) {
+            return organisation['People Organization ID'];
+        }
+    }
+    return "not found";
+}
+
+//loop als Persons and lookup org id
+for (let x = 0; x < persons.data.length; x++) {
+    const person = persons.data[x];
+    person.orgId = lookupOrgId(person.Organization);
+}
+
+customResponse.data = {
+    "dataReceived": requestData,
+    organisations: organisations.data,
+    "persons": persons.data
+}
+
+customResponse.code = 203
+```

package/docs/releases.md

@@ -1,6 +1,13 @@
 # Release Notes
 
 ## API
+### 1.71.0 - 25.03.25
+Add Script Endpoints
+Add openAPIDescription attribute to client config
+
+### 1.70.0 - 07.01.25
+Fixed mapping in CI Classes for Attributes Instance ID and Reconciliation ID no longer required.
+
 ### 1.69.0 - 23.07.24
 Remove unnecessary writes during config checks on startup.
 
@@ -210,6 +217,9 @@ e.g.
 */v1/incidents?impersonateUser=abc123
 
 ## Event Manager
+### 1.37.0 - 15.01.25
+Add instanceid to eventdata.
+
 ### 1.35.0 - 29.04.24
 Add attachment support for outbound mappings
 
@@ -268,6 +278,11 @@ 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.13.4 - 20.02.25
+Fixed: Custom mapping upload in Code viewer is not working
+
+### 1.13.1 - 30.01.25
+Feat: Update modules & improvments to monitor config.
 
 ### 1.11.0 - 05.04.23
 Feat: Add REACT_APP_CLIENT_SECRET Parameter to allow confidential SSO clients

package/package.json

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

package/routes/appConfigRoutes.js

@@ -383,6 +383,30 @@ module.exports = (function() {
             }
         });
 
+    routes.get('/clients/:id/scriptUsage', isAuthorizedAdmin,
+        function (req, res, next) {
+            const id = req.params.id;
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_QUERY,
+                CONSTANTS.FORM_APC_CLIENTS,
+                id
+            );
+            try {
+                const clientScripts = config.getClientScripts(id);
+                if (clientScripts == null || clientScripts == undefined) {
+                    req.responseStatus = 404;
+                }
+                req.result = {
+                    "data": clientScripts
+                };
+                next();
+            } catch (error) {
+                next(error);
+            }
+        });
+
     /*routes.get('/clients/:id/designPackage',
         async function (req, res, next) {
             const id = req.params.id;
@@ -507,4 +531,4 @@ module.exports = (function() {
         });
 
     return routes;
-})();
+})();

package/routes/scriptEndpointRoutes.js

@@ -0,0 +1,57 @@
+const path = require('path');
+const log = require('@manyos/logger').setupLog('SMILEconnect', path.basename(__filename));
+const {body, validationResult, oneOf} = require('express-validator/check');
+const scriptEnpointController = require('../controller/scriptEndpointController');
+const eventLog = require('../controller/eventLogController');
+const CONSTANTS = require('../util/constants');
+
+module.exports = (function() {
+    const routes = require('express').Router();
+
+    const errorFormatter = ({location, msg, param, value, nestedErrors}) => {
+        // Build your resulting errors however you want! String, object, whatever - it works!
+        return `${location}[${param}]: ${msg}`;
+    };
+
+    routes.post('/', function (req, res, next) {
+        const endpointName = req.formConfig.endpointName;
+        log.debug('Start endpoint WF', endpointName)
+        //todo Errorhandling prüfen. Wenn parameter fehlen, wird nicht zurückgegeben welche
+        const origData = JSON.parse(JSON.stringify(req.body));
+        const includeString = req.query.include;
+        eventLog.setEventData(
+            req,
+            req.parentEventBase,
+            CONSTANTS.EVENT_ACTION_CREATE,
+            req.formConfig.endpointName,
+            null,
+            origData
+        );
+        const errors = validationResult(req).formatWith(errorFormatter);
+        if (!errors.isEmpty()) {
+            req.errorStatus = 422;
+            next(errors.array());
+        } else if (!req.user.config || !req.user.config.scriptEndpoints || !req.user.config.scriptEndpoints[endpointName]) {
+            req.errorStatus = 404;
+            next("Endpoint not defined");
+        } else {
+            scriptEnpointController.executeScripts(req.user.config, endpointName, req.body, req.globalScriptParams).then(async function (scriptResult) {
+                if (scriptResult) {
+                    if (scriptResult.data) {
+                        req.result = scriptResult.data;
+                    }
+                    if (scriptResult.code) {
+                        req.responseStatus = scriptResult.code;
+                    }
+                }
+                req.noInclude = true;
+                log.debug("Scripts run successful", scriptResult);
+                next();
+            }).catch(function (reason) {
+                next(reason);
+            });
+        }
+    });
+
+    return routes;
+})();

package/util/config.js

@@ -270,11 +270,11 @@ function checkClientConfig(client) {
     const clientConfigKeys = Object.keys(clientConfig);
     //delete too many
     clientConfigKeys.forEach(key=>{
-        if (!clientKeys.includes(key) && !(key === 'options') && !(key.startsWith('custom_'))) {
+        if (!clientKeys.includes(key) && !(key === 'options') && !(key.startsWith('custom_')) && !(key === 'scriptEndpoints')) {
             log.warn('delete from clientconfig', key);
             delete clientConfig[key];
             updateRequired = true;
-        } else if (clientKeys.includes(key) && !(key === 'options')) {
+        } else if (clientKeys.includes(key) && !(key === 'options') && !(key === 'scriptEndpoints') ) {
             if (!(typeof clientConfig[key].basequery === 'string')) {
                 clientConfig[key].basequery = '';
                 log.warn('add basequery', key);
@@ -316,6 +316,11 @@ function checkClientConfig(client) {
         updateRequired = true;
     }
 
+    if (!clientConfig.scriptEndpoints) {
+        clientConfig.scriptEndpoints = {};
+        updateRequired = true;
+    }
+
     if (clientConfig.options.translateSelectionFields === undefined) {
         clientConfig.options.translateSelectionFields = true;
         updateRequired = true;
@@ -372,6 +377,11 @@ async function getDesignPackage(clientId) {
     }
 
     const clientConfig = await getClientConfig(clientId)
+
+    if (clientConfig && clientConfig.options && clientConfig.options.openAPIDescription) {
+        info.description = clientConfig.options.openAPIDescription;
+    }
+
     const schemas = {}
     let paths = {}
 
@@ -449,6 +459,27 @@ async function getDesignPackage(clientId) {
         }
     }
 
+    //generate docs for scriptEndpoints
+    if (clientConfig && clientConfig.scriptEndpoints) {
+        //const customFormMappings = await getCustomFormMapping()
+        const scriptKeys = Object.keys(clientConfig.scriptEndpoints)
+        for (let x=0; x < scriptKeys.length; x++) {
+            const key = scriptKeys[x]
+            log.debug('key', key)
+            //schemas[key] = await getObjectSchema(clientObjectConfig.fields, customFormMappings[key].mapping, formName)
+            const pathDef = {}
+            pathDef[`/v1/scriptEndpoints/${key}`] = {};
+            pathDef[`/v1/scriptEndpoints/${key}`].post = {
+                tags: [key],
+                summary: `Run scripts associated with this endpoint`,
+                description: "Run scripts associated that are associated with this endpoint. The return Schema is defined in the scripts.",
+                parameters: [],
+                responses: await getApiResponse("scriptEndpoint_" + key, true)
+            }
+            schemas["scriptEndpoint_" + key] = {};
+            paths = {...paths, ... pathDef}
+        }
+    }
 
     //generate docs for cmdb
     const cmdbMapping = getDeprecatedMappingAsCustom('cmdbobject')
@@ -759,6 +790,63 @@ const ticketConfig = {
     }
 };
 
+function getClientScripts(clientId) {
+    const usages = [];
+    const client = getClient(clientId);
+    log.debug("Search scripts for " + clientId);
+    //check each client entry for scripts
+    Object.keys(client.config).forEach(clientKey => {
+        const clientScripts = client.config[clientKey].scripts;
+        //check all script operations
+        if (clientScripts) {
+            Object.keys(clientScripts).forEach(operation => {
+                //log.debug ('ops', operation);
+                const opsScripts = clientScripts[operation];
+                Object.keys(opsScripts).forEach(scriptType => {
+                    const opsTypeScripts = opsScripts[scriptType]
+                    //log.debug ('opsTypeSc', opsTypeScripts);
+                    if (opsTypeScripts && Array.isArray(opsTypeScripts)) {
+                        opsTypeScripts.forEach(script => {
+                            //log.debug (scriptType, scriptId, script);
+                            const usage = {
+                                client: client.name,
+                                key: clientKey,
+                                operation,
+                                scriptType,
+                                script
+                            }
+                            log.debug ('script found', usage);
+                            usages.push(usage);
+                        });
+                    }
+                })
+            });
+        }
+    });
+    //log.debug("ScriptEndpoints: ", client.config.scriptEndpoints);
+    if (client && client.config && client.config.scriptEndpoints) {
+        //log.debug("ScriptEndpoints: ", client.config.scriptEndpoints);
+        Object.keys(client.config.scriptEndpoints).forEach(scriptEndpoint => {
+            const endpointScripts = client.config.scriptEndpoints[scriptEndpoint].scripts;
+            log.debug("EndpointScripts", scriptEndpoint, endpointScripts);
+            if (endpointScripts && Array.isArray(endpointScripts)) {
+                endpointScripts.forEach(script => {
+                    const usage = {
+                        client: client.name,
+                        key: scriptEndpoint,
+                        operation: "POST",
+                        scriptType: "SCRIPTENDPOINT",
+                        script
+                    }
+                    log.debug ('script found', usage);
+                    usages.push(usage);
+                });
+            }
+        });
+    }
+    return usages;
+}
+
 module.exports = {
     getClientConfig,
     getMapping,
@@ -776,5 +864,6 @@ module.exports = {
     getCustomFormMapping,
     setCustomFormMapping,
     getDesignPackage,
-    getFormFieldById
-};
+    getFormFieldById,
+    getClientScripts
+};

package/util/responsehandler.js

@@ -81,7 +81,7 @@ function eventQueueHandler(req, res, next) {
             if (!eventData.jsonData) {
                 eventData.jsonData = {};
             }
-            eventData.jsonData['req'] = {
+            eventData.jsonDas= {
                 headers: req.headers,
                 body: req.body
             }
@@ -127,4 +127,4 @@ function throwSchemaError(errors) {
 
 module.exports = {
     logErrors, errorHandler, eventQueueHandler, logRequest, throwSchemaError
-};
+};