@manyos/smileconnect-api 1.52.3 → 1.53.0

package/Dockerfile

@@ -1,7 +1,7 @@
 ### STAGE 1: Build ###
 
 # We label our stage as 'builder'
-FROM node:12.14 as builder
+FROM node:16 as builder
 ARG NPM_TOKEN
 COPY package.json package-lock.json ./
 

package/app.js

@@ -184,8 +184,12 @@ app.use('/v1/health', function (req, res, next) {
 //health check
 app.use('/v1/openapi/:clientId', async function (req, res, next) {
     const clientId = req.params.clientId;
-    const spec = await config.getDesignPackage(clientId)
-    res.json(spec)
+    try {
+        const spec = await config.getDesignPackage(clientId)
+        res.json(spec)
+    } catch (error) {
+        next(error)
+    }
 })
 
 const maxFilesize = process.env.MAX_FILESIZE || 5;

package/conf/clients.json

@@ -233,7 +233,8 @@
           "Support Group ID 2",
           "Customer Person ID",
           "Requested By Person ID",
-          "Change Target Date"
+          "Change Target Date",
+          "ServiceCI_ReconID"
         ],
         "constants": [
           {

package/conf/mapping.json

@@ -157,6 +157,10 @@
     {
       "oldName": "Change Target Date",
       "newName": "changeTargetDate"
+    },
+    {
+      "oldName": "ServiceCI_ReconID",
+      "newName": "serviceReconId"
     }
   ],
   "person": [
@@ -237,6 +241,10 @@
     {
       "oldName": "Detailed Description",
       "newName": "detailedDescription"
+    },
+    {
+      "oldName": "ServiceCI_ReconID",
+      "newName": "serviceReconId"
     }
   ],
   "changeWorklog": [

package/controller/ticketCIRelationController.js

@@ -394,12 +394,23 @@ async function getOppositeAssocTypeByCode(assocCode) {
     });
 }
 
-function doesCIRelationExists(ticketRelations, newRelation) {
+function doesCIRelationExists(ticketRelations, newRelation, keepCIs) {
     log.debug('check for relation old', ticketRelations)
     log.debug('check for relation new', newRelation)
     const relationFound = ticketRelations.find(relation => {
-        return ((relation.ciId === newRelation.ciId || relation.ciId === newRelation.ciReconId || relation.ciReconId === newRelation.ciId) &&
-            relation.relationType === newRelation.relationType);
+        let found = (relation.ciId === newRelation.ciId || relation.ciId === newRelation.ciReconId || relation.ciReconId === newRelation.ciId) && relation.relationType === newRelation.relationType
+        //check keepCIs only if not found
+        log.debug('relation found', found)
+        if (!found && keepCIs && Array.isArray(keepCIs)) {
+            log.debug('keep CI check', keepCIs)
+            keepCIs.forEach(keepCI => {
+                if (newRelation.ciId === keepCI || newRelation.ciReconId === keepCI) {
+                    found = true
+                    log.debug('Relation found in Keep', keepCI, found)
+                }
+            })
+        }
+        return found
     });
     if (relationFound) {
         return true;
@@ -421,6 +432,7 @@ function doesTicketRelationExists(ticketRelations, newRelation) {
 }
 
 async function updateRelations(ticketConfig, userConfig, ticketId, relations) {
+    // Wenn CIs vom Löschen ausgeschlossen werden sollen, dann kann unter relations.keepCIs ein Array mit Recon/InstanceId gesetzt werden.
     log.debug('Checker', {ticketConfig, userConfig, ticketId, relations});
     // Remove Ticket Relations if task
     if (ticketConfig.assocTicketType === 'Task') {
@@ -436,7 +448,7 @@ async function updateRelations(ticketConfig, userConfig, ticketId, relations) {
         if (relations.ciRelations && Array.isArray(relations.ciRelations)) {
             for (x=0; x<relations.ciRelations.length; x++) {
                 const relation = relations.ciRelations[x];
-                const relationsExists = doesCIRelationExists(existingRelations, relation);
+                const relationsExists = doesCIRelationExists(existingRelations, relation, relations.keepCIs);
                 log.debug('createRelation, already exists', relation, relationsExists);
                 if (!relationsExists) {
                     await createTicketCIRelation(ticketConfig, ticketId, relation.ciId, relation.relationType);
@@ -447,9 +459,9 @@ async function updateRelations(ticketConfig, userConfig, ticketId, relations) {
         if (existingRelations && Array.isArray(existingRelations)) {
             for (x=0; x<existingRelations.length; x++) {
                 const relation = existingRelations[x];
-                const shouldRelationsExists = doesCIRelationExists(relations.ciRelations, relation);
+                const shouldRelationsExists = doesCIRelationExists(relations.ciRelations, relation, relations.keepCIs);
                 log.debug('deleteRelation, already exists', relation, shouldRelationsExists);
-                if (!shouldRelationsExists) {
+                if (shouldRelationsExists !== true) {
                     await deleteTicketCIRelation(ticketConfig, ticketId, relation.ciId);
                 }
             }

package/controller/ticketController.js

@@ -21,7 +21,7 @@ function getTickets(ticketConfig, config, includeString, customOptions, globalSc
 
 async function createTicket(ticketConfig, clientConfig, data, globalScriptParams) {
     const scripts = clientConfig[ticketConfig.requestType].scripts.POST;
-
+    const relations = data.relations || {}
     //run preScripts
     if (scripts && scripts.preMapping) {
         await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId);
@@ -51,6 +51,14 @@ async function createTicket(ticketConfig, clientConfig, data, globalScriptParams
     if (resultInterfaceCreate.data && Array.isArray(resultInterfaceCreate.data) && resultInterfaceCreate.data.length && resultInterfaceCreate.data[0][ticketConfig.ticketIdField]) {
         const ticketId = resultInterfaceCreate.data[0][ticketConfig.ticketIdField];
         globalScriptParams.id = ticketId
+
+        //do relation stuff here
+        //keep businessService CI Relation
+        if (data[ticketConfig.businessServiceReconIdField] && relations) {
+            relations.keepCIs = [data[ticketConfig.businessServiceReconIdField]]
+        }
+        await ticketCIRelationController.updateRelations(ticketConfig, clientConfig, ticketId, relations);
+
     } else {
         log.error('Cannot create Ticket', resultInterfaceCreate);
         throw({message: 'Cannot create Ticket', details : resultInterfaceCreate});
@@ -275,6 +283,7 @@ async function getTicket(ticketConfig, config, id, mapping, includeString, globa
 async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalScriptParams) {
     const scripts = clientConfig[ticketConfig.requestType].scripts.PUT;
     const fields = clientConfig[ticketConfig.requestType].fields
+    const relations = ticketData.relations || {}
 
     //run preScripts
     if (scripts && scripts.preMapping) {
@@ -283,8 +292,8 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalSc
 
     log.debug(clientConfig[ticketConfig.requestType]);
     const myClientConfig = {};
-    myClientConfig[ticketConfig.requestType] = {baseQuery: clientConfig[ticketConfig.requestType].baseQuery, fields: [1]};
-    const myMapping = [{"oldName":ticketConfig.requestIdField, "newName" :  "internalId"}];
+    myClientConfig[ticketConfig.requestType] = {baseQuery: clientConfig[ticketConfig.requestType].baseQuery, fields: [1, ticketConfig.businessServiceReconIdField]};
+    const myMapping = [{"oldName":ticketConfig.requestIdField, "newName" :  "internalId"}, {"oldName":ticketConfig.businessServiceReconIdField, "newName" :  "serviceReconId"}];
 
     const mapping = config.getMapping(ticketConfig.requestType);
 
@@ -298,9 +307,13 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalSc
 
     const ticket = await getTicket(ticketConfig, myClientConfig, id, myMapping, undefined, globalScriptParams);
     log.debug('Ticket to Update', ticket);
+    //keep businessService CI Relation
+    if (ticket && ticket.data && ticket.data.serviceReconId && relations) {
+        relations.keepCIs = [ticket.data.serviceReconId]
+    }
     //todo Abfangen wenn getTicket nichts liefert.
     const update = await arquery.updateEntry(ticketConfig.forms.regular, ticket.data.internalId, ticketData);
-
+    await ticketCIRelationController.updateRelations(ticketConfig, clientConfig, id, relations);
     //run afterExecution
     if (scripts && scripts.afterExecution) {
         await scriptController.runScripts(scripts.afterExecution, ticketData, clientConfig.clientId, globalScriptParams);

package/docs/releases.md

@@ -2,6 +2,12 @@
 
 ## API 
 
+### 1.53.0 - 17.11.11
+Update NodeJs to v16
+
+### 1.52.4 - 17.11.11
+Fix issue: Keep invisible ServiceCi Relation in Tickets during CI Relation Update
+
 ### 1.52.3 - 16.11.11
 Fix issue: Add globalParams to update ticket
 

package/package.json

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

package/routes/ticketRoutes.js

@@ -62,12 +62,12 @@ module.exports = (function() {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            const relations = req.body.data.relations;
+            //const relations = req.body.data.relations;
             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;
-                await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, ticketId, relations);
+                //await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, ticketId, relations);
                 getTicket(req, res, next, req.user.config, ticketId, null, includeString);
             }).catch(function (reason) {
                 next(reason);
@@ -171,7 +171,7 @@ module.exports = (function() {
             const relations = req.body.data.relations;
             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);
+                    //await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, id, relations);
                     getTicket(req, res, next, req.user.config, id, null, includeString);
                 }).catch(function (reason) {
                 next(reason);

package/util/config.js

@@ -330,28 +330,34 @@ async function getDesignPackage(clientId) {
     const clientConfig = await getClientConfig(clientId)
     const schemas = {}
     let paths = {}
+
+    //generate docs for normal tickets
     const keys = Object.keys(ticketConfig)
+
     for (let x=0; x<keys.length; x++) {
         const key = keys[x]
         const config = ticketConfig[key]
         const clientObjectConfig = clientConfig[config.requestType]
         if (clientObjectConfig) {
-            {
+            if (clientObjectConfig.fields && clientObjectConfig.fields.length > 0){
                 const mapping = getDeprecatedMappingAsCustom(config.requestType)
-                schemas[config.requestType] = await getObjectSchema(clientObjectConfig, mapping, config.forms.regular)
+                schemas[config.requestType] = await getObjectSchema(clientObjectConfig.fields, mapping, config.forms.regular)
                 paths = {...paths, ... await getPathDef(config.assocTicketType, config.baseURI, config.requestType)}
             }
-            if (config.requestTypeWorkLog) {
+            if (config.requestTypeWorkLog && clientConfig[config.requestTypeWorkLog].fields && clientConfig[config.requestTypeWorkLog].fields.length > 0) {
                 const mapping = getDeprecatedMappingAsCustom(config.requestTypeWorkLog)
-                schemas[config.requestTypeWorkLog] = await getObjectSchema(clientConfig[config.requestTypeWorkLog], mapping, config.forms.workLog)
+                schemas[config.requestTypeWorkLog] = await getObjectSchema(clientConfig[config.requestTypeWorkLog].fields, mapping, config.forms.workLog)
                 paths = {...paths, ... await getPathDef(config.assocTicketType, config.baseURI + '/{ticketId}/worklogs', config.requestTypeWorkLog, true, true)}
             }
-            if (config.requestTemplate) {
+            if (config.requestTemplate && clientConfig[config.requestTemplate].fields  && clientConfig[config.requestTemplate].fields.length > 0) {
                 const mapping = getDeprecatedMappingAsCustom(config.requestTemplate)
-                schemas[config.requestTemplate] = await getObjectSchema(clientConfig[config.requestTemplate], mapping, config.forms.template)
+                schemas[config.requestTemplate] = await getObjectSchema(clientConfig[config.requestTemplate].fields, mapping, config.forms.template)
             }
         }
     }
+
+
+    //generate docs for custom Forms
     const customFormMappings = await getCustomFormMapping()
     const customKeys = Object.keys(customFormMappings)
     for (let x=0; x<customKeys.length; x++) {
@@ -360,14 +366,51 @@ async function getDesignPackage(clientId) {
         const clientObjectConfig = clientConfig[`custom_${formName}`]
         log.debug('key', key, clientObjectConfig)
         if (clientObjectConfig) {
-            schemas[key] = await getObjectSchema(clientObjectConfig, customFormMappings[key].mapping, formName)
+            schemas[key] = await getObjectSchema(clientObjectConfig.fields, customFormMappings[key].mapping, formName)
             paths = {...paths, ... await getPathDef(key, '/v1/customForms/' + key, key)}
         }
     }
+
+
+    //generate docs for cmdb
+    const cmdbMapping = getDeprecatedMappingAsCustom('cmdbobject')
+
+    if (clientConfig.cmdbobject && clientConfig.cmdbobject.fields) {
+        schemas['cmdbobject'] = await getObjectSchema(clientConfig.cmdbobject.fields, cmdbMapping, 'AST:BaseElement')
+
+
+        const cmdbdef = Object.keys(clientConfig.cmdbobject)
+        const classConfigs = cmdbdef.filter(item => item.startsWith('fields_'))
+        const cmdbSchemaList = ['cmdbobject']
+        for (let x=0; x<classConfigs.length; x++) {
+            const classConfig = classConfigs[x]
+            const formName = classConfig.replace('fields_', '')
+            const fields = clientConfig.cmdbobject[classConfig]
+            const classMapping = getDeprecatedMappingAsCustom(`cmdbobject_${formName}`)
+            const classSchema = await getObjectSchema(fields, classMapping, formName)
+            let schemaName = `cmdbobject_${formName}`
+            schemaName = schemaName.replaceAll(':','_')
+            schemaName = schemaName.replaceAll(' ','_')
+            cmdbSchemaList.push(schemaName)
+            schemas[schemaName] = {
+                required: schemas['cmdbobject'].required.concat(classSchema.required),
+                properties: {...schemas['cmdbobject'].properties, ...classSchema.properties}
+            }
+            log.debug('customForm', formName, fields, classMapping, classSchema)
+        }
+
+        paths = {...paths, ... await getPathDef('cmdbobject', '/v1/cmdbobjects', cmdbSchemaList)}
+    }
+
     return {openapi: "3.0.1", info, servers, paths, components: {schemas}}
 }
 
-async function getPathDef(objectName, baseUri, tag, isSubTicket, suppressUpdate, suppressCreate) {
+async function getPathDef(objectName, baseUri, schema, isSubTicket, suppressUpdate, suppressCreate) {
+    let tag = [schema]
+    if (Array.isArray(schema)) {
+        tag = schema
+    }
+
     const ticketIdParam = {
         name: "ticketId",
         description: "id of the parent object to retrieve",
@@ -396,39 +439,39 @@ async function getPathDef(objectName, baseUri, tag, isSubTicket, suppressUpdate,
     pathDef[`${baseUri}/{id}`] = {
         parameters,
         get: {
-            tags: [tag],
+            tags: tag,
             summary: `Get a single ${objectName} object by id`,
             description: "A single object is returned in the data attribute",
             parameters: [],
-            responses: await getApiResponse(tag, true)
+            responses: await getApiResponse(schema, true)
         }
     }
     if (!suppressUpdate) {
         pathDef[`${baseUri}/{id}`].put = {
-            tags: [tag],
+            tags: tag,
                 summary: `Update an object of type ${objectName}`,
                 description: "A single object is returned in the data attribute",
                 parameters: [],
-                responses: await getApiResponse(tag, false)
+                responses: await getApiResponse(schema, false)
         }
     }
 
     pathDef[`${baseUri}`] = {
         get: {
-            tags: [tag],
+            tags: tag,
             summary: `Get a list of object of type ${objectName}`,
             description: "An array ob objects is returned in the data attribute",
             parameters: [],
-            responses: await getApiResponse(tag, false)
+            responses: await getApiResponse(schema, false)
         }
     }
     if (!suppressCreate) {
         pathDef[`${baseUri}`].post = {
-            tags: [tag],
+            tags: tag,
             summary: `Create a new object of type ${objectName}`,
             description: "A single object is returned in the data attribute",
             parameters: [],
-            responses: await getApiResponse(tag, false)
+            responses: await getApiResponse(schema, false)
         }
     }
     if (isSubTicket) {
@@ -438,6 +481,18 @@ async function getPathDef(objectName, baseUri, tag, isSubTicket, suppressUpdate,
 }
 
 async function getApiResponse(schema, single) {
+    let dataValue = {
+        "$ref": `#/components/schemas/${schema}`
+    }
+    if (Array.isArray(schema)) {
+        dataValue = {
+            oneOf: schema.map(item => {
+                return {
+                    "$ref": `#/components/schemas/${item}`
+                }
+            })
+        }
+    }
     responses = {
         "200": {
             description: "successful operation",
@@ -456,24 +511,20 @@ async function getApiResponse(schema, single) {
     if (!single) {
         responses["200"].content["application/json"].schema.properties.data = {
             type: "array",
-            items: {
-                "$ref": `#/components/schemas/${schema}`
-            }
+            items: dataValue
         }
     } else {
-        responses["200"].content["application/json"].schema.properties.data = {
-            "$ref": `#/components/schemas/${schema}`
-        }
+        responses["200"].content["application/json"].schema.properties.data = dataValue
     }
     return responses
 }
 
-async function getObjectSchema(clientObjectConfig, mapping, formName) {
+async function getObjectSchema(clientFields, mapping, formName) {
     const fields = await getFields(formName)
     const required = []
     const properties = {}
-    log.debug('clientObjConf', clientObjectConfig)
-    clientObjectConfig.fields.forEach(field => {
+    log.debug('clientFields', clientFields, mapping, formName)
+    clientFields.forEach(field => {
         const mappedName = mapping[field]
         const fieldDef = {}
         const fieldDetails = fields.find(item => item.name === field)
@@ -544,6 +595,7 @@ const ticketConfig = {
         "requestIdField": "Request ID",
         "requestType": "workOrder",
         "ticketIdField": "WorkOrder_ID",
+        "businessServiceReconIdField": "CI_ReconId",
         "requestTypeWorkLog": "workOrderWorklog",
         "requestTemplate": "workOrderTemplate",
         "baseURI": "/v1/workorders",
@@ -562,6 +614,7 @@ const ticketConfig = {
         "requestIdField": "Entry ID",
         "requestType": "incident",
         "ticketIdField": "Incident Number",
+        businessServiceReconIdField: "ServiceCI_ReconID",
         "requestTypeWorkLog": "incidentWorklog",
         "requestTemplate": "incidentTemplate",
         "baseURI": "/v1/incidents",
@@ -580,6 +633,7 @@ const ticketConfig = {
         "requestIdField": "Request ID",
         "requestType": "change",
         "ticketIdField": "Infrastructure Change Id",
+        businessServiceReconIdField: "ServiceCI_ReconID",
         "requestTypeWorkLog": "changeWorklog",
         "requestTemplate": "changeTemplate",
         "baseURI": "/v1/changes",
@@ -598,6 +652,7 @@ const ticketConfig = {
         "requestIdField": "Sys-Problem Investigation ID",
         "requestType": "problem",
         "ticketIdField": "Problem Investigation ID",
+        businessServiceReconIdField: "ServiceCI_ReconID",
         "requestTypeWorkLog": "problemWorklog",
         "requestTemplate": "problemTemplate",
         "baseURI": "/v1/problems",