@manyos/smileconnect-api 1.41.4 → 1.42.0

package/app.js

@@ -296,10 +296,13 @@ app.use('/v1/templates/(|incidents|problems|workorders|changes|tasks)', function
 }, templateRoutes);
 
 //formhandling
-app.use('/v1/customForms/:formName', function(req, res, next) {
+app.use('/v1/customForms/:formAlias', async function(req, res, next) {
+    const formAlias = req.params.formAlias
+    const formMapping = await config.getCustomFormMapping(formAlias)
     req.formConfig = {
-        formName: req.params.formName,
-        configName: 'custom_' + req.params.formName
+        formName: formMapping.formName,
+        configName: 'custom_' + formMapping.formName,
+        mapping: formMapping.mapping
     }
     req.parentEventBase = 'customForm'
     next();

package/conf/clients.json

@@ -137,7 +137,6 @@
         "translateSelectionFieldsX": false
       },
       "custom_Sample:Enrollments": {
-        "formName": "Sample:Enrollments",
         "basequery": "1=1",
         "fields": [
           "Enrollment ID",
@@ -369,7 +368,8 @@
           "Direct Contact Person ID",
           "Submit Date",
           "Last Modified Date",
-          "Resolution"
+          "Resolution",
+          "Submitter"
         ],
         "constants": [
           {
@@ -395,6 +395,10 @@
           {
             "name": "Status",
             "value": "0"
+          },
+          {
+            "name": "Submitter",
+            "value": "Horstinaut"
           }
         ],
         "basequery": "1=1",

package/conf/customFormMapping.json

@@ -0,0 +1,30 @@
+{
+  "persons": {
+    "formName": "CTM:People",
+    "mapping": {
+      "Remedy Login ID": "id",
+      "Full Name": "name"
+    }
+  },
+  "enrollments": {
+    "formName": "Sample:Enrollments",
+    "mapping": {
+      "Enrollment ID": "id",
+      "Enrollee Login": "userId",
+      "Class ID": "classId",
+      "Class Title": "classTitle",
+      "Class Location": "location",
+      "Class Start Date & Time": "startDate",
+      "Class Cost": "cost",
+      "Department": "department"
+    }
+  },
+  "baseElement": {
+    "formName": "AST:BaseElement",
+    "mapping": {
+      "Instance Id": "id",
+      "Class Id": "class",
+      "Class Id2": "class4"
+    }
+  }
+}

package/conf/mapping.json

@@ -1,38 +1,4 @@
 {
-  "custom_Sample:Enrollments": [
-    {
-      "oldName": "Enrollment ID",
-      "newName": "id"
-    },
-    {
-      "oldName": "Enrollee Login",
-      "newName": "userId"
-    },
-    {
-      "oldName": "Class ID",
-      "newName": "classId"
-    },
-    {
-      "oldName": "Class Title",
-      "newName": "classTitle"
-    },
-    {
-      "oldName": "Class Location",
-      "newName": "location"
-    },
-    {
-      "oldName": "Class Start Date & Time",
-      "newName": "startDate"
-    },
-    {
-      "oldName": "Class Cost",
-      "newName": "cost"
-    },
-    {
-      "oldName": "Department",
-      "newName": "department"
-    }
-  ],
   "cmdbobject": [
     {
       "oldName": "Instance Id",

package/controller/customFormController.js

@@ -6,7 +6,7 @@ const CacheService = require ('../util/cache.service');
 const config = require('../util/config');
 const CONSTANTS = require('../util/constants');
 const searchUtil = require('../util/searchUtil');
-const {getIncludeArray, applyMapping} = require('../util/paramHelper');
+const {getIncludeArray, applyCustomFormMapping} = require('../util/paramHelper');
 const scriptController = require('./scriptController');
 const mappingUtil = require('../util/mappingUtil');
 
@@ -31,12 +31,12 @@ async function createRecord(formConfig, clientConfig, data, globalScriptParams)
 
     const requestType = formConfig.requestType;
 
-    const mapping = config.getMapping(formConfig.configName)
+    const mapping = formConfig.mapping;
     log.debug('mapping', mapping);
 
-    const fields = mappingUtil.getFieldsForCreate(mapping, mapping, clientConfig[formConfig.configName].fields)
+    const fields = clientConfig[formConfig.configName].fields
 
-    data = mappingUtil.applyMapping2Remedy(data, mapping, clientConfig[formConfig.configName].constants, fields);
+    data = mappingUtil.applyCustomFormMapping2Remedy(data, mapping, clientConfig[formConfig.configName].constants, fields);
 
     //run postScripts
     if (scripts && scripts.postMapping) {
@@ -55,7 +55,7 @@ async function createRecord(formConfig, clientConfig, data, globalScriptParams)
         log.error('Cannot create Record', resultInterfaceCreate);
         throw({message: 'Cannot create Record', details : resultInterfaceCreate});
     }
-
+    globalScriptParams.id = recordCreateId
     //run afterExecution
     if (scripts && scripts.afterExecution) {
         await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId, globalScriptParams);
@@ -84,7 +84,7 @@ function queryRecords(formConfig, clientConfig, query, mapping, customFields, cu
     const key = baseQuery + fields.toString() + query + JSON.stringify(options) + includeArray;
     log.debug('Cachekey is ', key);
     if (mapping == null || mapping == undefined) {
-        mapping = config.getMapping(formConfig.configName);
+        mapping = formConfig.mapping
     }
     log.debug('mapping', mapping);
 
@@ -124,7 +124,7 @@ async function handleRecord(formConfig, record, mapping, clientConfig, includeAr
         }
     }
 
-    applyMapping(record, mapping);
+    mappingUtil.applyCustomFormMapping(record, mapping);
 
     //run postScripts
     if (scripts && scripts.postMapping) {
@@ -160,9 +160,9 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
         await scriptController.runScripts(scripts.preMapping, recordData, clientConfig.clientId, globalScriptParams);
     }
 
-    const mapping = config.getMapping(formConfig.configName);
+    const mapping = formConfig.mapping
 
-    recordData = mappingUtil.applyMapping2Remedy(recordData, mapping, undefined, fields);
+    recordData = mappingUtil.applyCustomFormMapping2Remedy(recordData, mapping, clientConfig[formConfig.configName].constants, fields);
 
     //run postMapping
     if (scripts && scripts.postMapping) {
@@ -180,10 +180,10 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
 }
 
 function searchRecords(formConfig, clientConfig, searchString, fields, options, includeString, globalScriptParams) {
-    const mapping = config.getMapping(formConfig.configName);
-    const mappedString = searchUtil.applyMapping(searchString, mapping);
-    const customFields = searchUtil.getCustomFields(clientConfig[formConfig.configName].fields, mapping, fields);
-    options.sort = searchUtil.applySortMapping(options.sort, mapping);
+    const mapping = formConfig.mapping
+    const mappedString = searchUtil.applyCustomFormMapping(searchString, mapping);
+    const customFields = searchUtil.getCustomFormFields(clientConfig[formConfig.configName].fields, mapping, fields);
+    options.sort = searchUtil.applyCustomFormSortMapping(options.sort, mapping);
     return queryRecords(formConfig, clientConfig, mappedString, null, customFields, options, includeString, globalScriptParams);
 }
 

package/controller/taskController.js

@@ -81,6 +81,8 @@ async function createTask(clientConfig, rootForm, rootRequestId, taskData, creat
         }
 
         const taskResult = await arquery.createEntry('TMS:Task', taskData, clientConfig.options)
+        const taskId = taskResult['0'];
+        globalScriptParams.id2 = taskId;
 
         //run afterExecution
         if (scripts && scripts.afterExecution) {
@@ -148,6 +150,7 @@ async function createWorklog(clientConfig, taskId, data, globalScriptParams) {
     }
 
     const result = await arquery.createEntry('TMS:WorkInfo', data, clientConfig.options)
+    globalScriptParams.id3 = result['0']
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {

package/controller/ticketController.js

@@ -50,6 +50,7 @@ async function createTicket(ticketConfig, clientConfig, data, globalScriptParams
     const resultInterfaceCreate = await arquery.executeARQuery(ticketConfig.forms.new, null, "'1'=\"" + ticketCreateId + "\"", ticketConfig.ticketIdField, clientConfig.options)
     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
     } else {
         log.error('Cannot create Ticket', resultInterfaceCreate);
         throw({message: 'Cannot create Ticket', details : resultInterfaceCreate});

package/controller/ticketWorkLogController.js

@@ -73,6 +73,8 @@ async function createWorklog(ticketConfig, clientConfig, ticketId, data, globalS
     }
 
     const result = arquery.createEntry(ticketConfig.forms.workLog, data, clientConfig.options)
+    const worklogId = result['0'];
+    globalScriptParams.id2 = worklogId
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {

package/docs/openapi.json

@@ -2,7 +2,7 @@
     "openapi": "3.0.2",
     "info": {
         "title": "SMILEconnect",
-        "version": "1.40.0",
+        "version": "1.41.4",
         "contact": {
             "name": "manyos technology GmbH",
             "url": "https://manyos.it",
@@ -4838,32 +4838,6 @@
                     "id": "WLG000000000533"
                 }
             },
-            "WorklogNew": {
-                "title": "Root Type for Worklog",
-                "description": "",
-                "required": [
-                    "summary",
-                    "text"
-                ],
-                "type": "object",
-                "properties": {
-                    "summary": {
-                        "type": "string"
-                    },
-                    "text": {
-                        "type": "string"
-                    },
-                    "isPublic": {
-                        "description": "Defines whether this worklog is public or only internal. Public worklogs are share with the requestor of the ticket. Internal worklogs are only visible within the support organization.\nDefaults to false (internal only).",
-                        "type": "boolean"
-                    }
-                },
-                "example": {
-                    "summary": "Status Change",
-                    "text": "Status Marked: Resolved by Allen",
-                    "isPublic": true
-                }
-            },
             "WorklogResponseList": {
                 "description": "",
                 "required": [
@@ -16078,6 +16052,32 @@
                     "id": "ars101",
                     "code": "try {\n    const result = await adapter.remedy.search(params.form, params.query, params.valueField + ',' + params.labelField);\n    const data = result.data.map(item => {\n        return {\n            \"value\":item[params.valueField],\n            \"label\":item[params.labelField],\n        }\n    });\n    resolve(data);\n} catch (error) {\n    reject(error);\n}"
                 }
+            },
+            "WorklogNew": {
+                "title": "Root Type for Worklog",
+                "description": "",
+                "required": [
+                    "summary",
+                    "text"
+                ],
+                "type": "object",
+                "properties": {
+                    "summary": {
+                        "type": "string"
+                    },
+                    "text": {
+                        "type": "string"
+                    },
+                    "isPublic": {
+                        "description": "Deprecated - use mapping of view Access instead. Will be removed in future versions.\n\nDefines whether this worklog is public or only internal. Public worklogs are share with the requestor of the ticket. Internal worklogs are only visible within the support organization.\nDefaults to false (internal only).",
+                        "type": "boolean"
+                    }
+                },
+                "example": {
+                    "summary": "Status Change",
+                    "text": "Status Marked: Resolved by Allen",
+                    "isPublic": true
+                }
             }
         },
         "responses": {

package/docs/releases.md

@@ -2,6 +2,10 @@
 
 ## API 
 
+### 1.42.0 - 08.09.21
+
+Add IDs to POST Actions for After Execution Scripts
+
 ### 1.41.4 - 10.08.21
 
 Fix mapping for Ticket Worklogs
@@ -34,10 +38,13 @@ The eventmanager will check all outbound webhooks for an event. If one fails, th
 
 ## GUI
 
+### 1.4.18 - 11.08.21
+hovering on fields in mappingtable, destroys values in "new" mapping, in some situations
+
 ### 1.4.17 - 09.08.21
 
 Multiple events caused an error in the UI.
 
 ### 1.4.16 - 02.08.21
 
-Add Auth + Scripts to Event config
+Add Auth + Scripts to Event config

package/package.json

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

package/routes/appConfigRoutes.js

@@ -86,6 +86,108 @@ module.exports = (function() {
             }
         });
 
+    routes.get('/mappings/customForms', isAuthorizedAdmin,
+        async function (req, res, next) {
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_QUERY,
+                CONSTANTS.FORM_APC_MAPPING_CUSTOMFORM
+            );
+
+            try {
+                const fieldMapping = await config.getCustomFormMapping();
+                log.debug('get all field mappings', fieldMapping);
+                if (fieldMapping == null || fieldMapping == undefined) {
+                    next('Could not load mappings');
+                } else {
+                    req.result = {
+                        "data": fieldMapping
+                    };
+                    next();
+                }
+            } catch (error) {
+                next(error);
+            }
+        });
+
+    routes.get('/mappings/customForms/:id', isAuthorizedAdmin,
+        async function (req, res, next) {
+            const id = req.params.id
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_QUERY,
+                CONSTANTS.FORM_APC_MAPPING_CUSTOMFORM,
+                id
+            );
+
+            try {
+                const fieldMapping = await config.getCustomFormMapping(id);
+                log.debug('get all field mappings', fieldMapping);
+                if (fieldMapping == null || fieldMapping == undefined) {
+                    next('Could not load mappings');
+                } else {
+                    req.result = {
+                        "data": fieldMapping
+                    };
+                    next();
+                }
+            } catch (error) {
+                next(error);
+            }
+        });
+
+    routes.put('/mappings/customForms/:id', isAuthorizedAdmin,
+        checkSchema(fieldMappingSchemas.customFormMappingItemSchema),
+        async function (req, res, next) {
+            const id = req.params.id;
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_MODIFY,
+                CONSTANTS.FORM_APC_MAPPING_CUSTOMFORM,
+                id,
+                req.body
+            );
+            const errors = validationResult(req);
+            if (!errors.isEmpty()) {
+                req.errorStatus = 422;
+                next(errors.array());
+            } else {
+                try {
+                    const data = await config.setCustomFormMapping(req.body.data, id)
+                    req.result = {
+                        data
+                    }
+                    next();
+                } catch (error) {
+                    next(error);
+                }
+            }
+        });
+
+    routes.put('/mappings/customForms', isAuthorizedAdmin,
+        async function (req, res, next) {
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_MODIFY,
+                CONSTANTS.FORM_APC_MAPPING_CUSTOMFORM,
+                undefined,
+                req.body
+            );
+            try {
+                const data = await config.setCustomFormMapping(req.body.data)
+                req.result = {
+                    data
+                }
+                next();
+            } catch (error) {
+                next(error);
+            }
+        });
+
     routes.put('/mappings/fields/:id', isAuthorizedAdmin,
         checkSchema(fieldMappingSchemas.fieldMappingItemSchema),
         function (req, res, next) {

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, globalScriptParams).then(function (result) {
+        customFormController.getRecords(req.formConfig, req.user.config, includeString, options, req.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, globalScriptParams).then(async function (createResult) {
+            customFormController.createRecord(req.formConfig, req.user.config, req.body.data, req.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, globalScriptParams).then(function (result) {
+            customFormController.searchRecords(req.formConfig, req.user.config, req.body.searchString, req.body.fields, options, includeString, req.globalScriptParams).then(function (result) {
                 log.debug('result', result);
                 req.result = {data:result.data};
                 next();
@@ -131,7 +131,7 @@ module.exports = (function() {
 
     function getRecord(req, res, next, clientConfig, id, mapping, includeString) {
         req.globalScriptParams.id = id
-        customFormController.getRecord(req.formConfig, clientConfig, id, mapping, includeString, globalScriptParams).then(function (result) {
+        customFormController.getRecord(req.formConfig, clientConfig, id, mapping, includeString, req.globalScriptParams).then(function (result) {
             log.debug('result', result);
             req.includeObjectsList = result.included;
             req.result = {data:result.data || {}};
@@ -162,7 +162,7 @@ module.exports = (function() {
             req.errorStatus = 422;
             next(errors.array());
         } else {
-            customFormController.updateRecord(req.formConfig, req.user.config, id, req.body.data, globalScriptParams)
+            customFormController.updateRecord(req.formConfig, req.user.config, id, req.body.data, req.globalScriptParams)
                 .then(async function (updateResult) {
                     getRecord(req, res, next, req.user.config, id, null, includeString);
                 }).catch(function (reason) {

package/util/config.js

@@ -1,4 +1,6 @@
 const fs = require('fs');
+const fsPromises = require('fs').promises;
+
 const path = require('path');
 const log = require('@manyos/logger').setupLog('SMILEconnect_' + path.basename(__filename));
 
@@ -8,6 +10,8 @@ const CacheService = require ('../util/cache.service');
 
 const CONSTANTS = require('./constants');
 
+const configFileCustomFormMapping = 'conf/customFormMapping.json';
+
 const configCache = new CacheService(process.env.CACHETTL_CONFIG || 3600); // Create a new cache service instance
 
 const clientConfigItemTemplate = {
@@ -45,6 +49,35 @@ function getClient(client) {
     });
 }
 
+async function getCustomFormMapping(objectType) {
+    log.debug('start to read config from file', configFileCustomFormMapping);
+    try {
+        const rawdata = await fsPromises.readFile(configFileCustomFormMapping);
+        const jsonData = JSON.parse(rawdata) || {};
+        if (objectType) {
+            return jsonData[objectType]
+        } else {
+            return jsonData
+        }
+    } catch (e) {
+        log.error('Cant read custom form Mapping')
+    }
+    return {}
+}
+
+async function setCustomFormMapping(mapping, objectType) {
+    log.debug('start to update config from file', configFileCustomFormMapping);
+    log.debug('set mapping data', objectType, mapping);
+    let jsonData = await getCustomFormMapping()
+    if (objectType) {
+        jsonData[objectType] = mapping;
+    } else {
+        jsonData = mapping
+    }
+    await fsPromises.writeFile(configFileCustomFormMapping, JSON.stringify(jsonData, null, 2));
+    return getCustomFormMapping(objectType)
+}
+
 function getMapping(objectType) {
     const configFile = 'conf/mapping.json';
     log.debug('start to read config from file', configFile);
@@ -164,6 +197,23 @@ function checkMapping() {
     log.info('check mapping done');
 }
 
+async function checkCustomFormMapping() {
+    log.info('check customForm mapping');
+    const mappings = await getCustomFormMapping();
+    const mappingAliases = Object.keys(mappings)
+    mappingAliases.forEach(mappingAlias => {
+        const mappingDef = mappings[mappingAlias]
+        log.debug('check', mappingDef)
+        if (!mappingDef.formName || !mappingDef.mapping) {
+            log.error('Remove wrong custom Form mapping', mappingDef)
+            delete mappings[mappingAlias]
+        }
+    })
+    // save
+    await setCustomFormMapping(mappings);
+    log.info('check customForm mapping done');
+}
+
 function checkClientConfig(client) {
     const clientKeys = [
         'cmdbobject',
@@ -236,10 +286,11 @@ function checkClientConfigs() {
     log.info('check client configs done');
 }
 
-function checkConfig() {
+async function checkConfig() {
     log.info('check config');
     checkMapping();
     checkClientConfigs();
+    await checkCustomFormMapping();
     log.info('check config done');
 }
 
@@ -356,5 +407,7 @@ module.exports = {
     checkConfig,
     getForms,
     getFields,
-    ticketConfig
+    ticketConfig,
+    getCustomFormMapping,
+    setCustomFormMapping
 };

package/util/constants.js

@@ -21,6 +21,7 @@ module.exports = {
     FORM_WORKORDER_TEMPLATE: "WOI:Template",
     FORM_APC_CLIENTS: "ClientConfig",
     FORM_APC_MAPPING_FIELDS: "MappingFields",
+    FORM_APC_MAPPING_CUSTOMFORM: "MappingCustomForm",
     FORM_APC_WEBHOOK: "Webhooks",
     FORM_APC_FORMS_FIELDS: "FormFields",
     FORM_APC_FORMS: "Forms",