@manyos/smileconnect-api 1.36.3 → 1.37.0

package/app.js

@@ -33,6 +33,7 @@ const ciRelationRoutes = require('./routes/ciRelationRoutes');
 const peopleRelationRoutes = require('./routes/peopleRelationRoutes');
 const appConfigRoutes = require('./routes/appConfigRoutes');
 const scriptRoutes = require('./routes/scriptRoutes');
+const customFormRoutes = require('./routes/customFormRoutes');
 const relatedObjectsController = require('./controller/relatedObjectsController');
 const addRequestId = require('express-request-id')();
 const compression = require('compression');
@@ -273,6 +274,16 @@ app.use('/v1/templates/(|incidents|problems|workorders|changes|tasks)', function
     next();
 }, templateRoutes);
 
+//formhandling
+app.use('/v1/customForms/:formName', function(req, res, next) {
+    req.formConfig = {
+        formName: req.params.formName,
+        configName: 'custom_' + req.params.formName
+    }
+    req.parentEventBase = 'customForm'
+    next();
+}, customFormRoutes);
+
 //tickethandling worklogs
 app.use('/v1/:ticketType/:parentId/worklogs', function(req, res, next) {
     log.debug('params1', req.params);

package/conf/clients.json

@@ -135,6 +135,20 @@
         "impersonateUser": "rhannemann",
         "translateSelectionFieldsX": false
       },
+      "custom_Sample:Enrollments": {
+        "formName": "Sample:Enrollments",
+        "basequery": "1=1",
+        "fields": [
+          "Enrollment ID",
+          "Enrollee Login",
+          "Class ID",
+          "Class Title",
+          "Class Location",
+          "Class Cost",
+          "Department",
+          "Class Start Date & Time"
+        ]
+      },
       "cmdbobject": {
         "basequery": "'Data Set Id' = \"BMC.ASSET\" AND ('Mark As Deleted' = \"No\" OR 'Mark As Deleted' = $NULL$)",
         "fields": [

package/conf/mapping.json

@@ -1,4 +1,38 @@
 {
+  "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

@@ -0,0 +1,196 @@
+require('dotenv').config();
+const path = require('path');
+const log = require('@manyos/logger').setupLog('SMILEconnect_' + path.basename(__filename));
+const arquery = require('../util/arquery');
+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 scriptController = require('./scriptController');
+const mappingUtil = require('../util/mappingUtil');
+
+const ticketCache = new CacheService(process.env.CACHETTL_TICKETS || 1); // Create a new cache service instance
+
+function getRecords(formConfig, clientConfig, includeString, customOptions) {
+    let query = '1=1';
+    return queryRecords(formConfig, clientConfig, query, null, null, customOptions, includeString);
+}
+
+async function createRecord(formConfig, clientConfig, data) {
+    const allScripts = clientConfig[formConfig.configName].scripts;
+    let scripts
+    if (allScripts) {
+        scripts = allScripts.POST
+    }
+
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId);
+    }
+
+    const requestType = formConfig.requestType;
+
+    const mapping = config.getMapping(formConfig.configName)
+    log.debug('mapping', mapping);
+
+    const fields = mappingUtil.getFieldsForCreate(mapping, mapping, clientConfig[formConfig.configName].fields)
+
+    data = mappingUtil.applyMapping2Remedy(data, mapping, clientConfig[formConfig.configName].constants, fields);
+
+    //run postScripts
+    if (scripts && scripts.postMapping) {
+        await scriptController.runScripts(scripts.postMapping, data, clientConfig.clientId);
+    }
+
+    const result = await arquery.createEntry(formConfig.formName, data, clientConfig.options)
+
+    log.debug('RecordCreateResult', result.data);
+    const recordCreateId = Object.values(result)[0];
+    //Find change id
+    const resultInterfaceCreate = await arquery.executeARQuery(formConfig.formName, null, "'1'=\"" + recordCreateId + "\"", formConfig.ticketIdField, clientConfig.options)
+    if (resultInterfaceCreate.data && Array.isArray(resultInterfaceCreate.data) && resultInterfaceCreate.data.length > 0) {
+        const recordCreateId = resultInterfaceCreate.data[0][formConfig.ticketIdField];
+    } else {
+        log.error('Cannot create Record', resultInterfaceCreate);
+        throw({message: 'Cannot create Record', details : resultInterfaceCreate});
+    }
+
+    //run afterExecution
+    if (scripts && scripts.afterExecution) {
+        await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId);
+    }
+    return recordCreateId;
+}
+
+function queryRecords(formConfig, clientConfig, query, mapping, customFields, customOptions, includeString) {
+    const includeArray = getIncludeArray(includeString);
+    log.debug('Get config for', formConfig.configName)
+    let fields = clientConfig[formConfig.configName].fields;
+    const baseQuery = clientConfig[formConfig.configName].basequery;
+
+    //check for customFields
+    if (customFields !== null && customFields !== undefined) {
+        fields = customFields;
+    }
+
+    log.debug('fields', fields, customFields);
+    const options = {
+        ...clientConfig.options, ...customOptions
+    };
+
+    log.debug('use joined options', options);
+
+    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);
+    }
+    log.debug('mapping', mapping);
+
+    return ticketCache.get(key, async function () {
+        const result = await arquery.executeARQuery(formConfig.formName, baseQuery || null, query, fields.toString() || '1', options);
+        const records = [];
+        if (result && result.data && result.data.length) {
+            let x = 0;
+            for (x=0; x< result.data.length; x++) {
+                const ticket = await handleRecord(formConfig, result.data[x], mapping, clientConfig, includeArray);
+                records.push(ticket);
+            }
+        }
+        log.debug('records', records);
+        return {
+            "data": records
+        };
+    });
+}
+
+async function handleRecord(formConfig, record, mapping, clientConfig, includeArray, globalRelationObjects) {
+    const allScripts = clientConfig[formConfig.configName].scripts;
+    let scripts = [];
+    if (allScripts) {
+        scripts = allScripts.GET || [];
+    }
+
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        const preScripts = scripts.preMapping;
+        try {
+            for (let x = 0; x < preScripts.length; x++) {
+                const result = await scriptController.executeScript(preScripts[x], record, null, clientConfig.clientId);
+            }
+        } catch (error) {
+            throw error;
+        }
+    }
+
+    applyMapping(record, mapping);
+
+    //run postScripts
+    if (scripts && scripts.postMapping) {
+        const postScripts = scripts.postMapping;
+        try {
+            for (let x = 0; x < postScripts.length; x++) {
+                const result = await scriptController.executeScript(postScripts[x], record, null, clientConfig.clientId);
+            }
+        } catch (error) {
+            throw error;
+        }
+    }
+    return record;
+}
+
+async function getRecord(formConfig, clientConfig, id, mapping, includeString) {
+    const query = `'1'=\"${id}\"`;
+    const returnValue = await queryRecords(formConfig, clientConfig, query, mapping, null, null, includeString);
+    const record =  returnValue.data[0];
+    return {data: record};
+}
+
+async function updateRecord(formConfig, clientConfig, id, recordData) {
+    const allScripts = clientConfig[formConfig.configName].scripts;
+    let scripts
+    if (allScripts) {
+        scripts = allScripts.PUT
+    }
+    const fields = clientConfig[formConfig.configName].fields
+
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        await scriptController.runScripts(scripts.preMapping, recordData, clientConfig.clientId);
+    }
+
+    const mapping = config.getMapping(formConfig.configName);
+
+    recordData = mappingUtil.applyMapping2Remedy(recordData, mapping, undefined, fields);
+
+    //run postMapping
+    if (scripts && scripts.postMapping) {
+        await scriptController.runScripts(scripts.postMapping, recordData, clientConfig.clientId);
+    }
+
+    const update = await arquery.updateEntry(formConfig.formName, id, recordData);
+
+    //run afterExecution
+    if (scripts && scripts.afterExecution) {
+        await scriptController.runScripts(scripts.afterExecution, recordData, clientConfig.clientId);
+    }
+
+    return update;
+}
+
+function searchRecords(formConfig, clientConfig, searchString, fields, options, includeString) {
+    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);
+    return queryRecords(formConfig, clientConfig, mappedString, null, customFields, options, includeString);
+}
+
+module.exports = {
+    getRecord,
+    getRecords,
+    createRecord,
+    updateRecord,
+    searchRecords
+};

package/package.json

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

package/routes/customFormRoutes.js

@@ -0,0 +1,173 @@
+const path = require('path');
+const log = require('@manyos/logger').setupLog('SMILEconnect_' + path.basename(__filename));
+const {body, validationResult, oneOf} = require('express-validator/check');
+const customFormController = require('../controller/customFormController');
+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.get('/', function (req, res, next) {
+        eventLog.setEventData(
+            req,
+            req.parentEventBase,
+            CONSTANTS.EVENT_ACTION_QUERY,
+            req.formConfig.formName
+        );
+        const includeString = req.query.include;
+
+        const options = {};
+        const limit = req.query.limit;
+        if (limit != null && limit != undefined) {
+            options.limit = Number.parseInt(limit);
+        }
+
+        const offset = req.query.offset;
+        if (offset != null && offset != undefined) {
+            options.offset = Number.parseInt(offset);
+        }
+
+        customFormController.getRecords(req.formConfig, req.user.config, includeString, options).then(function (result) {
+            log.debug('result', result);
+            req.result = {data:result.data};
+            next();
+        }).catch(function (reason) {
+            next(reason);
+        });
+    });
+
+    routes.post('/', function (req, res, next) {
+        //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.formName,
+            null,
+            origData
+        );
+        const errors = validationResult(req).formatWith(errorFormatter);
+        if (!errors.isEmpty()) {
+            req.errorStatus = 422;
+            next(errors.array());
+        } else {
+            customFormController.createRecord(req.formConfig, req.user.config, req.body.data).then(async function (createResult) {
+                const recordId = createResult;
+                eventLog.setTicketId(req, recordId);
+                req.eventData.ticketNumber = recordId;
+                getRecord(req, res, next, req.user.config, recordId, null, includeString);
+            }).catch(function (reason) {
+                next(reason);
+            });
+        }
+    });
+
+    routes.post('/search', [
+            body('searchString').isLength({ min: 1})
+        ], function (req, res, next) {
+
+        const origData = JSON.parse(JSON.stringify(req.body));
+        const includeString = req.query.include;
+        eventLog.setEventData(
+            req,
+            req.parentEventBase,
+            CONSTANTS.EVENT_ACTION_SEARCH,
+            req.parentForm,
+            null,
+            origData
+        );
+        const options = {};
+        const offset = req.body.offset;
+        if (offset != null && offset != undefined && Number.isInteger(offset)) {
+            options.offset = offset;
+        }
+        const limit = req.body.limit;
+        if (limit != null && limit != undefined && Number.isInteger(limit)) {
+            options.limit = limit;
+        }
+        // check sorting
+        const sort = req.body.sort;
+        if (sort != null && sort != undefined) {
+            options.sort = sort;
+        }
+        log.debug('start global search', req.body);
+        const valResult = validationResult(req).formatWith(errorFormatter);
+        log.debug('validationResult', valResult.array());
+        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) {
+                log.debug('result', result);
+                req.result = {data:result.data};
+                next();
+            }).catch(function (reason) {
+                next(reason);
+            });
+        }
+    });
+
+    routes.get('/:id', function (req, res, next) {
+        const id = req.params.id;
+        const includeString = req.query.include;
+        eventLog.setEventData(
+            req,
+            req.parentEventBase,
+            CONSTANTS.EVENT_ACTION_SEARCH,
+            req.parentForm,
+            id
+        );
+
+        getRecord(req, res, next, req.user.config, id, null, includeString);
+
+    });
+
+    function getRecord(req, res, next, clientConfig, id, mapping, includeString) {
+        customFormController.getRecord(req.formConfig, clientConfig, id, mapping, includeString).then(function (result) {
+            log.debug('result', result);
+            req.includeObjectsList = result.included;
+            req.result = {data:result.data || {}};
+            if (!result.data) {
+                req.responseStatus = 404;
+            }
+            next();
+        }).catch(function (reason) {
+            next (reason);
+        })
+    }
+
+    routes.put('/:id', function (req, res, next) {
+        const id = req.params.id;
+        const origData = JSON.parse(JSON.stringify(req.body));
+        const includeString = req.query.include;
+        eventLog.setEventData(
+            req,
+            req.parentEventBase,
+            CONSTANTS.EVENT_ACTION_MODIFY,
+            req.formConfig.formName,
+            id,
+            origData
+        );
+        const errors = validationResult(req).formatWith(errorFormatter);
+        if (!errors.isEmpty()) {
+            req.errorStatus = 422;
+            next(errors.array());
+        } else {
+            customFormController.updateRecord(req.formConfig, req.user.config, id, req.body.data)
+                .then(async function (updateResult) {
+                    getRecord(req, res, next, req.user.config, id, null, includeString);
+                }).catch(function (reason) {
+                next(reason);
+            });
+        }
+    });
+
+    return routes;
+})();

package/routes/ticketRoutes.js

@@ -45,7 +45,7 @@ module.exports = (function() {
         });
     });
 
-    ticketRoutes.post('/', [body('data.summary').isLength({min: 3})], function (req, res, next) {
+    ticketRoutes.post('/', function (req, res, next) {
         //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;
@@ -126,7 +126,7 @@ module.exports = (function() {
         eventLog.setEventData(
             req,
             req.parentEventBase,
-            CONSTANTS.EVENT_ACTION_SEARCH,
+            CONSTANTS.EVENT_ACTION_QUERY,
             req.parentForm,
             id
         );

package/routes/ticketWorkLogRoutes.js

@@ -133,10 +133,7 @@ module.exports = (function() {
 
         });
 
-    ticketWorkLogRoutes.post('/',[
-            body('data.summary').isLength({ min: 1, max: 100}),
-            body('data.text').isLength({ min: 1})
-        ],
+    ticketWorkLogRoutes.post('/',
         function (req, res, next) {
             const origData = JSON.parse(JSON.stringify(req.body));
             const ticketId = req.parentId;

package/util/arquery.js

@@ -63,7 +63,7 @@ async function executeARQuery(form, baseQuery, query, fields, options) {
         + "/" + form
         + "/" + fullQuery
         + "?port=" + port
-        + "&fields=" + fields;
+        + "&fields=" + encodeURIComponent(fields);
 
     if (options != null && options != undefined) {
         if (options.dateFormat != null && options.dateFormat != undefined) {

package/util/config.js

@@ -147,7 +147,7 @@ function checkMapping() {
     const mappingKeys = Object.keys(mappings);
     //delete too many
     mappingKeys.forEach(key=>{
-        if (!mappingDefs.includes(key) && !key.startsWith('cmdbobject_')) {
+        if (!mappingDefs.includes(key) && !key.startsWith('cmdbobject_') && !key.startsWith('custom_')) {
             log.info('delete from mapping', key);
             delete mappings[key];
         }
@@ -192,7 +192,7 @@ function checkClientConfig(client) {
     const clientConfigKeys = Object.keys(clientConfig);
     //delete too many
     clientConfigKeys.forEach(key=>{
-        if (!clientKeys.includes(key) && !(key === 'options')) {
+        if (!clientKeys.includes(key) && !(key === 'options') && !(key.startsWith('custom_'))) {
             log.info('delete from clientconfig', key);
             delete clientConfig[key];
         } else if (clientKeys.includes(key) && !(key === 'options')) {