@manyos/smileconnect-api 1.49.1 → 1.50.0

package/conf/clients.json

@@ -154,6 +154,13 @@
           "Class Start Date & Time"
         ]
       },
+      "custom_CTM:People": {
+        "basequery": "1=1",
+        "fields": [
+          "Remedy Login ID",
+          "Full Name"
+        ]
+      },
       "cmdbobject": {
         "basequery": "'Data Set Id' = \"BMC.ASSET\" AND ('Mark As Deleted' = \"No\" OR 'Mark As Deleted' = $NULL$)",
         "fields": [

package/controller/cmdbobjectController.js

@@ -332,9 +332,10 @@ async function updateCmdbObject(ticketConfig, clientConfig, id, ciData, classId,
     }
 
     const mapping = getClassMapping(classId);
+    const classFields = getClassFields(clientConfig, classId)
 
     //Constants work only on new.
-    ciData = mappingUtil.applyMapping2Remedy(ciData, mapping, undefined, clientConfig.cmdbobject.fields);
+    ciData = mappingUtil.applyMapping2Remedy(ciData, mapping, undefined, classFields);
 
     //run postMapping
     if (scripts && scripts.postMapping) {
@@ -351,11 +352,26 @@ async function updateCmdbObject(ticketConfig, clientConfig, id, ciData, classId,
     return update;
 }
 
+function getClassFields(clientConfig, classId) {
+    //Add globalFields
+    const globalFields = clientConfig.cmdbobject.fields;
+    log.debug('Global class fields', globalFields)
+    if (classId) {
+        const classFields = clientConfig.cmdbobject[`fields_${classId}`]
+        log.debug('Local class fields', classFields)
+        return [...new Set([...globalFields,...classFields])]
+    }
+    return globalFields
+}
+
 function getClassMapping(classId) {
     const mappings = [];
     const globalMappings = config.getMapping(CMDBOBJECT);
     const classMappings = config.getMapping(`${CMDBOBJECT}_${classId}`);
 
+    log.debug('Found global Mapping', globalMappings)
+    log.debug('Found class Mapping', classMappings)
+
     //Add all global Mappings that are not in ClassMapping
     globalMappings.forEach(globalMapping => {
         const foundInClassMappings = classMappings.find(element => element.newName === globalMapping.newName);
@@ -368,6 +384,8 @@ function getClassMapping(classId) {
     classMappings.forEach(classMapping => {
         mappings.push(classMapping);
     });
+
+    log.debug('Created joined Mapping', mappings)
     return mappings;
 }
 
@@ -385,10 +403,10 @@ async function createCmdbObject(assetConfig, clientConfig, classId, ciData, glob
 
     const mapping = getClassMapping(classId);
 
-    log.debug('Combined Mapping', mapping);
+    const classFields = getClassFields(clientConfig, classId)
 
     //Constants work only on new.
-    ciData = mappingUtil.applyMapping2Remedy(ciData, mapping, undefined, clientConfig.cmdbobject.fields);
+    ciData = mappingUtil.applyMapping2Remedy(ciData, mapping, undefined, classFields);
 
     //run postMapping
     if (scripts && scripts.postMapping) {

package/controller/customFormController.js

@@ -12,6 +12,15 @@ const mappingUtil = require('../util/mappingUtil');
 
 const ticketCache = new CacheService(process.env.CACHETTL_TICKETS || 1); // Create a new cache service instance
 
+function getIdField(formConfig) {
+    const mapping = formConfig.mapping
+    const idField = Object.keys(mapping).find(key => mapping[key] === 'id');
+    if (!idField) {
+        return '1'
+    }
+    return idField
+}
+
 function getRecords(formConfig, clientConfig, includeString, customOptions, globalScriptParams) {
     let query = '1=1';
     return queryRecords(formConfig, clientConfig, query, null, null, customOptions, includeString, globalScriptParams);
@@ -141,8 +150,9 @@ async function handleRecord(formConfig, record, mapping, clientConfig, includeAr
 }
 
 async function getRecord(formConfig, clientConfig, id, mapping, includeString, globalScriptParams) {
-    const query = `'1'=\"${id}\"`;
-    const returnValue = await queryRecords(formConfig, clientConfig, query, mapping, null, null, includeString, globalScriptParams);
+    const idField = getIdField(formConfig)
+    const query = `'${idField}'=\"${id}\"`;
+    const returnValue = await queryRecords(formConfig, clientConfig, query, mapping, null, {limit:1}, includeString, globalScriptParams);
     const record =  returnValue.data[0];
     return {data: record};
 }
@@ -169,7 +179,9 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
         await scriptController.runScripts(scripts.postMapping, recordData, clientConfig.clientId, globalScriptParams);
     }
 
-    const update = await arquery.updateEntry(formConfig.formName, id, recordData);
+    const internalId = await getInternalId(formConfig, clientConfig, id)
+
+    const update = await arquery.updateEntry(formConfig.formName, internalId, recordData);
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {
@@ -179,6 +191,16 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
     return update;
 }
 
+async function getInternalId(formConfig, clientConfig, id) {
+    const idField = getIdField(formConfig)
+    const query = `'${idField}'=\"${id}\"`;
+    const result = await arquery.executeARQuery(formConfig.formName, clientConfig[formConfig.configName].basequery || null, query , '1', {limit:1})
+    if (result && result.data && result.data.length >0) {
+        return Object.values(result.data[0])[0]
+    }
+    throw new Error (`Internal Id for Record ${id} in Form ${formConfig.formName} could not be found`)
+}
+
 function searchRecords(formConfig, clientConfig, searchString, fields, options, includeString, globalScriptParams) {
     const mapping = formConfig.mapping
     const mappedString = searchUtil.applyCustomFormMapping(searchString, mapping);

package/docs/releases.md

@@ -2,6 +2,12 @@
 
 ## API 
 
+### 1.50.0 - 05.11.21
+Use custom defined id in customForms
+
+### 1.49.2 - 05.11.21
+Fix issue: Custom classAttributes not working in cmdbObjects PUT & POST
+
 ### 1.49.1 - 04.11.21
 Fix issue: Self Mapping in custom Forms removed attribute
 
@@ -112,6 +118,9 @@ Update Record added to [Remedy Adapter](adapter#remedy).
 The eventmanager will check all outbound webhooks for an event. If one fails, the whole Event will be set to error and the details will be added to the error message.
 
 ## GUI
+### 1.6.0 - 05.11.21
+Added attachmentScripts to GUI
+
 ### 1.5.5 - 03.11.21
 Add Parameter REACT_APP_OIDC_SCOPE to choose the oicd scope
 

package/package.json

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

package/test/customFormTest.js

@@ -0,0 +1,111 @@
+const assert = require('chai').assert;
+let chai = require('chai');
+let chaiHttp = require('chai-http');
+let should = chai.should();
+let server = require('../app');
+const TestUtils = require('./testUtils')
+require('dotenv').config();
+
+//Integrations Tests here
+
+chai.use(chaiHttp);
+
+describe('Integration Tests - customForms', function () {
+
+    let authUser = {'id':process.env.TEST_ID, 'secret':process.env.TEST_SECRET};
+
+    before((done) => {
+
+        // Authenticate the user to get a token
+        TestUtils.authenticateUser(authUser, server)
+            .then((accessToken) => {
+                // Keep the token on the user so we can use it in the tests
+                authUser.access_token = accessToken;
+                return done();
+            })
+            .catch((err) => done(err));
+    });
+
+    describe('GET custom Form Data', function () {
+        it ('it should get a spezific record by id', function (done) {
+            chai.request(server)
+                .get('/v1/customForms/persons/rhannemann')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('object');
+                    res.body.data.should.have.property('name');
+                    res.body.data.should.have.property('id');
+                    done();
+                })
+        })
+
+        it ('it should get all customForm records', function (done) {
+            chai.request(server)
+                .get('/v1/customForms/persons?limit=5')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('array');
+                    res.body.data.length.should.be.above(0);
+                    done();
+                })
+        })
+
+        it ('it should search customForms', function (done) {
+            const searchString = `'name' LIKE "Robert Hannemann%"`;
+            chai.request(server)
+                .post('/v1/customForms/persons/search')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .send({searchString})
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('array');
+                    res.body.data.length.should.be.above(0);
+                    done();
+                })
+        })
+
+        it ('it should update a customForm Record by id', function (done) {
+            const data = {
+                name: 'Robert Hannemann' + new Date()
+            }
+            chai.request(server)
+                .put('/v1/customForms/persons/rhannemann')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .send({data})
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('object');
+                    res.body.data.should.have.property('name');
+                    res.body.data.should.have.property('id');
+                    res.body.data.name.should.be.equal(data.name)
+                    done();
+                })
+        })
+
+        it ('it should create a customForm Record', function (done) {
+            const data = {
+                "userId": "Demo",
+                "classId": "00001",
+                "Department": "Mux",
+                "classTitle": "Blup",
+                "cost": 55,
+                "location": "Muc",
+                "startDate": "Mon Nov 07 16:00:00 GMT 2005"
+            }
+            chai.request(server)
+                .post('/v1/customForms/enrollments')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .send({data})
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('object');
+                    res.body.data.should.have.property('location');
+                    res.body.data.should.have.property('id');
+                    res.body.data.location.should.be.equal(data.location)
+                    done();
+                })
+        })
+    })
+})

package/util/arquery.js

@@ -92,10 +92,10 @@ async function executeARQuery(form, baseQuery, query, fields, options) {
     if (limit) {
         uri = uri + "&maxEntries=" + limit;
     }
-    log.debug('start request on:', uri);
+    log.debug('start GET request on:', uri);
 
     const value = await request(uri).auth(process.env.AR_USER, process.env.AR_PASSWORD, true);
-    log.debug('request done', uri, value);
+    log.debug('GET request done', uri, value);
 
     if (value && value.status && value.status === 'error') {
         throw new Error(value);
@@ -216,8 +216,8 @@ function createEntry(form, entryData, clientOptions) {
             json: true // Automatically stringifies the body to JSON
         };
 
-        log.debug('start request with:', options.body);
-        log.debug('start request on:', uri);
+        log.debug('start POST request with:', options.body);
+        log.debug('start POST request on:', uri);
         const singleRecord = Object.keys(finalEntries).length == 1;
         request(options).auth(process.env.AR_USER, process.env.AR_PASSWORD, true)
             .then(function (response) {
@@ -390,8 +390,8 @@ function updateEntry(form, id, entryData) {
             json: true // Automatically stringifies the body to JSON
         };
 
-        log.debug('start request with:', options.body);
-        log.debug('start request on:', uri);
+        log.debug('start PUT request with:', options.body);
+        log.debug('start PUT request on:', uri);
         request(options).auth(process.env.AR_USER, process.env.AR_PASSWORD, true)
             .then(function (response) {
                 log.debug('RAPI update return', response);