@manyos/smileconnect-api 1.44.0 → 1.45.0

package/app.js

@@ -337,6 +337,7 @@ app.use('/v1/:requestType/:parentId/tasks', function(req, res, next) {
     const parentId = req.params.parentId;
     const allowedTypes = ['incidents', 'problems', 'workorders', 'changes'];
     if (allowedTypes.includes(requestType))  {
+        req.ticketConfig = config.ticketConfig['tasks'];
         req.parentId = parentId;
         req.requestType = requestType;
         setParentForm(req);

package/conf/clients.json

@@ -587,7 +587,8 @@
           "Support Company",
           "Assignee Organization",
           "Assignee Group",
-          "Phase GUID"
+          "Phase GUID",
+          "InstanceId"
         ],
         "constants": [
           {

package/controller/taskController.js

@@ -8,19 +8,21 @@ const CONSTANTS = require('../util/constants');
 const relationUtil = require('../util/relationUtil');
 const mappingUtil = require('../util/mappingUtil');
 const scriptController = require('./scriptController');
+const {getIncludeArray} = require("../util/paramHelper");
+const ticketCIRelationController = require("./ticketCIRelationController");
 
 const taskCache = new CacheService(process.env.CACHETTL_TASK || 0); // Create a new cache service instance
 
-function getTasks(config, category, globalScriptParams) {
+function getTasks(config, category, globalScriptParams, includeString) {
     let query = '1=1';
     if (category)
         query = `'Category' = \"${category}\"`;
     return queryTasks(config, query, globalScriptParams);
 }
 
-function getTasksByRootRequest(config, rootRequestId, rootRequestForm, globalScriptParams) {
+function getTasksByRootRequest(config, rootRequestId, rootRequestForm, globalScriptParams, includeString) {
     const query = `'RootRequestID' = \"${rootRequestId}\" AND 'RootRequestFormName' = \"${rootRequestForm}\"`;
-    return queryTasks(config, query, globalScriptParams);
+    return queryTasks(config, query, globalScriptParams, includeString);
 }
 
 async function createTask(clientConfig, rootForm, rootRequestId, taskData, createTaskFlow, globalScriptParams) {
@@ -171,8 +173,9 @@ async function createWorklog(clientConfig, taskId, data, globalScriptParams) {
     //todo add attachment handling
 }
 
-function queryTasks(clientConfig, query, globalScriptParams) {
+function queryTasks(clientConfig, query, globalScriptParams, includeString) {
     const scripts = clientConfig.task.scripts.GET;
+    const includeArray = getIncludeArray(includeString);
 
     const key = clientConfig.task.basequery + clientConfig.task.fields.toString() + query;
     log.debug('Cachekey is', key);
@@ -209,6 +212,12 @@ function queryTasks(clientConfig, query, globalScriptParams) {
                     await scriptController.runScripts(scripts.preMapping, element, clientConfig.clientId, globalScriptParams);
                 }
 
+                element.relations = {};
+                if (includeArray.includes('ciRelations')) {
+                    const relations = await ticketCIRelationController.getTicketCIRelations(element['InstanceId']);
+                    element.relations.ciRelations = relations;
+                }
+
                 //Apply mapping
                 mapping.forEach(function (mappingEntry) {
                     try {
@@ -220,7 +229,7 @@ function queryTasks(clientConfig, query, globalScriptParams) {
                 });
                 delete element['Request ID'];
 
-                //run preScripts
+                //run postScripts
                 if (scripts && scripts.postMapping) {
                     await scriptController.runScripts(scripts.postMapping, element, clientConfig.clientId, globalScriptParams);
                 }
@@ -296,9 +305,9 @@ async function getTask(clientConfig, id, globalScriptParams) {
     return tasks.data[0];
 }
 
-async function getTaskByRootRequest(config, rootRequestId, taskId, globalScriptParams) {
+async function getTaskByRootRequest(config, rootRequestId, taskId, globalScriptParams, includeString) {
     const query = `'Task ID'=\"${taskId}\" AND 'RootRequestID' = \"${rootRequestId}\"`;
-    const returnValue = await queryTasks(config, query, globalScriptParams);
+    const returnValue = await queryTasks(config, query, globalScriptParams, includeString);
     const task =  returnValue.data[0];
     return {data: task, included: returnValue.included};
 }
@@ -381,6 +390,13 @@ function getAttachmentFieldId(attachmentId) {
     return attachmentFieldId;
 }
 
+async function lookupInstanceId(taskId) {
+    const result = await arquery.executeARQuery('TMS:Task', undefined, `'1' = "${taskId}"`, 'InstanceId')
+    if (result && result.data && Array.isArray(result.data)) {
+        return (result.data[0].InstanceId)
+    }
+}
+
 module.exports = {
     getTaskByRootRequest,
     getTasks,
@@ -391,5 +407,6 @@ module.exports = {
     getTasksByRootRequest,
     createWorklog,
     setWorklogAttachment,
-    getWorklogAttachment
+    getWorklogAttachment,
+    lookupInstanceId
 };

package/controller/ticketCIRelationController.js

@@ -135,28 +135,45 @@ async function createTicketCIRelation(ticketConfig, ticketId, ciInstanceId, asso
         throw new Error(`CI ${ciInstanceId} not found.`);
     }
     const schemaName = await getSchemaName(ciData.ClassId);
-    const ticketRelationFormData = {
+    let ticketRelationFormData = {
         "Form Name01" : schemaName,
-        "Request ID01" : ciData.ReconciliationIdentity,
         "Request Type01" : 6000,
         "Form Name02" : ticketForm,
         "Association Type01": assocLookup.assocCode,
         "Request Description01": ciData.Name,
-        "Request ID02": ticketId,
         "Lookup Keyword": ciData.ClassId
     };
     const assetRelationFormData = {
         "Form Name01" : ticketForm,
-        "Request ID01" : ticketId,
         "Request Type01" : ticketType,
         "Form Name02" : schemaName,
         "Lookup Keyword01": ticketKeyword,
         "Association Type01": assocLookup.oppositeCode,
         "Request Description01": ticketSummary,
-        "Request ID02": ciData.ReconciliationIdentity,
         "Lookup Keyword": ciData.ClassId,
-        "Parent_DataSet_ID01": "BMC.ASSET"
+        "Parent_DataSet_ID01": "BMC.ASSET",
+        "Request ID01" : ticketId,
+        "Request ID02": ciData.ReconciliationIdentity
     };
+
+    if (ticketConfig.assocTicketType === 'Task') {
+        ticketRelationFormData = {
+            ...ticketRelationFormData,
+            ...{
+                "ID01" : ciData.ReconciliationIdentity,
+                "ID02": ticketId
+            }
+        }
+    } else {
+        ticketRelationFormData = {
+            ...ticketRelationFormData,
+            ...{
+                "Request ID01" : ciData.ReconciliationIdentity,
+                "Request ID02": ticketId,
+            }
+        }
+    }
+
     log.debug('Create CI Ticket Relation', ticketRelationFormData);
     //todo: implement impersonate
     const ticketRelation = await arquery.createEntry(ticketRelationForm, ticketRelationFormData);
@@ -208,7 +225,10 @@ async function createTicket2TicketRelation(ticketConfig, ticketId1, ticketConfig
 async function deleteTicketCIRelation(ticketConfig, ticketId, ciInstanceId) {
     const ticketRelationForm = ticketConfig.forms.assoc;
     const ciData = await getCIData(ciInstanceId);
-    const ticketRelationQuery = `'Request ID02'= "${ticketId}" AND 'Request ID01' = "${ciData.ReconciliationIdentity}"`;
+    let ticketRelationQuery = `'Request ID02'= "${ticketId}" AND 'Request ID01' = "${ciData.ReconciliationIdentity}"`;
+    if (ticketConfig.assocTicketType === 'Task') {
+        ticketRelationQuery = `'ID02'= "${ticketId}" AND 'ID01' = "${ciData.ReconciliationIdentity}"`;
+    }
     const assetRelationQuery = `'Request ID02'= "${ciData.ReconciliationIdentity}" AND 'Request ID01' = "${ticketId}"`;
     log.debug('Delete Ticket2CI Relation', ticketRelationQuery);
     log.debug('Delete CI2Ticket Relation', assetRelationQuery);

package/docs/releases.md

@@ -2,6 +2,9 @@
 
 ## API 
 
+### 1.45.0 - 27.09.21
+Add ciRelation Handling for Tasks
+
 ### 1.44.0 - 27.09.21
 Also allow CI RecondId for Ticket2CI Relations.
 

package/package.json

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

package/routes/taskRoutes.js

@@ -4,6 +4,7 @@ const {body, validationResult, oneOf} = require('express-validator/check');
 const task = require('../controller/taskController');
 const eventLog = require('../controller/eventLogController');
 const CONSTANTS = require('../util/constants');
+const ticketCIRelationController = require("../controller/ticketCIRelationController");
 
 module.exports = (function () {
     const taskRoutes = require('express').Router();
@@ -15,6 +16,7 @@ module.exports = (function () {
 
     taskRoutes.get('/', async function (req, res, next) {
         const id = req.parentId;
+        const includeString = req.query.include;
         //todo customize eventbase
         eventLog.setEventData(
             req,
@@ -24,7 +26,7 @@ module.exports = (function () {
             id
         );
 
-        const result = await task.getTasksByRootRequest(req.user.config, id, req.parentForm, req.globalScriptParams);
+        const result = await task.getTasksByRootRequest(req.user.config, id, req.parentForm, req.globalScriptParams, includeString);
         req.includeObjectsList = result.included;
         req.result = {data:result.data || {}};
 
@@ -33,6 +35,8 @@ module.exports = (function () {
 
     taskRoutes.post('/', function (req, res, next) {
         const origData = JSON.parse(JSON.stringify(req.body));
+        const includeString = req.query.include;
+        const relations = req.body.data.relations;
         eventLog.setEventData(
             req,
             req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
@@ -56,10 +60,9 @@ module.exports = (function () {
                 let taskResult = {};
                 if (resultKeys.length > 1 || Array.isArray(req.body.data)) {
                     taskResult = [];
-                    let x=0;
-                    for (x=0; x<resultKeys.length; x++) {
+                    for (let x=0; x<resultKeys.length; x++) {
                         const taskId = createResult[resultKeys[x]];
-                        const result = await task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams);
+                        const result = await task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams, includeString);
                         taskResult.push(result.data);
                     }
                     //todo fix included objects
@@ -68,7 +71,12 @@ module.exports = (function () {
                     next();
                 } else {
                     const taskId = createResult['0'];
-                    task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams).then(function (result) {
+                    if (relations && relations.ciRelations) {
+                        const taskInstanceId = await task.lookupInstanceId(taskId)
+                        log.debug('Add ciRelations to task', taskId, taskInstanceId, relations)
+                        await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, taskInstanceId, relations);
+                    }
+                    task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams, includeString).then(function (result) {
                         req.includeObjectsList = result.included;
                         req.result = {data:result.data || {}};
                         next();
@@ -87,6 +95,7 @@ module.exports = (function () {
         const taskId = req.params.taskId;
         req.globalScriptParams.id = parentId
         req.globalScriptParams.id2 = taskId
+        const includeString = req.query.include;
         eventLog.setEventData(
             req,
             req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
@@ -97,16 +106,18 @@ module.exports = (function () {
             taskId
         );
 
-        const result = await task.getTaskByRootRequest(req.user.config, parentId, taskId, req.globalScriptParams);
+        const result = await task.getTaskByRootRequest(req.user.config, parentId, taskId, req.globalScriptParams, includeString);
         req.includeObjectsList = result.included;
         req.result = {data:result.data || {}};
         next();
     });
 
-    taskRoutes.put('/:taskId', function (req, res, next) {
+    taskRoutes.put('/:taskId', async function (req, res, next) {
         const taskId = req.params.taskId;
         req.globalScriptParams.id = req.parentId;
         req.globalScriptParams.id2 = taskId
+        const relations = req.body.data.relations;
+        const includeString = req.query.include;
         const origData = JSON.parse(JSON.stringify(req.body));
         eventLog.setEventData(
             req,
@@ -122,8 +133,13 @@ module.exports = (function () {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            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) {
+            task.updateTask(req.user.config, taskId, req.body.data, req.globalScriptParams).then(async function (updateResult) {
+                if (relations && relations.ciRelations) {
+                    const taskInstanceId = await task.lookupInstanceId(taskId)
+                    log.debug('Add ciRelations to task', taskId, taskInstanceId, relations)
+                    await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, taskInstanceId, relations);
+                }
+                task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams, includeString).then(function (result) {
                     req.includeObjectsList = result.included;
                     req.result = {data:result.data || {}};
                     next();

package/util/config.js

@@ -387,10 +387,14 @@ const ticketConfig = {
     },
     "tasks": {
         "forms": {
-            "template": CONSTANTS.FORM_TASK_TEMPLATE
+            "template": CONSTANTS.FORM_TASK_TEMPLATE,
+            "regular": CONSTANTS.FORM_TASK,
+            "assoc": CONSTANTS.FORM_TASK_ASSOC,
         },
         "requestTemplate": "taskTemplate",
-        "templateRequestId": "Template ID"
+        "templateRequestId": "Template ID",
+        "assocTicketKeyword": "TMSTASK",
+        "assocTicketType": "Task",
     }
 };
 

package/util/constants.js

@@ -14,6 +14,7 @@ module.exports = {
     FORM_TASK: "TMS:Task",
     FORM_TASK_WORKLOG: "TMS:WorkInfo",
     FORM_TASK_TEMPLATE: "TMS:TaskTemplate",
+    FORM_TASK_ASSOC: "TMS:Relationships",
     FORM_WORKORDER: "WOI:WorkOrder",
     FORM_WORKORDER_CREATE: "WOI:WorkOrderInterface_Create",
     FORM_WORKORDER_ASSOC: "WOI:Associations",