@manyos/smileconnect-api 1.38.1 → 1.39.1

package/controller/ticketController.js

@@ -14,12 +14,12 @@ const mappingUtil = require('../util/mappingUtil');
 
 const ticketCache = new CacheService(process.env.CACHETTL_TICKETS || 1); // Create a new cache service instance
 
-function getTickets(ticketConfig, config, includeString, customOptions) {
+function getTickets(ticketConfig, config, includeString, customOptions, globalScriptParams) {
     let query = '1=1';
-    return queryTickets(ticketConfig, config, query, null, null, customOptions, includeString);
+    return queryTickets(ticketConfig, config, query, null, null, customOptions, includeString, globalScriptParams);
 }
 
-async function createTicket(ticketConfig, clientConfig, data) {
+async function createTicket(ticketConfig, clientConfig, data, globalScriptParams) {
     const scripts = clientConfig[ticketConfig.requestType].scripts.POST;
 
     //run preScripts
@@ -39,7 +39,7 @@ async function createTicket(ticketConfig, clientConfig, data) {
 
     //run postScripts
     if (scripts && scripts.postMapping) {
-        await scriptController.runScripts(scripts.postMapping, data, clientConfig.clientId);
+        await scriptController.runScripts(scripts.postMapping, data, clientConfig.clientId, globalScriptParams);
     }
 
     const result = await arquery.createEntry(ticketConfig.forms.new, data, clientConfig.options)
@@ -50,12 +50,6 @@ async function createTicket(ticketConfig, clientConfig, data) {
     const resultInterfaceCreate = await arquery.executeARQuery(ticketConfig.forms.new, null, "'1'=\"" + ticketCreateId + "\"", ticketConfig.ticketIdField, clientConfig.options)
     if (resultInterfaceCreate.data && Array.isArray(resultInterfaceCreate.data) && resultInterfaceCreate.data.length && resultInterfaceCreate.data[0][ticketConfig.ticketIdField]) {
         const ticketId = resultInterfaceCreate.data[0][ticketConfig.ticketIdField];
-        //todo fix create worklog
-        /*createWorklog(clientConfig, ticketId, 'Created', 'Incident ' + CONSTANTS.TEXT_CREATED_BY, false).then(function (worklogResult) {
-            log.debug('Worklog', worklogResult);
-        }).catch(function (error) {
-            log.error('HPD:Worklog creation error', error)
-        });*/
     } else {
         log.error('Cannot create Ticket', resultInterfaceCreate);
         throw({message: 'Cannot create Ticket', details : resultInterfaceCreate});
@@ -63,12 +57,12 @@ async function createTicket(ticketConfig, clientConfig, data) {
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {
-        await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId);
+        await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId, globalScriptParams);
     }
     return resultInterfaceCreate;
 }
 
-function queryTickets(ticketConfig, clientConfig, query, mapping, customFields, customOptions, includeString) {
+function queryTickets(ticketConfig, clientConfig, query, mapping, customFields, customOptions, includeString, globalScriptParams) {
     log.debug('config', ticketConfig);
     const includeArray = getIncludeArray(includeString);
     log.debug('ticketConfig.requestType', ticketConfig.requestType);
@@ -101,7 +95,7 @@ function queryTickets(ticketConfig, clientConfig, query, mapping, customFields,
         if (result && result.data && result.data.length) {
             let x = 0;
             for (x=0; x< result.data.length; x++) {
-                const ticket = await handleTicket(ticketConfig, result.data[x], mapping, clientConfig, includeArray, globalRelationObjects);
+                const ticket = await handleTicket(ticketConfig, result.data[x], mapping, clientConfig, includeArray, globalRelationObjects, globalScriptParams);
                 tickets.push(ticket);
             }
         }
@@ -113,7 +107,7 @@ function queryTickets(ticketConfig, clientConfig, query, mapping, customFields,
     });
 }
 
-async function handleTicket(ticketConfig, ticket, mapping, clientConfig, includeArray, globalRelationObjects) {
+async function handleTicket(ticketConfig, ticket, mapping, clientConfig, includeArray, globalRelationObjects, globalScriptParams) {
     const allScripts = clientConfig[ticketConfig.requestType].scripts;
     let scripts = [];
     if (allScripts) {
@@ -136,7 +130,7 @@ async function handleTicket(ticketConfig, ticket, mapping, clientConfig, include
         const preScripts = scripts.preMapping;
         try {
             for (let x = 0; x < preScripts.length; x++) {
-                const result = await scriptController.executeScript(preScripts[x], ticket, null, clientConfig.clientId);
+                const result = await scriptController.executeScript(preScripts[x], ticket, null, clientConfig.clientId, globalScriptParams);
             }
         } catch (error) {
             throw error;
@@ -160,7 +154,7 @@ async function handleTicket(ticketConfig, ticket, mapping, clientConfig, include
         const postScripts = scripts.postMapping;
         try {
             for (let x = 0; x < postScripts.length; x++) {
-                const result = await scriptController.executeScript(postScripts[x], ticket, null, clientConfig.clientId);
+                const result = await scriptController.executeScript(postScripts[x], ticket, null, clientConfig.clientId, globalScriptParams);
             }
         } catch (error) {
             throw error;
@@ -260,7 +254,7 @@ function checkFieldsProblem(problem, globalRelationObjects) {
 }
 
 
-async function getTicket(ticketConfig, config, id, mapping, includeString) {
+async function getTicket(ticketConfig, config, id, mapping, includeString, globalScriptParams) {
     let query = '1=2';
     const requestType = ticketConfig.requestType;
     if (requestType === 'incident') {
@@ -272,18 +266,18 @@ async function getTicket(ticketConfig, config, id, mapping, includeString) {
     } else if (requestType === 'workOrder') {
         query = `'Work Order ID'=\"${id}\"`;
     }
-    const returnValue = await queryTickets(ticketConfig, config, query, mapping, null, null, includeString);
+    const returnValue = await queryTickets(ticketConfig, config, query, mapping, null, null, includeString, globalScriptParams);
     const ticket =  returnValue.data[0];
     return {data: ticket, included: returnValue.included};
 }
 
-async function updateTicket(ticketConfig, clientConfig, id, ticketData) {
+async function updateTicket(ticketConfig, clientConfig, id, ticketData, globalScriptParams) {
     const scripts = clientConfig[ticketConfig.requestType].scripts.PUT;
     const fields = clientConfig[ticketConfig.requestType].fields
 
     //run preScripts
     if (scripts && scripts.preMapping) {
-        await scriptController.runScripts(scripts.preMapping, ticketData, clientConfig.clientId);
+        await scriptController.runScripts(scripts.preMapping, ticketData, clientConfig.clientId, globalScriptParams);
     }
 
     log.debug(clientConfig[ticketConfig.requestType]);
@@ -298,10 +292,10 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData) {
 
     //run postMapping
     if (scripts && scripts.postMapping) {
-        await scriptController.runScripts(scripts.postMapping, ticketData, clientConfig.clientId);
+        await scriptController.runScripts(scripts.postMapping, ticketData, clientConfig.clientId, globalScriptParams);
     }
 
-    const ticket = await getTicket(ticketConfig, myClientConfig, id, myMapping);
+    const ticket = await getTicket(ticketConfig, myClientConfig, id, myMapping, undefined, globalScriptParams);
     log.debug('Ticket to Update', ticket);
     //todo Abfangen wenn getTicket nichts liefert.
     const update = await arquery.updateEntry(ticketConfig.forms.regular, ticket.data.internalId, ticketData);
@@ -314,12 +308,12 @@ async function updateTicket(ticketConfig, clientConfig, id, ticketData) {
     return update;
 }
 
-function searchTicket(ticketConfig, clientConfig, searchString, fields, options, includeString) {
+function searchTicket(ticketConfig, clientConfig, searchString, fields, options, includeString, globalScriptParams) {
     const mapping = config.getMapping(ticketConfig.requestType);
     const mappedString = searchUtil.applyMapping(searchString, mapping);
     const customFields = searchUtil.getCustomFields(clientConfig[ticketConfig.requestType].fields, mapping, fields);
     options.sort = searchUtil.applySortMapping(options.sort, mapping);
-    return queryTickets(ticketConfig, clientConfig, mappedString, null, customFields, options, includeString);
+    return queryTickets(ticketConfig, clientConfig, mappedString, null, customFields, options, includeString, globalScriptParams);
 }
 
 module.exports = {

package/controller/ticketWorkLogController.js

@@ -11,7 +11,7 @@ const scriptController = require('./scriptController');
 
 const ticketCache = new CacheService(process.env.CACHETTL_TICKETS || 1); // Create a new cache service instance
 
-async function createWorklog(ticketConfig, clientConfig, ticketId, summary, text, isPublic) {
+async function createWorklog(ticketConfig, clientConfig, ticketId, summary, text, isPublic, globalScriptParams) {
     const scripts = clientConfig[ticketConfig.requestTypeWorkLog].scripts.POST;
     const mapping = config.getMapping(ticketConfig.requestTypeWorkLog);
     const fields = clientConfig[ticketConfig.requestTypeWorkLog].fields;
@@ -61,21 +61,21 @@ async function createWorklog(ticketConfig, clientConfig, ticketId, summary, text
 
     //run preScripts
     if (scripts && scripts.preMapping) {
-        await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId);
+        await scriptController.runScripts(scripts.preMapping, data, clientConfig.clientId, globalScriptParams);
     }
 
     data = mappingUtil.applyMapping2Remedy(data, mapping, clientConstants, fields);
 
     //run postScripts
     if (scripts && scripts.postMapping) {
-        await scriptController.runScripts(scripts.postMapping, data, clientConfig.clientId);
+        await scriptController.runScripts(scripts.postMapping, data, clientConfig.clientId, globalScriptParams);
     }
 
     const result = arquery.createEntry(ticketConfig.forms.workLog, data, clientConfig.options)
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {
-        await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId);
+        await scriptController.runScripts(scripts.afterExecution, data, clientConfig.clientId, globalScriptParams);
     }
 
     return result;
@@ -102,7 +102,7 @@ function getAttachmentFieldId(attachmentId) {
     return attachmentFieldId;
 }
 
-async function getWorklogs(ticketConfig, clientConfig, ticketId, mapping) {
+async function getWorklogs(ticketConfig, clientConfig, ticketId, mapping, globalScriptParams) {
     let query = '1=2';
     const requestType = ticketConfig.requestType;
     if (requestType === 'incident') {
@@ -114,11 +114,11 @@ async function getWorklogs(ticketConfig, clientConfig, ticketId, mapping) {
     } else if (requestType === 'workOrder') {
         query = `'Work Order ID'=\"${ticketId}\"`;
     }
-    const returnValue = await queryWorklogs(ticketConfig, clientConfig, query, mapping);
+    const returnValue = await queryWorklogs(ticketConfig, clientConfig, query, mapping, globalScriptParams);
     return {data: returnValue.data};
 }
 
-async function getWorklog(ticketConfig, clientConfig, ticketId, worklogId, mapping) {
+async function getWorklog(ticketConfig, clientConfig, ticketId, worklogId, mapping, globalScriptParams) {
     let query = '1=2';
     const requestType = ticketConfig.requestType;
     if (requestType === 'incident') {
@@ -130,7 +130,7 @@ async function getWorklog(ticketConfig, clientConfig, ticketId, worklogId, mappi
     } else if (requestType === 'workOrder') {
         query = `'Work Order ID'=\"${ticketId}\" AND '1' = \"${worklogId}\"`;
     }
-    const returnValue = await queryWorklogs(ticketConfig, clientConfig, query, mapping);
+    const returnValue = await queryWorklogs(ticketConfig, clientConfig, query, mapping, globalScriptParams);
     const urls = {
         "attachmentUrl":
             `${ticketConfig.baseURI}/${ticketId}/worklogs/${worklogId}/attachments/1`
@@ -147,7 +147,7 @@ async function getWorklog(ticketConfig, clientConfig, ticketId, worklogId, mappi
     return {data: returnValue.data[0], urls};
 }
 
-async function queryWorklogs(ticketConfig, clientConfig, query, mapping) {
+async function queryWorklogs(ticketConfig, clientConfig, query, mapping, globalScriptParams) {
     const baseQuery = clientConfig[ticketConfig.requestTypeWorkLog].basequery;
     const fields = clientConfig[ticketConfig.requestTypeWorkLog].fields;
     const key = 'worklog' + baseQuery + fields.toString() + query;
@@ -169,12 +169,12 @@ async function queryWorklogs(ticketConfig, clientConfig, query, mapping) {
                 const element = result.data[x];
                 //run preScripts
                 if (scripts && scripts.preMapping) {
-                    await scriptController.runScripts(scripts.preMapping, result.data, clientConfig.clientId);
+                    await scriptController.runScripts(scripts.preMapping, result.data, clientConfig.clientId, globalScriptParams);
                 }
                 applyMapping(element, mapping, 'Entry ID');
                 //run postScripts
                 if (scripts && scripts.postMapping) {
-                    await scriptController.runScripts(scripts.postMapping, result.data, clientConfig.clientId);
+                    await scriptController.runScripts(scripts.postMapping, result.data, clientConfig.clientId, globalScriptParams);
                 }
             }
             return {

package/docs/_config.yml

@@ -24,6 +24,8 @@ navbar-links:
   Resources:
     - Architecture: "general/architecture"
     - Configuration: "general/config"
+    - Scripts: "configuration/scripts"
+    - Adapter: "configuration/adapter"
     - Specification: "spec/index.html"
   How-Tos:
     - Authenticate: "howto/token"

package/docs/configuration/adapter.md

@@ -0,0 +1,317 @@
+---
+layout: page
+title: Adapter
+subtitle: Talk to the outside world
+use-site-title: true
+bigimg: /img/gb-isapi.jpg
+toc: true
+---
+
+# Introduction
+
+Adapter are used to integrate with different systems. SMILEconnect comes with a flexible adapter architecture. Multiple types of adapters can be used and also multiple adapters of the same type can be configured. This can be useful if you need to interact e.g. with two different LDAP Systems.
+
+# Adapter Configuration
+
+Adapter are configured in the file *adapterConfig.js* in the root of the conf folder. Within the configuration file the variable *env* can be used to access system environment variables. E.g. *env.AR_USER* reflects the value of the system variable *AR_USER*.
+
+For security, it is advised to store confidential information, like passwords, in the environment variables and not in the configuration file itself. 
+
+Configuration example:
+```javascript
+const adapterParams = {
+    remedy: {
+        type: "remedy",
+        arServer: env.AR_SERVER,
+        arUser: env.AR_USER,
+        arPassword: env.AR_PASSWORD,
+        arPort: env.AR_PORT,
+        rapiUri: env.RAPI_URL,
+        cacheTime: env.AR_CACHE_TTL,
+        limitDefault: env.LIMIT_DEFAULT || 100,
+        limitMax: env.LIMIT_MAX
+    },
+    ldap: {
+        type: "ldap",
+        ldapUrl: env.LDAP_URL,
+        ldapBind: env.LDAP_BIND,
+        ldapSecret: env.LDAP_SECRET
+    },
+    ldapIDM: {
+        type: "ldap",
+        ldapUrl: env.LDAP_IDM_URL,
+        ldapBind: env.LDAP_IDM_BIND,
+        ldapSecret: env.LDAP_IDM_SECRET
+    },
+    smileconnect: {
+        type: "SMILEconnect",
+        clientId: env.SC_CLIENT,
+        secret: env.SC_SECRET,
+        ssoUrl: env.SC_SSO_URL,
+        smileConnectUrl: env.SC_SMILECONNECT_URL
+    }
+};
+
+// noinspection JSAnnotator
+return adapterParams;
+```
+
+The different Adapter and their configuration values are described in detail below.
+
+## Remedy
+
+The Remedy Adapter is used to connect to BMC Remedy Action Request Servers. It allows you to create, query and update records.
+
+### Configuration values
+
+**arServer**: The name of the arsystem server. e.g. ars1.mydomain.com
+
+**arUser**: The user which is used to connect to the remedy server. E.g. Allen
+
+**arPassword**: The password of the ar user.
+
+**arPort**: The port of the arsystem server. e.g. 5142. Use 0 if you want to a portmapper.
+
+**rapiUri**: The URL of the RAPI Server wich is used as middleware to connect to the arsystem server. e.g. https://rapi.mydomain.com
+
+**cacheTime**: The default time in seconds in which the result of queries is stored in a cache. This is used to increase performance dramatically. Defaults to 300s. 
+
+**limitDefault**: The default limit of records retrieved in a query. This value is used whenever no value is specified. Can be overwritten in queries.
+
+**limitMax**: The maximum number of records retrieved in a query. This parameter can be used to enforce a limit. The limit can not be overwritten by queries.
+
+### Functions
+
+#### Search
+
+```javascript
+async function search(form, query, fields, options)
+```
+
+Parameter:
+
+* form (string):
+
+The form used to query data. e.g. CTM:People
+
+* query (string):
+
+The query used in the form. e.g. 'Remedy Login ID' = "Allen"
+
+* fields (comma separated list):
+
+The fields to be returned by the query. e.g. "Full Name, Remedy Login ID, First Name, Last Name, Department"
+
+Full example:
+```javascript
+const result = await adapter.remedy.search(
+    "CTM:People",
+    "'Remedy Login ID' = \"Allen\"",
+    "Full Name, Remedy Login ID, First Name, Last Name, Department");
+```
+
+Will return an object with a data array and some meta data.
+
+```javascript
+{
+    "status": "success",
+    "query": "'Remedy Login ID' = \"Allen\"",
+    "server": "arserver:51423",
+    "form": "CTM:People",
+    "runtime": 106,
+    "dataSize": 1,
+    "data": [
+        {
+            "Person ID": "PPL000000000013",
+            "Remedy Login ID": "Allen",
+            "Department": "Customer Service",
+            "Full Name": "Allen Allbrook",
+            "Last Name": "Allbrook",
+            "First Name": "Allen"
+        }
+    ]
+}
+```
+
+
+#### Create
+
+```javascript
+async function create(form, entry, options)
+```
+
+Parameter:
+
+* form (string):
+
+The form in which a new record is created. e.g. CTM:People
+
+* entry (object):
+
+The entry object that is ceated. 
+
+e.g.
+
+```javascript
+{
+    "Source Keyword": "SMILEcatalog",
+    "Company": "Calbro Services",
+    "AppRequestSummary": "New Request from SMILEcatalog",
+    "TitleInstanceID": "SRGAA5V0GEfds7LO5YL6Q945Z", 
+    "Login ID": "Allen"
+}
+```
+
+Full example:
+
+```javascript
+const settings = {
+    "createForm":"SRM:RequestInterface_Create",
+    "entry": {
+        "Source Keyword": "SMILEcatalog",
+        "Company": "Calbro Services",
+        "AppRequestSummary": "New Request from SMILEcatalog",
+        "TitleInstanceID": "SRGAA5V0GEfds7LO5YL6Q945Z",
+        "Login ID": "Allen"
+    }
+};
+//Create Service Request
+const resultCreate = await adapter.remedy.create(settings.createForm, settings.entry);
+```
+
+Will return return the id of the created record. e.g. REQ00000002893
+
+#### Options
+
+* limit
+
+The maximum number of records that should be returned by this query. e.g. 5. Use this value to increase performance or to overwrite a default limit.
+
+* offset
+
+Use together with limit to allow pagination. e.g. limit=10 & offset=10
+
+* dateFormat
+
+The format in which dates are returned.
+
+* sort
+
+The fields that are to sort the result on the remedy server. Use 1 for ascending and -1 for descending order.
+
+e.g.
+```javascript
+{
+    "Name": 1,
+    "Status": -1
+}
+```
+
+* countOnly (only search)
+
+Can be used to retrieve only the size of the results without any payload. This improves performance.
+
+Full example:
+
+```javascript
+const options = {
+    limit: 100,
+    offset: 100,
+    dafeFormat: "yyyy-MM-dd HH:mm:ss.SSSZ",
+    sort: {
+        "Name": 1,
+        "Status": -1
+    }
+}
+```
+
+## LDAP
+
+
+### Configuration values
+
+* ldapUrl
+
+The connection URL of the LDAP Server. e.g. ldap://ldap.forumsys.com:389
+
+* ldapBind
+
+The Bind DN to authenticate with. e.g. cn=smilecatalog-user,dc=example,dc=com
+
+* ldapSecret
+
+The secret to use with the Bind DN. e.g. password
+
+### Functions
+
+
+#### Search
+
+```javascript
+async search(base, options)
+```
+Runs a query against the ldap Server.
+
+Parameter:
+
+* base
+
+A DN string to start.
+
+* options
+
+Options for the search. Like filters and returned attributes. See http://ldapjs.org/client.html for more details.
+
+```javascript
+const opts = {
+  filter: '(&(l=Seattle)(email=*@foo.com))',
+  scope: 'sub',
+  attributes: ['dn', 'sn', 'cn']
+};
+```
+
+Full example:
+
+```javascript
+const base = "dc=example,dc=com";
+const options = {
+    attributes: ['dn', 'sn', 'cn'],
+    scope: "sub",
+    filter: "sn=Riemann"
+}
+const result = await adapter.ldap.search(base, options);
+resolve(result);
+```
+
+Returns an array of records. e.g.
+
+```javascript
+[
+    {
+        "dn": "uid=riemann,dc=example,dc=com",
+        "controls": [],
+        "cn": "Bernhard Riemann",
+        "sn": "Riemann"
+    }
+]
+```
+
+## SMILEconnect
+
+The SMILEconnect Adapter can be used to do calls against SMILEconnect. It will act as it is called externally.
+
+### Configuration values
+
+**smileConnectUrl**: The url of your SMILEconnect installation e.g. https://smileconnect.mydomain.io
+
+**ssoUrl**: The url of the oidc identity provider. e.g. https://sso.mydomain.io/auth/realms/smileconnect
+
+**clientId**: The name of the client that is used to connect to SMILEconnect
+
+**secret**: The secret of the client. e.g. jd92hd-03283d-2293s-232
+
+### Functions
+
+The SMILEconnect adapter is an open source project. 
+
+[Visit the project homepage for details]https://github.com/manyosit/smileconnect-client