@manyos/smileconnect-api 1.57.2 → 1.58.1

package/app.js

@@ -328,6 +328,7 @@ app.use('/v1/customForms/:formAlias', async function(req, res, next) {
         configName: 'custom_' + formMapping.formName,
         mapping: formMapping.mapping
     }
+    req.globalScriptParams.formConfig = req.formConfig
     req.parentEventBase = 'customForm'
     next();
 }, customFormRoutes);

package/conf/clients.json

@@ -2294,8 +2294,13 @@
           },
           "POST": {
             "preMapping": [],
-            "postMapping": [],
-            "afterExecution": []
+            "postMapping": [
+              "joinSetId",
+              "setAssetId"
+            ],
+            "afterExecution": [
+              "getAssetId"
+            ]
           }
         }
       },

package/conf/customFormMapping.json

@@ -22,6 +22,7 @@
   "customFormTest": {
     "formName": "MYS:CustomFormTest",
     "mapping": {
+      "Request ID": "id",
       "Short Description": "shortDescription",
       "Submitter": "submitter",
       "Status": "status"

package/controller/customFormController.js

@@ -28,6 +28,7 @@ function getRecords(formConfig, clientConfig, includeString, customOptions, glob
 
 async function createRecord(formConfig, clientConfig, data, globalScriptParams) {
     const idField = getIdField(formConfig)
+    globalScriptParams.idField = idField;
     const allScripts = clientConfig[formConfig.configName].scripts;
     let scripts
     if (allScripts) {
@@ -39,8 +40,6 @@ async function createRecord(formConfig, clientConfig, data, globalScriptParams)
         await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId, globalScriptParams);
     }
 
-    const requestType = formConfig.requestType;
-
     const mapping = formConfig.mapping;
     log.debug('mapping', mapping);
 
@@ -56,33 +55,25 @@ async function createRecord(formConfig, clientConfig, data, globalScriptParams)
     const result = await arquery.createEntry(formConfig.formName, data, clientConfig.options)
 
     log.debug('RecordCreateResult', result.data);
-    let recordCreateId = Object.values(result)[0];
+    if (!globalScriptParams.id && Object.values(result)[0]) {
+        globalScriptParams.id = Object.values(result)[0];
+    }
     //Find change id
-    if (!recordCreateId) {
-        recordCreateId = data[idField]
+    if (!globalScriptParams.id) {
+        globalScriptParams.id = data[idField]
     }
-    if (!recordCreateId) {
+    if (!globalScriptParams.id) {
         throw ({message: `Id of new record could not be determined. Please provide ${idField} for join forms.`})
     }
 
-    log.error(idField)
-    log.error(recordCreateId)
-
-    //const query = `'${idField}'=\"${recordCreateId}\"`;
+    log.debug(idField)
+    log.debug(globalScriptParams.recordCreateId)
 
-    /*const resultInterfaceCreate = await arquery.executeARQuery(formConfig.formName, null, query, 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});
-    }*/
-    globalScriptParams.id = recordCreateId
     //run afterExecution
     if (scripts && scripts.afterExecution) {
         await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId, globalScriptParams);
     }
-    return recordCreateId;
+    return globalScriptParams.id;
 }
 
 function queryRecords(formConfig, clientConfig, query, mapping, customFields, customOptions, includeString, globalScriptParams) {

package/controller/scriptController.js

@@ -2,6 +2,7 @@ const path = require('path');
 const log = require('@manyos/logger').setupLog('SMILEcatalog_' + path.basename(__filename));
 const adapterFoundation = require('@manyos/adapter-foundation');
 const fs = require('fs');
+const { v4 } = require('uuid');
 
 const basePath = 'conf';
 const basePathGlobalScripts = basePath + '/scripts';
@@ -84,7 +85,8 @@ async function executeCode(code, requestData, params, logStream, executedByScrip
         script:executeScriptByScript,
         globalScriptParams,
         env: process.env,
-        fetch:fetch
+        fetch:fetch,
+        uid:v4
     };
 
     sandbox.executedByScript = executedByScript === true;

package/docs/adapter.md

@@ -243,8 +243,8 @@ The id of the attachment field
 
 Full example:
 ```javascript
-const file = adapter.remedy.getAttachment('CHG:WorkLog', 'CWL000000002484', '1000000353')
-const fileName = file.name
+const file = await adapter.remedy.getAttachment('CHG:WorkLog', 'CWL000000002484', '1000000353')
+const fileName = file.fileName
 const fileData = file.data
 ```
 
@@ -282,6 +282,132 @@ const file = {
 await adapter.remedy.setAttachment('CHG:WorkLog', 'CWL000000002484', '1000000353', file)
 ```
 
+### getMetadata
+
+```javascript
+async getMetadata(form)
+```
+
+Parameter:
+
+* form (string):
+
+Optional. If provided all fields of the form are returned. If not provided all forms are returned.
+
+Sample response formList
+```javascript
+[
+    "AAS:Activity",
+    "AAS:Activity2",
+    "AAS:ActivityInterface",
+    "AAS:ActivityInterface_Create",
+    "AAS:ActivityTaskJoin",
+    "AAS:AuditFilters",
+    "AAS:AuditLog",
+    "AAS:AuditLogSystem",
+    "AAS:CFG Notification Rules",
+    "AAS:CFG Rules",
+    "AAS:ConfigurationTicketNumGenerator",
+    "AAS:LoadActivity",
+    "AAS:LoadCFGNotificationRules",
+    "AAS:LoadCFGRules",
+    "AAS:LoadTemplate"
+]
+```
+Sample response fieldList
+```javascript
+[
+    {
+        "entryMode": "System",
+        "fieldId": 1,
+        "fieldLimit": {
+            "QBEMatch": 1,
+            "charMenu": "",
+            "dataType": 4,
+            "fullTextOption": 0,
+            "lengthUnits": 0,
+            "maxLength": 15,
+            "menuStyle": 1,
+            "pattern": "",
+            "storageOptionForCLOB": 0
+        },
+        "name": "Request ID",
+        "type": "CharacterField",
+        "valueMapping": null
+    },
+    {
+        "entryMode": "Required",
+        "fieldId": 2,
+        "fieldLimit": {
+            "QBEMatch": 1,
+            "charMenu": "",
+            "dataType": 4,
+            "fullTextOption": 0,
+            "lengthUnits": 0,
+            "maxLength": 254,
+            "menuStyle": 2,
+            "pattern": "",
+            "storageOptionForCLOB": 0
+        },
+        "name": "Creator",
+        "type": "CharacterField",
+        "valueMapping": null
+    },
+    {
+        "entryMode": "System",
+        "fieldId": 3,
+        "fieldLimit": null,
+        "name": "Create Date",
+        "type": "DateTimeField",
+        "valueMapping": null
+    },
+    {
+        "entryMode": "Optional",
+        "fieldId": 4,
+        "fieldLimit": {
+            "QBEMatch": 1,
+            "charMenu": "",
+            "dataType": 4,
+            "fullTextOption": 0,
+            "lengthUnits": 0,
+            "maxLength": 254,
+            "menuStyle": 1,
+            "pattern": "",
+            "storageOptionForCLOB": 0
+        },
+        "name": "Assigned To",
+        "type": "CharacterField",
+        "valueMapping": null
+    },
+    {
+        "entryMode": "System",
+        "fieldId": 5,
+        "fieldLimit": {
+            "QBEMatch": 1,
+            "charMenu": "",
+            "dataType": 4,
+            "fullTextOption": 0,
+            "lengthUnits": 0,
+            "maxLength": 254,
+            "menuStyle": 1,
+            "pattern": "",
+            "storageOptionForCLOB": 0
+        },
+        "name": "Last Modified By",
+        "type": "CharacterField",
+        "valueMapping": null
+    },
+    {
+        "entryMode": "System",
+        "fieldId": 6,
+        "fieldLimit": null,
+        "name": "Modified Date",
+        "type": "DateTimeField",
+        "valueMapping": null
+    }
+]
+```
+
 ### Options
 
 * limit

package/docs/releases.md

@@ -1,6 +1,11 @@
 # Release Notes
 
-## API 
+## API
+### 1.58.0 - 31.03.22
+Add uid() to scripts
+In customForms(create) make globalScripts.id changeable
+Add getMetaData to Remedy Adapter
+Fix: Issue with special characters in fieldlist of Remedy Adapter Search function
 
 ### 1.57.2 - 28.03.22
 Fix problem with custom ids on custom forms
@@ -9,8 +14,8 @@ Fix problem with custom ids on custom forms
 Remove misleading error from CustomFormMappings
 
 ### 1.57.0 - 25.03.22
-
 Add impersonate to update requests.
+Add user parameter to globalScriptParams
 Impersonate works not on the following requests:
 - Add/Read Attachments
 - Ticket/CI Relations

package/docs/scripts.md

@@ -119,8 +119,27 @@ Global script params are set by the application and handed over to the script. T
 
 **sourceData**: Contains the original body for PUT/POST request. This can be used scripts to access custom data that was removed during mapping.
 
-**user**: Contains the full configuration of the client. The attribute user.config.options.impersonateUser might be overwritten by the dynamic passed value if user.config.options.allowDynamicImpersonate ist set to true. 
+**user**: Contains the full configuration of the client. The attribute user.config.options.impersonateUser might be overwritten by the dynamic passed value if user.config.options.allowDynamicImpersonate ist set to true.
 
+**formConfig**: Contains the configuration of the cutstom form. *Only available for custom forms*
+
+e.g.
+```json
+"formConfig": {
+    "formName": "AST:ComputerSystem",
+    "configName": "custom_AST:ComputerSystem",
+    "mapping": {
+      "Name": "name",
+      "DatasetId": "dataSetId",
+      "Asset ID+": "id",
+      "Reconciliation Identity": "reconId",
+      "Instance Id": "instanceId",
+      "Short Description": "shortDescription"
+    }
+}
+```
+
+Full example:
 ```json
 {
     "query": {
@@ -230,6 +249,15 @@ See https://www.npmjs.com/package/node-fetch for details.
 
 Allows to make adapter calls. [See details](../configuration/adapter.md)
 
+## uid
+
+Generated a new unique id. [See details](https://www.npmjs.com/package/uuid#uuidv4options-buffer-offset)
+
+```javascript
+const myInstanceId = uid();
+requestData['Instance Id'] = myInstanceId;
+```
+
 # Returning values
 
 Values can be returned with the function *resolve()*

package/package.json

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

package/util/responsehandler.js

@@ -78,7 +78,9 @@ function eventQueueHandler(req, res, next) {
                     res.set('Content-disposition', 'attachment; filename=' + req.downloadResult.fileName);
                     res.status(200).send(req.downloadResult.data);
                 } else {
+                    log.debug('send http repsonse', req.result)
                     res.status(req.responseStatus || 200).json(req.result)
+                    log.debug('send http done')
                 }
             }).catch(error => {
                 next(error);