@manyos/smileconnect-api 1.46.3 → 1.47.0

package/conf/clients.json

@@ -299,7 +299,7 @@
             "value": "Other"
           }
         ],
-        "basequery": "",
+        "basequery": "1=1",
         "scripts": {
           "POST": {
             "preMapping": [

package/controller/scriptController.js

@@ -7,6 +7,7 @@ const basePath = 'conf';
 const basePathGlobalScripts = basePath + '/scripts';
 
 const fetch = require('node-fetch');
+const xmlParser = require('fast-xml-parser')
 
 const {getClients} = require('../util/config');
 
@@ -79,6 +80,7 @@ async function executeCode(code, requestData, params, logStream, executedByScrip
         adapter,
         log,
         clientId,
+        xmlParser,
         script:executeScriptByScript,
         globalScriptParams,
         env: process.env,

package/controller/taskController.js

@@ -133,10 +133,55 @@ async function updateTaskFlow(clientConfig, rootForm, rootRequestId, rootRequest
 
     flowBuilderRequest = mappingUtil.applyMapping2Remedy(flowBuilderRequest, mappingflow, clientConfig.flowBuilder.constants);
     const taskFlowResult = await arquery.createEntry('TMS:FlowBuilder', flowBuilderRequest, clientConfig.options)
-    await activateTaskFlow(clientConfig, rootRequestInstanceId)
+    //await activateTaskFlow(clientConfig, rootRequestInstanceId)
+    await checkFlowActivation(clientConfig, rootRequestInstanceId, rootRequestId, rootForm)
 }
 
-async function activateTaskFlow(clientConfig, rootRequestInstanceId) {
+async function checkFlowActivation(clientConfig, rootRequestInstanceId, rootRequestId, rootForm) {
+    let subQuery = "'1' = \"rootRequestId\"";
+    let statusField = '7'
+    let statusReasonField = ''
+    let companyField = 'Location Company'
+    if (rootForm === CONSTANTS.FORM_WORKORDER) {
+        subQuery = `'Work Order ID'=\"${rootRequestId}\"`;
+    } else if (rootForm === CONSTANTS.FORM_INCIDENT) {
+        subQuery = `'Incident Number'=\"${rootRequestId}\"`;
+    } else if (rootForm === CONSTANTS.FORM_PROBLEM) {
+        subQuery = `'Problem Investigation ID'=\"${rootRequestId}\"`;
+    } else if (rootForm === CONSTANTS.FORM_CHANGE) {
+        subQuery = `'Infrastructure Change ID'=\"${rootRequestId}\"`;
+        statusField = 'Change Request Status'
+        statusReasonField = 'Status Reason'
+    }
+    //Read instanceId from Root request
+    log.debug('Query root request for current status')
+    const rootRequest = await arquery.executeARQuery(rootForm, null, subQuery, [statusField, statusReasonField, companyField], clientConfig.options)
+    if (rootRequest && rootRequest.data && rootRequest.data.length > 0) {
+        const rootRecord = rootRequest.data[0]
+        const form = 'TMS:ConfigPhaseManagement'
+        log.debug('Query phase config for current phase')
+
+        let configQuery = `'Activation Status*'="${rootRecord[statusField]}" AND ('Company' = "${rootRecord[companyField]}" OR 'Company' = "- Global -") AND 'AppInstanceFormName' = "${rootForm}" AND 'Status' = "Active"`
+        if (rootRecord[statusReasonField]) {
+            configQuery = configQuery + ` AND 'Status Reason' = "${rootRecord[statusReasonField]}"`
+        } else {
+            configQuery = configQuery + ` AND 'Status Reason' = $NULL$`
+        }
+
+
+        const phaseRecords = await arquery.executeARQuery(form, undefined,
+            configQuery, 'InstanceId')
+        if (phaseRecords && phaseRecords.data && phaseRecords.data.length > 0) {
+            const phaseRecord = phaseRecords.data[0]
+            const phaseGuid = phaseRecord['InstanceId']
+            await activateTaskFlow(clientConfig, rootRequestInstanceId, phaseGuid)
+        }
+    }
+
+}
+
+async function activateTaskFlow(clientConfig, rootRequestInstanceId, phaseGuid) {
+    // Activate flow from here
     const form = 'TMS:Flow'
     const idField = 'Flow ID'
     const flowRequest = {
@@ -145,8 +190,9 @@ async function activateTaskFlow(clientConfig, rootRequestInstanceId) {
         "zTmpInternalCommand": "EVALUATE",
         "zTmpInternal" : "True"
     };
+
     const records = await arquery.executeARQuery(form, undefined,
-        `'RootRequestInstanceID'="${rootRequestInstanceId}" AND 'ParentID' = "${rootRequestInstanceId}" AND 'Predecessor Link' = "Start" AND 'Status' = "Pending" AND 'Sequence Mode' = "Yes"`, idField)
+        `'RootRequestInstanceID'="${rootRequestInstanceId}" AND 'ParentID' = "${rootRequestInstanceId}" AND 'Predecessor Link' = "Start" AND 'Status' = "Pending" AND 'Sequence Mode' = "Yes" AND 'Phase GUID' = "${phaseGuid}"`, idField)
     if (records && records.data) {
         for (let x=0; x<records.data.length; x++) {
             const record = records.data[x]

package/docs/openapi.json

@@ -2,7 +2,7 @@
     "openapi": "3.0.2",
     "info": {
         "title": "SMILEconnect",
-        "version": "1.41.4",
+        "version": "1.47.0",
         "contact": {
             "name": "manyos technology GmbH",
             "url": "https://manyos.it",
@@ -4330,6 +4330,208 @@
                     "required": false
                 }
             ]
+        },
+        "/customForms/{formAlias}": {
+            "get": {
+                "tags": [
+                    "CustomForms"
+                ],
+                "parameters": [
+                    {
+                        "name": "limit",
+                        "description": "limit the number of results returned",
+                        "schema": {
+                            "type": "integer"
+                        },
+                        "in": "query",
+                        "required": false
+                    },
+                    {
+                        "name": "offset",
+                        "description": "offset used for pagination together with limit",
+                        "schema": {
+                            "type": "integer"
+                        },
+                        "in": "query",
+                        "required": false
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseArray"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Receive all records of the custom from",
+                "description": "Will return all records that are found based on the defined base query and the set limits"
+            },
+            "post": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/CustomFormRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseSingle"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Create a new record",
+                "description": "Create a new record in the custom form"
+            },
+            "parameters": [
+                {
+                    "name": "formAlias",
+                    "description": "The configured alias name of the custom form.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
+        },
+        "/customForms/{formAlias}/search": {
+            "post": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/SearchRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseArray"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Execute a search in a custom form"
+            },
+            "parameters": [
+                {
+                    "examples": {
+                        "sample": {
+                            "value": "abc123"
+                        }
+                    },
+                    "name": "impersonateUser",
+                    "description": "If the clientConfig has the option allowDynamicImpersonate set to *true* then the URL Parameter *impersonateUser* can be used to determine the used Remedy User.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "name": "formAlias",
+                    "description": "The configured alias name of the custom form.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
+        },
+        "/customForms/{formAlias}/{id}": {
+            "get": {
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseSingle"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ]
+            },
+            "put": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/CustomFormRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseSingle"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ]
+            },
+            "parameters": [
+                {
+                    "name": "formAlias",
+                    "description": "The configured alias name of the custom form.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                },
+                {
+                    "examples": {
+                        "id": {
+                            "value": "ENV12345"
+                        }
+                    },
+                    "name": "id",
+                    "description": "The id record",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
         }
     },
     "components": {
@@ -16078,6 +16280,61 @@
                     "text": "Status Marked: Resolved by Allen",
                     "isPublic": true
                 }
+            },
+            "CustomFormRecord": {
+                "title": "Root Type for customFormRecord",
+                "description": "A record stored in a custom form. The fields (besides id) are samples and will depend on the config.",
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string"
+                    },
+                    "userId": {
+                        "type": "string"
+                    },
+                    "classId": {
+                        "type": "string"
+                    },
+                    "classTitle": {
+                        "type": "string"
+                    },
+                    "location": {
+                        "type": "string"
+                    },
+                    "startDate": {
+                        "type": "string"
+                    },
+                    "cost": {
+                        "format": "int32",
+                        "type": "integer"
+                    },
+                    "department": {
+                        "type": "string"
+                    }
+                },
+                "example": {
+                    "id": "00001",
+                    "userId": "Demo",
+                    "classId": "00001",
+                    "classTitle": "Managing Within the Law",
+                    "location": "Munich, Germany",
+                    "startDate": "Mon Nov 07 16:00:00 GMT 2005",
+                    "cost": 100,
+                    "department": "Sales"
+                }
+            },
+            "CustomFormRequest": {
+                "description": "Creates a new Record in a custum form",
+                "required": [
+                    "data"
+                ],
+                "type": "object",
+                "properties": {
+                    "data": {
+                        "$ref": "#/components/schemas/CustomFormRecord",
+                        "description": ""
+                    }
+                }
             }
         },
         "responses": {
@@ -16169,6 +16426,39 @@
                     }
                 },
                 "description": "Returns deletion confirmation for the requested item"
+            },
+            "CustomFormResponseSingle": {
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "data": {
+                                    "$ref": "#/components/schemas/CustomFormRecord"
+                                }
+                            }
+                        }
+                    }
+                },
+                "description": "Returns a single custom form record"
+            },
+            "CustomFormResponseArray": {
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "data": {
+                                    "type": "array",
+                                    "items": {
+                                        "$ref": "#/components/schemas/CustomFormRecord"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "description": "Returns an array of Custom Form Records"
             }
         },
         "securitySchemes": {
@@ -16214,6 +16504,10 @@
             "name": "CMDBObjects",
             "description": ""
         },
+        {
+            "name": "CustomForms",
+            "description": "All custom form requests"
+        },
         {
             "name": "AppConfig",
             "description": "Application Configuration"

package/docs/releases.md

@@ -2,6 +2,15 @@
 
 ## API 
 
+### 1.47.0 - 22.10.21
+Add xmlParser to scripts.
+See https://www.npmjs.com/package/fast-xml-parser
+
+Add customForms
+
+### 1.46.4 - 20.10.21
+Fix known issue: Check for activation Task Phase and activate if reached
+
 ### 1.46.3 - 18.10.21
 Fix issue: Task not activated when phase already active
 Known issues: Tasks might get activated early

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.46.3",
+  "version": "1.47.0",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {
@@ -23,6 +23,7 @@
     "express-rate-limit": "^5.2.6",
     "express-request-id": "^1.4.1",
     "express-validator": "^6.10.1",
+    "fast-xml-parser": "^3.20.3",
     "moment": "^2.29.1",
     "mongoose": "^5.12.5",
     "node-cache": "^4.2.1",