@manyos/smileconnect-api 1.59.3 → 1.60.0

package/app.js

@@ -371,6 +371,7 @@ app.use('/v1/:requestType/:parentId/tasks', function(req, res, next) {
 }, taskRoutes);
 
 app.use(relatedObjectsController.getRelatedObjects);
+app.use(relatedObjectsController.addLinks);
 
 app.use(responseHandler.eventQueueHandler);
 

package/conf/clients.json

@@ -2091,9 +2091,11 @@
             "preMapping": [],
             "postMapping": []
           },
-          "POST": {
+          "PUT": {
             "preMapping": [],
-            "postMapping": []
+            "postMapping": [
+              "notfetchresult"
+            ]
           }
         }
       },
@@ -2289,7 +2291,9 @@
           },
           "PUT": {
             "preMapping": [],
-            "postMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
             "afterExecution": []
           },
           "POST": {
@@ -2376,14 +2380,18 @@
             "preMapping": [
               "p2"
             ],
-            "postMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
             "afterExecution": [
               "INC_CreateWorklog_OnCreate"
             ]
           },
           "PUT": {
             "preMapping": [],
-            "postMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
             "afterExecution": []
           }
         }
@@ -2491,7 +2499,15 @@
           }
         ],
         "basequery": "",
-        "scripts": {},
+        "scripts": {
+          "POST": {
+            "preMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
+            "afterExecution": []
+          }
+        },
         "attachmentScripts": {}
       },
       "problemWorklog": {
@@ -2562,7 +2578,22 @@
             "value": "1000"
           }
         ],
-        "scripts": {}
+        "scripts": {
+          "POST": {
+            "preMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
+            "afterExecution": []
+          },
+          "PUT": {
+            "preMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
+            "afterExecution": []
+          }
+        }
       },
       "taskWorklog": {
         "fields": [
@@ -2585,7 +2616,22 @@
           }
         ],
         "basequery": "1=1",
-        "scripts": {},
+        "scripts": {
+          "POST": {
+            "preMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
+            "afterExecution": []
+          },
+          "PUT": {
+            "preMapping": [],
+            "postMapping": [
+              "notFetchResult"
+            ],
+            "afterExecution": []
+          }
+        },
         "attachmentScripts": {
           "POST": {
             "preMapping": [

package/controller/customFormController.js

@@ -155,7 +155,11 @@ async function handleRecord(formConfig, record, mapping, clientConfig, includeAr
 
 async function getRecord(formConfig, clientConfig, id, mapping, includeString, globalScriptParams) {
     const idField = getIdField(formConfig)
-    const query = `'${idField}'=\"${id}\"`;
+    let query = `'${idField}'=\"${id}\"`;
+    if (globalScriptParams.recordQuery) {
+        query = globalScriptParams.recordQuery;
+        log.debug('Set custom record query to', globalScriptParams.recordQuery);
+    }
     const returnValue = await queryRecords(formConfig, clientConfig, query, mapping, null, {limit:1}, includeString, globalScriptParams);
     const record =  returnValue.data[0];
     return {data: record};

package/controller/relatedObjectsController.js

@@ -10,6 +10,7 @@ const config = require('../util/config');
 async function getRelatedObjects(req, res, next) {
     log.debug('include Data', req.includeArray);
     log.debug('include Objects', req.includeObjectsList);
+
     if (req.result && req.includeObjectsList && req.includeArray) {
         let result = {};
         const includedObjects = req.includeObjectsList;
@@ -195,6 +196,29 @@ function replaceObjectKeys(item) {
     }
 }
 
+async function addLinks(req, res, next) {
+    if (!req.globalScriptParams) {
+        req.globalScriptParams = {};
+    }
+    const id = req.globalScriptParams.id2 || req.globalScriptParams.id;
+    const urlStart = req.url.split('?')[0];
+    if (req.result && id) {
+        let selfUrl = '';
+        if (urlStart.endsWith(id)) {
+            selfUrl = urlStart;
+        } else {
+            selfUrl = urlStart + '/' + id;
+        }
+        req.result.links = {
+            self: {
+                id: id,
+                href: selfUrl
+            }
+        }
+    }
+    next();
+}
+
 module.exports = {
-    getRelatedObjects
+    getRelatedObjects, addLinks
 }

package/controller/ticketController.js

@@ -124,7 +124,8 @@ async function handleTicket(ticketConfig, ticket, mapping, clientConfig, include
         scripts = allScripts.GET || [];
     }
 
-    globalScriptParams.id = ticket[ticketConfig.requestIdField]
+    //TODO: Check if needed
+    //globalScriptParams.id = ticket[ticketConfig.requestIdField]
 
     const requestType = ticketConfig.requestType;
     if (requestType === 'incident') {
@@ -308,7 +309,6 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalSc
     if (scripts && scripts.postMapping) {
         await scriptController.runScripts(scripts.postMapping, ticketData, clientConfig.clientId, globalScriptParams);
     }
-
     const ticket = await getTicket(ticketConfig, myClientConfig, id, myMapping, undefined, globalScriptParams);
     log.debug('Ticket to Update', ticket);
     //keep businessService CI Relation
@@ -322,7 +322,6 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalSc
     if (scripts && scripts.afterExecution) {
         await scriptController.runScripts(scripts.afterExecution, ticketData, clientConfig.clientId, globalScriptParams);
     }
-
     return {updateResult: update, relationErrors};
 }
 

package/controller/ticketWorkLogController.js

@@ -49,6 +49,9 @@ async function createWorklog(ticketConfig, clientConfig, ticketId, data, globalS
         )
     }
 
+    //todo Hier prüfen ob das Ticket existiert
+
+
     const clientConstants = clientConfig[ticketConfig.requestTypeWorkLog].constants;
     const viewAccessConstant = clientConstants.find(element => element.name === "View Access")
     //run only if isPublic is set and no Constant is defined

package/docs/configuration/config.md

@@ -249,6 +249,18 @@ Sample:
 
 *AR_PASSWORD=password*
 
+### BASEQUERY
+
+Allows advanced control of the events that are handled by this Event Manager Engine.
+
+e.g. Add a delay before events are processed
+
+*BASEQUERY='Create Date' + 60 < $TIMESTAMP$*
+
+e.g. Handle specific client events only
+
+*BASEQUERY='VendorID' = "abc123"*
+
 ## SSO Connection
 
 For a minimum configuration only the SSO Public Key is required.

package/docs/releases.md

@@ -1,6 +1,9 @@
 # Release Notes
 
 ## API
+### 1.60.0 - 27.09.22
+Add optional parameter "notFetchResult" to globalScriptParams. If set to yes, no object will be returned after POST/PUT requests. This can help to reduce database / server load as request are reduced.
+
 ### 1.59.3 - 10.06.22
 Collect all ciTicketRelationErrors and return them at the end
 
@@ -174,6 +177,12 @@ e.g.
 
 ## Event Manager
 
+### 1.25.0 - 13.09.22
+Improve error logging
+
+### 1.24.0 - 05.07.22
+Added baseQuery option for advanced control
+
 ### 1.22.0 - 03.03.22
 Add updateScriptReference
 

package/docs/scripts.md

@@ -189,6 +189,8 @@ Full example:
 }
 ```
 
+**notFetchResult**: If set to yes, no object will be returned after POST/PUT requests. This can help to reduce database / server load as request are reduced.
+
 globalScriptParams is not available in Event Manager scripts. Ids are part of requestData there.
 
 ## requestData

package/package.json

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

package/routes/cmdbObjectRoutes.js

@@ -187,9 +187,14 @@ module.exports = (function () {
                 const hasAccess = await cmdbobjects.hasAccess(req.user.config, id);
                 if (hasAccess) {
                     const result = await cmdbobjects.updateCmdbObject(req.ticketConfig, req.user.config, id, req.body.data, classId, req.globalScriptParams);
-                    const ci = await cmdbobjects.getCmdbObject(req.user.config, id, includeString, undefined, req.globalScriptParams);
-                    req.result = ci;
-                    next();
+                    if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                        req.result = {};
+                        next()
+                    } else {
+                        const ci = await cmdbobjects.getCmdbObject(req.user.config, id, includeString, undefined, req.globalScriptParams);
+                        req.result = ci;
+                        next();
+                    }
                 } else {
                     req.errorStatus = 403;
                     next('Access forbidden.')
@@ -219,10 +224,15 @@ module.exports = (function () {
             const result = [];
             try {
                 const ciInstanceId = await cmdbobjects.createCmdbObject(req.ticketConfig, req.user.config, classId, req.body.data, req.globalScriptParams);
-                req.globalScriptParams.id = ciInstanceId
-                const ci = await cmdbobjects.getCmdbObject(req.user.config, ciInstanceId, includeString, undefined, req.globalScriptParams);
-                req.result = ci;
-                next();
+                req.globalScriptParams.id = ciInstanceId;
+                if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                    req.result = {};
+                    next()
+                } else {
+                    const ci = await cmdbobjects.getCmdbObject(req.user.config, ciInstanceId, includeString, undefined, req.globalScriptParams);
+                    req.result = ci;
+                    next();
+                }
             } catch (e) {
                 next(e);
             }

package/routes/customFormRoutes.js

@@ -63,7 +63,12 @@ module.exports = (function() {
                 const recordId = createResult;
                 eventLog.setTicketId(req, recordId);
                 req.eventData.ticketNumber = recordId;
-                getRecord(req, res, next, req.user.config, recordId, null, includeString);
+                if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                    req.result = {};
+                    next()
+                } else {
+                    getRecord(req, res, next, req.user.config, recordId, null, includeString);
+                }
             }).catch(function (reason) {
                 next(reason);
             });
@@ -164,7 +169,12 @@ module.exports = (function() {
         } else {
             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);
+                    if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                        req.result = {};
+                        next()
+                    } else {
+                        getRecord(req, res, next, req.user.config, id, null, includeString);
+                    }
                 }).catch(function (reason) {
                 next(reason);
             });

package/routes/taskRoutes.js

@@ -76,13 +76,18 @@ module.exports = (function () {
                         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();
-                    }).catch(function (reason) {
-                        next(reason);
-                    })
+                    if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                        req.result = {};
+                        next()
+                    } else {
+                        task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams, includeString).then(function (result) {
+                            req.includeObjectsList = result.included;
+                            req.result = {data: result.data || {}};
+                            next();
+                        }).catch(function (reason) {
+                            next(reason);
+                        })
+                    }
                 }
             }).catch(function (reason) {
                 next(reason);
@@ -139,13 +144,18 @@ module.exports = (function () {
                     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();
-                }).catch(function (reason) {
-                    next(reason);
-                })
+                if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                    req.result = {};
+                    next()
+                } else {
+                    task.getTaskByRootRequest(req.user.config, req.parentId, taskId, req.globalScriptParams, includeString).then(function (result) {
+                        req.includeObjectsList = result.included;
+                        req.result = {data: result.data || {}};
+                        next();
+                    }).catch(function (reason) {
+                        next(reason);
+                    })
+                }
             }).catch(function (reason) {
                 next(reason);
             });
@@ -200,18 +210,23 @@ module.exports = (function () {
             task.createWorklog(req.user.config, taskId, req.body.data, req.globalScriptParams)
                 .then(createResult => {
                     const worklogId = createResult['0'];
-                    task.getTaskWorklog(req.user.config, taskId, worklogId, req.globalScriptParams).then(result => {
-                        const urls = {
-                            "attachmentUrl" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/1`,
-                            "attachmentUrl2" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/2`,
-                            "attachmentUrl3" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/3`,
-                            "self" : `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}`
-                        };
-                        req.includeObjectsList = result.included;
-                        req.result = {data:result.data || {}};
-                        req.result.urls = urls;
-                        next();
-                    });
+                    if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                        req.result = {};
+                        next()
+                    } else {
+                        task.getTaskWorklog(req.user.config, taskId, worklogId, req.globalScriptParams).then(result => {
+                            const urls = {
+                                "attachmentUrl": `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/1`,
+                                "attachmentUrl2": `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/2`,
+                                "attachmentUrl3": `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}/attachments/3`,
+                                "self": `/v1/${req.parentType}/${req.parentId}/tasks/${taskId}/worklogs/${worklogId}`
+                            };
+                            req.includeObjectsList = result.included;
+                            req.result = {data: result.data || {}};
+                            req.result.urls = urls;
+                            next();
+                        });
+                    }
                     log.debug('WorkLog created');
                 })
                 .catch(error => {

package/routes/ticketRoutes.js

@@ -73,7 +73,12 @@ module.exports = (function() {
                 eventLog.setTicketId(req, ticketId);
                 req.eventData.ticketNumber = ticketId;
                 //await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, ticketId, relations);
-                getTicket(req, res, next, req.user.config, ticketId, null, includeString, {errors:{ciRelationErrors:relationErrors}});
+                if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                    req.result = {};
+                    next()
+                } else {
+                    getTicket(req, res, next, req.user.config, ticketId, null, includeString, {errors: {ciRelationErrors: relationErrors}});
+                }
             }).catch(function (reason) {
                 next(reason);
             });
@@ -184,7 +189,12 @@ module.exports = (function() {
                         req.responseStatus = 422;
                     }
                     //await ticketCIRelationController.updateRelations(req.ticketConfig, req.user.config, id, relations);
-                    getTicket(req, res, next, req.user.config, id, null, includeString, {errors:{ciRelationErrors:relationErrors}});
+                    if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                        req.result = {};
+                        next()
+                    } else {
+                        getTicket(req, res, next, req.user.config, id, null, includeString, {errors: {ciRelationErrors: relationErrors}});
+                    }
                 }).catch(function (reason) {
                 next(reason);
             });

package/routes/ticketWorkLogRoutes.js

@@ -173,10 +173,15 @@ module.exports = (function() {
                     req.globalScriptParams.id = ticketId
                     req.globalScriptParams.id2 = worklogId
                     log.debug('WorkLog created', worklogId);
-                    ticketWorkLogController.getWorklog(req.ticketConfig, req.user.config, ticketId, worklogId, undefined, req.globalScriptParams).then(worklogResult => {
-                        req.result = worklogResult;
-                        next();
-                    });
+                    if (req.globalScriptParams && req.globalScriptParams.notFetchResult && req.globalScriptParams.notFetchResult === true) {
+                        req.result = {};
+                        next()
+                    } else {
+                        ticketWorkLogController.getWorklog(req.ticketConfig, req.user.config, ticketId, worklogId, undefined, req.globalScriptParams).then(worklogResult => {
+                            req.result = worklogResult;
+                            next();
+                        });
+                    }
                 })
                 .catch(error => {
                     next(error);