@manyos/smileconnect-api 1.38.1 → 1.39.1

package/docs/configuration/scripts.md

@@ -0,0 +1,207 @@
+---
+layout: page
+title: Scripts
+subtitle: How-to modify data
+use-site-title: true
+bigimg: /img/gb-isapi.jpg
+---
+
+# Introduction
+
+Scripts are used to modify requests, gather data or to drive external actions.
+
+Scripts can call adapter to interact with other systems and they can be reused.
+
+#### **`workOrder_lookupSericeNameByReconId`**
+```javascript
+//lookup service ci name if reconId is given 
+
+if (requestData['ReconciliationIdentity']) { 
+    const remedyResult = await adapter.remedy.search("BMC.CORE:BMC_BusinessService", `'ReconciliationIdentity' = "${requestData['ReconciliationIdentity']}" AND 'DatasetId' = "BMC.ASSET"`, "Name") 
+
+    if (remedyResult && remedyResult.data && remedyResult.data[0]) { 
+        const data = remedyResult.data[0]; 
+        requestData['CI Name'] = data['Name']; 
+    } 
+
+} 
+resolve() 
+```
+
+The above script will lookup the service name for a given reconciliation id.
+
+# Accessible Variables
+
+Within scripts the following variables are available.
+
+## params
+
+The parameter params can be defined in a script and used when another script is called. This is useful to reuse scripts.
+
+e.g.
+```javascript
+const returnValue = await script('ars101', {}, params);
+```
+
+## globalScriptParams
+
+Global script params are set by the application and handed over to the script. They include the following parameter:
+
+* query: This property is an object containing a property for each query string parameter in the route.
+* id: the id of the ticket. Only set in GET & PUT actions
+* id2: the id of child ticket. e.g. Tasks or Worklogs. Only set in GET & PUT actions
+* id2: the id of child worklogs. e.g. Tasksworklog. Only set in GET & PUT actions
+* classId: the classId of cmdbobjects. Only set in POST & PUT actions
+
+```json
+{
+    "query": {
+        "includeObjects": "true",
+        "limit": "3",
+        "include": "supportGroupRelations,persons"
+    },
+    "id": "INC000000001507"
+}
+```
+
+## requestData
+
+This parameter holds the complete request data. 
+
+## clientId
+
+This id of the client who executes the script.
+
+## executedByScript
+
+This parameter will be set to *true* if the script is executed by another script.
+
+## env
+
+This parameter allows access to the environment variables.
+
+## log
+
+Can be used to write data to the applications log stream.
+
+The following log level can be used:
+
+* trace
+* debug
+* info
+* warn
+* error
+* fatal
+
+e.g.
+
+```javascript
+ log.debug('log text', variable);
+ log.info('log text', variable);
+ log.error('error text', variable);
+```
+
+## script
+
+Can be used to execute a script within a script. 
+
+script(scriptId, requestData, params, scope)
+
+e.g.
+```javascript
+const returnValue = await script('ars101', {}, params);
+```
+
+For more information see subscripts.
+
+## fetch
+
+Allows access to external webservices via the package *node-fetch*
+
+See https://www.npmjs.com/package/node-fetch for details.
+
+## adapter
+
+Allows to make adapter calls. [See details](../configuration/adapter.md)
+
+# Returning values
+
+Values can be returned with the fuction *resolve()*
+
+e.g.
+
+```javascript
+const values = [
+    "value1",
+    "value2",
+    "value3"
+]
+resolve (values)
+```
+
+# Error handling
+
+Values can be returned with the fuction *reject()*
+
+e.g.
+
+```javascript
+if (!params.form) {
+    reject("The parameter form is required")
+}
+```
+
+# Async calls
+
+Within scripts *await* can be used to make async calls.
+
+```javascript
+ const returnValue = await script('ars101', {}, params);
+```
+
+# Samples
+
+## Simple Static Menu
+
+This script creates the data for a simple static menu in a Selection (Drop Down) field.
+
+```javascript
+const data = [
+    {
+        "value": "Menu Item 1",
+        "label": "internalVal1"
+    },
+    {
+        "value": "Menu Item 2",
+        "label": "internalVal2"
+    },
+    {
+        "value": "Menu Item 3",
+        "label": "internalVal3"
+    },
+    {
+        "value": "Menu Item 4",
+        "label": "internalVal4"
+    }
+];
+resolve(data);
+
+```
+
+## Simple Query Menu
+
+This script calls another script query data for a menu.
+
+```javascript
+//prepare params
+const params = {
+    "query": "'Remedy Login ID'=\"astern\"",
+    "form": "CTM:People",
+    "labelField": "Full Name",
+    "valueField": "Remedy Login ID"
+};
+//execute script
+const personResult = await script('remedy/ars101', {}, params, "global");
+//return parameter
+resolve(personResult);
+```

package/package.json

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

package/routes/cmdbObjectRoutes.js

@@ -59,7 +59,7 @@ module.exports = (function () {
             if (!valResult.isEmpty()) {
                 next(valResult.array());
             } else {
-                cmdbobjects.searchCmdbObject(req.user.config, req.body.searchString, req.body.fields, options, includeString).then(function (result) {
+                cmdbobjects.searchCmdbObject(req.user.config, req.body.searchString, req.body.fields, options, includeString, req.globalScriptParams).then(function (result) {
                     log.debug('result', result);
                     req.includeObjectsList = result.included;
                     req.result = {data:result.data || []};
@@ -94,7 +94,7 @@ module.exports = (function () {
             options.offset = Number.parseInt(offset);
         }
 
-        cmdbobjects.getCmdbObjects(req.user.config, category, ciIds, includeString, options).then(function (result) {
+        cmdbobjects.getCmdbObjects(req.user.config, category, ciIds, includeString, options, req.globalScriptParams).then(function (result) {
             log.debug('result', result);
             req.includeObjectsList = result.included;
             req.result = {data:result.data || []};
@@ -107,6 +107,7 @@ module.exports = (function () {
     cmdbObjectRoutes.get('/:id', passport.authenticate('jwt', {session: false}),
         function (req, res, next) {
             const id = req.params.id;
+            req.globalScriptParams.id = id
             const includeString = req.query.include;
             eventLog.setEventData(
                 req,
@@ -115,7 +116,7 @@ module.exports = (function () {
                 CONSTANTS.FORM_ASSET,
                 id
             );
-            cmdbobjects.getCmdbObject(req.user.config, id, includeString).then(function (result) {
+            cmdbobjects.getCmdbObject(req.user.config, id, includeString, undefined, req.globalScriptParams).then(function (result) {
                 log.debug('result', result);
                 req.includeObjectsList = result.included;
                 req.result = {data:result.data || {}};
@@ -165,6 +166,8 @@ module.exports = (function () {
         const id = req.params.id;
         const classId = req.body.classId;
         const includeString = req.query.include;
+        req.globalScriptParams.id = id
+        req.globalScriptParams.classId = classId
         eventLog.setEventData(
             req,
             CONSTANTS.EVENT_BASE_AST,
@@ -183,8 +186,8 @@ module.exports = (function () {
                 const ci = req.body.data;
                 const hasAccess = await cmdbobjects.hasAccess(req.user.config, id);
                 if (hasAccess) {
-                    const result = await cmdbobjects.updateCmdbObject(req.ticketConfig, req.user.config, id, req.body.data, classId);
-                    const ci = await cmdbobjects.getCmdbObject(req.user.config, id, includeString);
+                    const result = await cmdbobjects.updateCmdbObject(req.ticketConfig, req.user.config, id, req.body.data, classId, req.globalScriptParams);
+                    const ci = await cmdbobjects.getCmdbObject(req.user.config, id, includeString, undefined, req.globalScriptParams);
                     req.result = ci;
                     next();
                 } else {
@@ -200,6 +203,7 @@ module.exports = (function () {
     cmdbObjectRoutes.post('/', checkSchema(fieldMappingSchemas.CMDBCreateDataSchema), async function (req, res, next) {
         const classId = req.body.classId;
         const includeString = req.query.include;
+        req.globalScriptParams.classId = classId
         eventLog.setEventData(
             req,
             CONSTANTS.EVENT_BASE_AST,
@@ -214,8 +218,9 @@ module.exports = (function () {
             //const clientConfig = config.getClientConfig(clientId);
             const result = [];
             try {
-                const ciInstanceId = await cmdbobjects.createCmdbObject(req.ticketConfig, req.user.config, classId, req.body.data);
-                const ci = await cmdbobjects.getCmdbObject(req.user.config, ciInstanceId, includeString);
+                const ciInstanceId = await cmdbobjects.createCmdbObject(req.ticketConfig, req.user.config, classId, req.body.data, req.globalScriptParams);
+                req.globalScriptParams.id = ciInstanceId
+                const ci = await cmdbobjects.getCmdbObject(req.user.config, ciInstanceId, includeString, undefined, req.globalScriptParams);
                 req.result = ci;
                 next();
             } catch (e) {

package/routes/customFormRoutes.js

@@ -33,7 +33,7 @@ module.exports = (function() {
             options.offset = Number.parseInt(offset);
         }
 
-        customFormController.getRecords(req.formConfig, req.user.config, includeString, options).then(function (result) {
+        customFormController.getRecords(req.formConfig, req.user.config, includeString, options, globalScriptParams).then(function (result) {
             log.debug('result', result);
             req.result = {data:result.data};
             next();
@@ -59,7 +59,7 @@ module.exports = (function() {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            customFormController.createRecord(req.formConfig, req.user.config, req.body.data).then(async function (createResult) {
+            customFormController.createRecord(req.formConfig, req.user.config, req.body.data, globalScriptParams).then(async function (createResult) {
                 const recordId = createResult;
                 eventLog.setTicketId(req, recordId);
                 req.eventData.ticketNumber = recordId;
@@ -104,7 +104,7 @@ module.exports = (function() {
         if (!valResult.isEmpty()) {
             next(valResult.array());
         } else {
-            customFormController.searchRecords(req.formConfig, req.user.config, req.body.searchString, req.body.fields, options, includeString).then(function (result) {
+            customFormController.searchRecords(req.formConfig, req.user.config, req.body.searchString, req.body.fields, options, includeString, globalScriptParams).then(function (result) {
                 log.debug('result', result);
                 req.result = {data:result.data};
                 next();
@@ -130,7 +130,8 @@ module.exports = (function() {
     });
 
     function getRecord(req, res, next, clientConfig, id, mapping, includeString) {
-        customFormController.getRecord(req.formConfig, clientConfig, id, mapping, includeString).then(function (result) {
+        req.globalScriptParams.id = id
+        customFormController.getRecord(req.formConfig, clientConfig, id, mapping, includeString, globalScriptParams).then(function (result) {
             log.debug('result', result);
             req.includeObjectsList = result.included;
             req.result = {data:result.data || {}};
@@ -145,6 +146,7 @@ module.exports = (function() {
 
     routes.put('/:id', function (req, res, next) {
         const id = req.params.id;
+        req.globalScriptParams.id = id
         const origData = JSON.parse(JSON.stringify(req.body));
         const includeString = req.query.include;
         eventLog.setEventData(
@@ -160,7 +162,7 @@ module.exports = (function() {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            customFormController.updateRecord(req.formConfig, req.user.config, id, req.body.data)
+            customFormController.updateRecord(req.formConfig, req.user.config, id, req.body.data, globalScriptParams)
                 .then(async function (updateResult) {
                     getRecord(req, res, next, req.user.config, id, null, includeString);
                 }).catch(function (reason) {

package/routes/taskRoutes.js

@@ -24,7 +24,7 @@ module.exports = (function () {
             id
         );
 
-        const result = await task.getTasksByRootRequest(req.user.config, id, req.parentForm);
+        const result = await task.getTasksByRootRequest(req.user.config, id, req.parentForm, req.globalScriptParams);
         req.includeObjectsList = result.included;
         req.result = {data:result.data || {}};
 
@@ -50,7 +50,7 @@ module.exports = (function () {
             if (req.query.createTaskFlow && req.query.createTaskFlow.toLowerCase() === 'false') {
                 createTaskFlow = false;
             }
-            task.createTask(req.user.config, req.parentForm, req.parentId, req.body.data, createTaskFlow).then(async function (createResult) {
+            task.createTask(req.user.config, req.parentForm, req.parentId, req.body.data, createTaskFlow, req.globalScriptParams).then(async function (createResult) {
                 log.debug('createResult', createResult);
                 const resultKeys = Object.keys(createResult);
                 let taskResult = {};
@@ -59,7 +59,7 @@ module.exports = (function () {
                     let x=0;
                     for (x=0; x<resultKeys.length; x++) {
                         const taskId = createResult[resultKeys[x]];
-                        const result = await task.getTaskByRootRequest(req.user.config, req.parentId, taskId);
+                        const result = await task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams);
                         taskResult.push(result.data);
                     }
                     //todo fix included objects
@@ -68,7 +68,7 @@ module.exports = (function () {
                     next();
                 } else {
                     const taskId = createResult['0'];
-                    task.getTaskByRootRequest(req.user.config, req.parentId, taskId).then(function (result) {
+                    task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams).then(function (result) {
                         req.includeObjectsList = result.included;
                         req.result = {data:result.data || {}};
                         next();
@@ -85,6 +85,8 @@ module.exports = (function () {
     taskRoutes.get('/:taskId', async function (req, res, next) {
         const parentId = req.parentId;
         const taskId = req.params.taskId;
+        req.globalScriptParams.id = parentId
+        req.globalScriptParams.id2 = taskId
         eventLog.setEventData(
             req,
             req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
@@ -95,7 +97,7 @@ module.exports = (function () {
             taskId
         );
 
-        const result = await task.getTaskByRootRequest(req.user.config, parentId, taskId);
+        const result = await task.getTaskByRootRequest(req.user.config, parentId, taskId, req.globalScriptParams);
         req.includeObjectsList = result.included;
         req.result = {data:result.data || {}};
         next();
@@ -103,6 +105,8 @@ module.exports = (function () {
 
     taskRoutes.put('/:taskId', function (req, res, next) {
         const taskId = req.params.taskId;
+        req.globalScriptParams.id = req.parentId;
+        req.globalScriptParams.id2 = taskId
         const origData = JSON.parse(JSON.stringify(req.body));
         eventLog.setEventData(
             req,
@@ -118,8 +122,8 @@ module.exports = (function () {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            task.updateTask(req.user.config, taskId, req.body.data).then(function (updateResult) {
-                task.getTaskByRootRequest(req.user.config, req.parentId, taskId).then(function (result) {
+            task.updateTask(req.user.config, taskId, req.body.data, req.globalScriptParams).then(function (updateResult) {
+                task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams).then(function (result) {
                     req.includeObjectsList = result.included;
                     req.result = {data:result.data || {}};
                     next();
@@ -134,6 +138,8 @@ module.exports = (function () {
 
     taskRoutes.get('/:taskId/worklogs', async function (req, res, next) {
         const taskId = req.params.taskId;
+        req.globalScriptParams.id = req.parentId;
+        req.globalScriptParams.id2 = taskId
         eventLog.setEventData(
             req,
             req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
@@ -144,7 +150,7 @@ module.exports = (function () {
             taskId
         );
 
-        const result = await task.getTaskWorklogs(req.user.config, taskId);
+        const result = await task.getTaskWorklogs(req.user.config, taskId, req.globalScriptParams);
         req.includeObjectsList = result.included;
         req.result = {data:result.data || {}};
         next();
@@ -158,6 +164,8 @@ module.exports = (function () {
 
         const origData = JSON.parse(JSON.stringify(req.body));
         const taskId = req.params.taskId;
+        req.globalScriptParams.id = req.parentId;
+        req.globalScriptParams.id2 = taskId
         eventLog.setEventData(
             req,
             req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
@@ -173,10 +181,10 @@ module.exports = (function () {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            task.createWorklog(req.user.config, taskId, req.body.data.summary, req.body.data.text)
+            task.createWorklog(req.user.config, taskId, req.body.data.summary, req.body.data.text, undefined, req.globalScriptParams)
                 .then(createResult => {
                     const worklogId = createResult['0'];
-                    task.getTaskWorklog(req.user.config, taskId, worklogId).then(result => {
+                    task.getTaskWorklog(req.user.config, taskId, worklogId, req.globalScriptParams).then(result => {
                         const urls = {
                             "attachmentUrl" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/1`,
                             "attachmentUrl2" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/2`,
@@ -199,6 +207,9 @@ module.exports = (function () {
     taskRoutes.get('/:taskId/worklogs/:worklogId', async function (req, res, next) {
         const taskId = req.params.taskId;
         const worklogId = req.params.worklogId;
+        req.globalScriptParams.id = req.parentId;
+        req.globalScriptParams.id2 = taskId
+        req.globalScriptParams.id3 = worklogId
         eventLog.setEventData(
             req,
             req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
@@ -210,7 +221,7 @@ module.exports = (function () {
             worklogId
         );
 
-        const result = await task.getTaskWorklog(req.user.config, taskId, worklogId);
+        const result = await task.getTaskWorklog(req.user.config, taskId, worklogId, req.globalScriptParams);
         const urls = {
             "attachmentUrl" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/1`,
             "attachmentUrl2" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/2`,

package/routes/ticketRoutes.js

@@ -35,7 +35,7 @@ module.exports = (function() {
             options.offset = Number.parseInt(offset);
         }
 
-        ticketController.getTickets(req.ticketConfig, req.user.config, includeString, options).then(function (result) {
+        ticketController.getTickets(req.ticketConfig, req.user.config, includeString, options, req.globalScriptParams).then(function (result) {
             log.debug('result', result);
             req.includeObjectsList = result.included;
             req.result = {data:result.data};
@@ -63,7 +63,7 @@ module.exports = (function() {
             next(errors.array());
         } else {
             const relations = req.body.data.relations;
-            ticketController.createTicket(req.ticketConfig, req.user.config, req.body.data).then(async function (createResult) {
+            ticketController.createTicket(req.ticketConfig, req.user.config, req.body.data, req.globalScriptParams).then(async function (createResult) {
                 const ticketId = createResult.data[0][req.ticketConfig.ticketIdField];
                 eventLog.setTicketId(req, ticketId);
                 req.eventData.ticketNumber = ticketId;
@@ -109,7 +109,7 @@ module.exports = (function() {
         if (!valResult.isEmpty()) {
             next(valResult.array());
         } else {
-            ticketController.searchTicket(req.ticketConfig, req.user.config, req.body.searchString, req.body.fields, options, includeString).then(function (result) {
+            ticketController.searchTicket(req.ticketConfig, req.user.config, req.body.searchString, req.body.fields, options, includeString, req.globalScriptParams).then(function (result) {
                 log.debug('result', result);
                 req.includeObjectsList = result.included;
                 req.result = {data:result.data};
@@ -136,7 +136,8 @@ module.exports = (function() {
     });
 
     function getTicket(req, res, next, clientConfig, id, mapping, includeString) {
-        ticketController.getTicket(req.ticketConfig, clientConfig, id, mapping, includeString).then(function (result) {
+        req.globalScriptParams.id = id
+        ticketController.getTicket(req.ticketConfig, clientConfig, id, mapping, includeString, req.globalScriptParams).then(function (result) {
             log.debug('result', result);
             req.includeObjectsList = result.included;
             req.result = {data:result.data || {}};
@@ -151,6 +152,7 @@ module.exports = (function() {
 
     ticketRoutes.put('/:id', function (req, res, next) {
         const id = req.params.id;
+        req.globalScriptParams.id = id
         const origData = JSON.parse(JSON.stringify(req.body));
         const includeString = req.query.include;
         eventLog.setEventData(
@@ -167,7 +169,7 @@ module.exports = (function() {
             next(errors.array());
         } else {
             const relations = req.body.data.relations;
-            ticketController.updateTicket(req.ticketConfig, req.user.config, id, req.body.data)
+            ticketController.updateTicket(req.ticketConfig, req.user.config, id, req.body.data, req.globalScriptParams)
                 .then(async function (updateResult) {
                     await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, id, relations);
                     getTicket(req, res, next, req.user.config, id, null, includeString);

package/routes/ticketWorkLogRoutes.js

@@ -23,7 +23,7 @@ module.exports = (function() {
                 id
             );
 
-            ticketWorkLogController.getWorklogs(req.ticketConfig, req.user.config, id).then(function (result) {
+            ticketWorkLogController.getWorklogs(req.ticketConfig, req.user.config, id, undefined, req.globalScriptParams).then(function (result) {
                 req.result = {
                     data: result.data
                 };
@@ -36,6 +36,8 @@ module.exports = (function() {
     ticketWorkLogRoutes.get('/:worklogId', function (req, res, next) {
             const ticketId = req.parentId;
             const worklogId = req.params.worklogId;
+            req.globalScriptParams.id = ticketId
+            req.globalScriptParams.id2 = worklogId
             eventLog.setEventData(
                 req,
                 req.parentEventBase,
@@ -45,7 +47,7 @@ module.exports = (function() {
                 null,
                 worklogId
             );
-            ticketWorkLogController.getWorklog(req.ticketConfig, req.user.config, ticketId, worklogId).then(function (result) {
+            ticketWorkLogController.getWorklog(req.ticketConfig, req.user.config, ticketId, worklogId, undefined, req.globalScriptParams).then(function (result) {
                 req.result = result;
                 next();
             }).catch(function (reason) {
@@ -163,12 +165,14 @@ module.exports = (function() {
                 isPublic = true;
             }
 
-            ticketWorkLogController.createWorklog(req.ticketConfig, req.user.config, ticketId, req.body.data.summary, req.body.data.text, isPublic)
+            ticketWorkLogController.createWorklog(req.ticketConfig, req.user.config, ticketId, req.body.data.summary, req.body.data.text, isPublic, req.globalScriptParams)
                 .then(result => {
                     const worklogId = result['0'];
                     req.eventData.ticketNumber2 = worklogId;
+                    req.globalScriptParams.id = ticketId
+                    req.globalScriptParams.id2 = worklogId
                     log.debug('WorkLog created', worklogId);
-                    ticketWorkLogController.getWorklog(req.ticketConfig, req.user.config, ticketId, worklogId).then(worklogResult => {
+                    ticketWorkLogController.getWorklog(req.ticketConfig, req.user.config, ticketId, worklogId, undefined, req.globalScriptParams).then(worklogResult => {
                         req.result = worklogResult;
                         next();
                     });