@manyos/smileconnect-api 1.41.4 → 1.42.0

package/util/mappingUtil.js

@@ -91,6 +91,81 @@ function getFieldsForCreate(mapping, mappingNew, clientFields) {
     return targetList;
 }
 
+function applyCustomFormMapping(object, mapping, requestIdField) {
+    //Apply mapping
+    Object.keys(mapping).forEach(remedyName => {
+        try {
+            const mappedName = mapping[remedyName]
+            Object.defineProperty(object, mappedName, Object.getOwnPropertyDescriptor(object, remedyName));
+            delete object[remedyName];
+        } catch (e) {
+            log.error('mappingError', e)
+        }
+    })
+    if (requestIdField) {
+        log.debug('Delete requestIdField', requestIdField);
+        delete object[requestIdField];
+    }
+}
+
+function applyCustomFormMapping2Remedy(entryData, mapping, constants, fields) {
+    //delete unmapped entries
+    const mappedFields = Object.values(mapping)
+
+    Object.keys(entryData).forEach(function (objectKey) {
+
+        const found = mappedFields.find(element => {
+            return element === objectKey;
+        });
+
+        if (found == null || found=== undefined) {
+            log.debug('delete', objectKey)
+            delete entryData[objectKey];
+        }
+    });
+
+    //Apply mapping
+    Object.keys(mapping).forEach(remedyName => {
+        try {
+            const mappedName = mapping[remedyName]
+            Object.defineProperty(entryData, remedyName, Object.getOwnPropertyDescriptor(entryData, mappedName));
+            delete entryData[mappedName];
+        } catch (e) {
+            log.error('mappingError', e)
+        }
+    })
+
+    //remove fields if no access
+    log.debug('Check for fields in', fields);
+    if (fields && Array.isArray(fields)) {
+        Object.keys(entryData).forEach(objectKey => {
+            const found = fields.find(element => {
+                return element === objectKey;
+            });
+            log.debug(`Found ${objectKey} in fields:`, found)
+
+            if (found == null || found=== undefined) {
+                log.debug('delete not accessible field', objectKey)
+                delete entryData[objectKey];
+            }
+        });
+    }
+
+    //add constant values (defaults)
+    if (constants && Array.isArray(constants) && constants.length) {
+
+        constants.forEach(function (element) {
+            log.debug('add constant', element);
+            try {
+                entryData[element.name] = element.value;
+            } catch (e) {
+                log.error(e);
+            }
+        });
+    }
+    return entryData;
+}
+
 module.exports = {
-    applyMapping2Remedy, getFieldsForCreate
+    applyMapping2Remedy, getFieldsForCreate, applyCustomFormMapping, applyCustomFormMapping2Remedy
 }

package/util/paramHelper.js

@@ -38,6 +38,7 @@ function applyMapping(object, mapping, requestIdField) {
         delete object[requestIdField];
     }
 }
+
 module.exports = {
     getIncludeArray, getLinkCI, applyMapping
 };

package/util/schemas/fieldMappingSchema.js

@@ -41,6 +41,33 @@ const fieldMappingItemSchema = {
     }*/
 };
 
+const customFormMappingItemSchema = {
+    'data' : {
+        in: ['body'],
+        exists: {
+            errorMessage: 'Is required'
+        }
+    },
+    'data.formName': {
+        in: ['body'],
+        exists: {
+            errorMessage: 'Is required'
+        },
+        isString : {
+            errorMessage: 'Needs to be a string'
+        }
+    },
+    'data.mapping': {
+        in: ['body'],
+        exists: {
+            errorMessage: 'Is required'
+        },
+        isObject : {
+            errorMessage: 'Needs to be an Object'
+        }
+    }
+};
+
 const CMDBCreateDataSchema = {
     'classId' : {
         in: ['body'],
@@ -222,5 +249,5 @@ const fieldMappingSchema = {
 };
 
 module.exports = {
-    fieldMappingSchema, fieldMappingItemSchema, validateCMDBDataSchema, CMDBCreateDataSchema
+    fieldMappingSchema, fieldMappingItemSchema, validateCMDBDataSchema, CMDBCreateDataSchema, customFormMappingItemSchema
 };

package/util/searchUtil.js

@@ -11,6 +11,17 @@ function applyMapping(searchString, mapping) {
     return mappedString;
 }
 
+function applyCustomFormMapping(searchString, mapping) {
+    log.debug('Apply mapping on', searchString, mapping);
+    let mappedString = searchString;
+    const remedyFields = Object.keys(mapping)
+    remedyFields.forEach(remedyField => {
+        mappedString = mappedString.replace(new RegExp("'" + mapping[remedyField] + "'", 'g'), "'" + remedyField + "'");
+    });
+    log.debug('Mapped searchString', mappedString);
+    return mappedString;
+}
+
 function applySortMapping(sortOptions, mapping) {
     log.debug('Apply mapping on', sortOptions, mapping);
     if (sortOptions == null || sortOptions == undefined) {
@@ -28,6 +39,24 @@ function applySortMapping(sortOptions, mapping) {
     return mappedOptions;
 }
 
+function applyCustomFormSortMapping(sortOptions, mapping) {
+    log.debug('Apply mapping on', sortOptions, mapping);
+    if (sortOptions == null || sortOptions == undefined) {
+        return sortOptions;
+    }
+    const mappedOptions = {};
+    Object.keys(sortOptions).forEach(key => {
+        const remedyFields = Object.keys(mapping)
+        remedyFields.forEach(remedyField => {
+            if (mapping[remedyField] === key) {
+                mappedOptions[remedyField] = sortOptions[key];
+            }
+        });
+    });
+    log.debug('Mapped sortOptions', mappedOptions);
+    return mappedOptions;
+}
+
 function getCustomFields(clientFields, mapping, requestedFields) {
     log.debug('get custom fields', requestedFields);
     log.debug('clientFields fields', clientFields);
@@ -48,6 +77,26 @@ function getCustomFields(clientFields, mapping, requestedFields) {
     }
 }
 
+function getCustomFormFields(clientFields, mapping, requestedFields) {
+    log.debug('get custom fields', requestedFields);
+    log.debug('clientFields fields', clientFields);
+    //return clientFields if null
+    if (requestedFields === null || requestedFields === undefined || !Array.isArray(requestedFields)) {
+        log.debug('no custom fields requested. return clientFields');
+        return clientFields;
+    } else {
+        const customFields = [];
+        const mappedFields = mapCustomFormFieldNames(requestedFields, mapping);
+        mappedFields.forEach(requestedField => {
+            if (clientFields.includes(requestedField)) {
+                customFields.push(requestedField);
+            }
+        });
+        log.debug('customFields', customFields);
+        return customFields;
+    }
+}
+
 function mapFieldNames(customFields, mapping) {
     log.debug('Apply field mapping on', customFields, mapping);
     const mappedFields = [];
@@ -62,6 +111,21 @@ function mapFieldNames(customFields, mapping) {
     return mappedFields;
 }
 
+function mapCustomFormFieldNames(customFields, mapping) {
+    log.debug('Apply field mapping on', customFields, mapping);
+    const mappedFields = [];
+    customFields.forEach(customField => {
+        const remedyFields = Object.keys(mapping)
+        remedyFields.forEach(remedyField => {
+            if (mapping[remedyField] === customField) {
+                mappedFields.push(remedyField);
+            }
+        });
+    });
+    log.debug('mapped fields', mappedFields);
+    return mappedFields;
+}
+
 function mapFieldName(customField, mapping) {
     const result = mapFieldNames([customField], mapping);
     if (result !== null && result !== undefined) {
@@ -144,5 +208,8 @@ module.exports = {
     getCustomFields,
     mapFieldName,
     mapFieldNameReverse,
-    applyMapping2record
+    applyMapping2record,
+    applyCustomFormMapping,
+    applyCustomFormSortMapping,
+    getCustomFormFields
 };

package/docs/old/getting-started.md

@@ -1,19 +0,0 @@
----
-layout: page
-title: Getting started
-subtitle: Every beginning is hard. We want to help you get started as fast as possible. Follow these guides to learn the basics-
----
-
-First things first:
-* [How to get a token](howto/token.md)
-* [Setup your client and mapping config](howto/sample-config.md)
-
-Now start with the basic stuff:
-* [How to read an incident](howto/incidents.md#read-an-incident)
-* [How to create an incident](howto/incidents.md#create-an-incident)
-* [How to update an incident](howto/incidents.md#update-an-incident)
-
-Read on for more advanced usage:
-* [How to handle worklogs](./howto/incident-worklogs.md)
-* [How to deal with attachments](./howto/worklog-attachment.md)
-

package/docs/old/index.md

@@ -1,41 +0,0 @@
----
-layout: page
-title: SMILEconnect documention
-subtitle: Learn all about manyos ITSM API on these pages
-use-site-title: true
-bigimg: /img/gb-isapi.jpg
----
-
-Our ITSM API creates a RESTful layer on-top of BMCs ITSM Suite. It allows you to expose all of your services with an easy and powerful REST-API. You can perform create, read and update operations on Incidents, Changes, Problems, Work Orders, Tasks and Assets. With no need for customization.
-
-[Get our API Framework here](https://manyos.it/isapi)
-
-# General
-
-If you're new to our API visit our [Getting Started Guide](getting-started.md)
-
-# Config Options
-
-All config options can be set as Environment Variables.
-
-[See all config options here](general/config.md)
-
-# Architecture
-
-Learn how the different parts work together in out [Architecture Overview](general/architecture.md)
-
-# Access to Objects and Fields
-
-Access to Objects (e.g. Incidents, Changes, ...) and Fields (e.g. Summary, ...) is granted per User.
-
-A global mapping is applied to all fields before they are returned.
-
-[Learn more about clients and fields](general/field-management.md)
-
-# Events
-
-[See all events here](eventlog/events.md)
-
-# Workflow
-
-[Learn more about the Remedy Workflow](workflow.md)

package/docs/old/installation.md

@@ -1,123 +0,0 @@
-
-# Install SMILEconnect
-
-The complete the installation of SMILEconnect you need to complete the following 4 steps:
-
-1.  Import Deployment Package
-2.  Create Remedy User for SMILEconnect
-3.  Setup Docker Container
-4.  Import AI Jobs
-
-The following sections will guide you through those steps. 
-
-## Import Deployment Package
-
-Import the deployment zip file to the RDA (Remedy Deployment) Console and deploy the file, using your Midtier
-It will import the Workflow Objects and Remedy Group needed.
-
-Steps:
-
-    1. Login to  Midtier as an Administrator
-    2. Open Remedy Deployment Console (Applications -> AR System Administration -> AR System Deployment Management Console)
-    3. Import the zip file (Transfer Package -> Import)
-    4. Deploy the Package (Operations -> Deploy)
-    
-    
-
-## Create User
-
-- Open "CTM:People" Form and create a new user with the name "SMILEconnect" with administrative permissions, fixed license for all needed modules, and "Master"-permissions for each.
-- Open "User" Form, search for the user "SMILEconnect" and add the group "MYSTicketBroker" to the permissions. 
-
-## Setup Docker Container
-Create Folder smileconnect and create the file docker-compose.yml in the newly created folder.
-Create a new subfolder conf and place your client.json and mapping.json to this folder
-
-
-
-Example file:
-
-    version: '3.4' 
-    services: 
-       api: 
-            image: manyos/smileconnect-api
-            restart: always 
-            environment: 
-                - LOGLEVEL=DEBUG 
-                - BASEURL=http://rapi:8080
-                - AR_SERVER=<AR Server>
-                - AR_PORT=<AR PORT>
-                - AR_USER=<YOUR SMILECONNECT USER>
-                - AR_PASSWORD=<THE PASSWORD FOR THE SMILECONNECT USER>
-                - CACHETLL_CMDB=166
-                - CACHETTL_ORGDATA=719
-                - CACHETTL_CHANGE=1
-                - CACHETTL_INCIDENT=1
-                - CACHETTL_TASK=5
-                - EVENTLOG_ENABLE=true
-                - FEDERATED_BASE_URI=<URL TO SMARTIT>
-                - SSO_PUBLIC_KEY=<YOUR SSO PUBLIC KEY>
-                - ADMIN_USERS=<COMMASEPERATED LIST OF ADMIN USERS (GUI Users)>
-            volumes:
-                - conf:/home/node/app/conf
-    
-      
-       eventmanager: 
-            image: manyos/smileconnect-eventmanager 
-            restart: always 
-            environment: 
-              - LOGLEVEL=DEBUG
-              - MQ_CONNECTION=amqp://rabbitmq:8sj238sk2nsu82@pier1
-              - MQ_QUEUE=test
-              - ISAPI_CLIENT_ID=<SSO USER FOR EVENTMANAGER>
-              - ISAPI_CLIENT_SECRET=<SECRET FOR THE EVENTMANAGER>
-              - ISAPI_URI=<URL TO YOUR SMILECONNECT REST API; Example: https://isapi.port.manyos.io >
-              - ISAPI_SSO=<URL TO YOUR SSO REALM; Example: https://sso.manyos.it/auth/realms/itsmproxy >
-              - BASEURL=http://rapi:8080
-              - AR_SERVER=<AR Server>
-              - AR_PORT=<AR PORT>
-              - AR_USER=<YOUR SMILECONNECT USER>
-              - AR_PASSWORD=<THE PASSWORD FOR THE SMILECONNECT USER>
-              - SSO_PUBLIC_KEY=<YOUR SSO PUBLIC KEY>
-            volumes:
-              - conf:/home/node/app/conf
-
-       rapi: 
-            image: manyos/rapi
-            restart: always
-            environment: 
-              - GRAILS_OPTS=-XX:MaxPermSize=1024m -Xmx4096M -server 
-
-      
-       gui: 
-            image: manyos/smileconnect-gui
-            restart: always
-            environment: 
-               - REACT_APP_API_URL=<URL TO YOUR SMILECONNECT REST API; Example: https://isapi.port.manyos.io/ >
-               - REACT_APP_SSO_URL=<URL TO YOUR SSO REALM; Example: https://sso.manyos.it/auth/realms/itsmproxy >
-               - REACT_APP_GUI_URL=<URL TO YOUR GUI; Example: https://isapi-gui-1808.port.manyos.io/ >
-               - REACT_APP_WIZZARD_URL=<URL TO YOUR MIDTIER; Example: https://midtier.port.manyos.io/arsys/forms/arserver/MYS:SMILEconnect_NewVendor >
-               - REACT_APP_TOKEN_REFRESHTIME=30
-            ports:
-              - 3003:80
-            volumes:
-              - conf:/home/node/app/conf
-
-
-Save the file and start the stack using with docker-compose up -d
-
-
-
-## Import AI Jobs
-
-  Import the AI Job/Tranfsformation Templates for each module.
-  After importing change the connection parameter to your AR Server.
-    
-    TIP: In kettle options (Tools->Opions) disable the option:
-    Replace existing objects on open/import.
-    Your connection will not be replaced on future imports 
-
-
-
-
-

package/docs/old/postinstall.md

@@ -1,169 +0,0 @@
-# Post installation configuration
-
-## Configure SmartIT
-
-### Display Vendor Fields
-It is good practice to display the vendor fields
-        
-     Vendor
-     Vendor Ticket Number
-     
-for the modules you are using SMILEconnect. 
-
-To display them follow those steps:
-    
-    1. Login to SmartIT as an Administrator
-    2. Open Screen Configuration page
-    3. Open the module and add the fields
-    
-For more information about this, check BMC documentation at https://docs.bmc.com
-
-### Add Actions
-
-If you want to be able to send "de-registration" events to your partner systems, you need to create a new 
-Provider Action for each module.
-
-    1. Login as Administrator to Midtier
-    2. Open Form "SMT:SmartIT_Provider Action Template Configuration"
-    3. Click new
-    4. Set name to SMILEconnect_<Module>_Unregister for example: SMILEconnect_INC_Unregister
-    5. Select your Source Form (HPD:Help Desk, CHG:Infrastructure Change, WOI:WorkOrder, TMS:Task)
-    6. Select the Data Source for your Source Form: (incident, change, workorder, task)
-    7. Set Status to Online
-    8. Click "New Mapping"
-    9. Set Mapping Type to "Input"
-    10. Select z1D Action as Source Field
-    11. Click Save
-    12. Click "New Mapping"
-    13. Set Mapping Type to "Input"
-    14. Select the Ticket Number (Incident Number, Infrastructure Change ID, Work Order ID) as Source Field
-    15. Click Save
-    
-    16. Login to Smart IT as Administrator
-    17. Open Screen Configuration page
-    18. Click Add / Remove Actions for the module
-    19. Click Add Action
-    20. Set Template Name to the previous created name SMILEconnect_<Module>_Unregister
-    21. For z1D Action set "Default Value" "UnregisterSMILEconnect"
-    22. For Ticket Number set "From Ticket" "id"
-
-
-Optional:
-
-    Associate with Vendor Fields
-        Open Field Configuration select Associate Action, and select the action you created before.
-    
-    
-For more information about provider actions visit https://docs.bmc.com
-
-
-
-
-
-##Configure SMILEconnect
-
-To Configure SMILEconnect we provide SMILEconnect GUI. 
-This GUI will use the SMILEconnect REST API to configure clients and mappings.
-
-It will provide the following functions:
-
-- copy a client
-- remove a client
-- configure mapping (add mapping, edit mapping and remove mapping)
-- configure a client (add fields & constants, edit fields  & constants, remove fields  & constants)
-- export settings
-- import settings
-
-
-### Configure mapping 
-
-To Configure Field mapping you need to open "Field Mapping" from the Navigation Menu on the left hand side.
-
-On the top menu you can choose for which module you want to configure the mapping.
-
-
-#### Configure mapping for ITSM modules
-
-If you select the modules Incident, Change, Problem , WorkOrder, Task a sub top menu will open, and you can select the action for which you want to configure the mapping.
-
-For example: Incident, New Incident, Worklog
-
-    1. To add a new mapping click the "+" button in the right upper corner.
-    2. Speficy the Remedy Field Name as "Form Name" and the Mapping Name of your choice as "API Name"
-    3. Select ok to save the mapping.
- 
-#### Configure mapping for CMDB classes
-
-If you need to specify a mapping for any class other than BaseElement you can use the "Add Class +" and add the Class of your choice.
-You just need to Enter the Name without prefix. For example "ComputerSystem"
-Then specify the fields the same way as above.
-
-To remove a class, just hide the trash icon next to the class name.
-
-
-### Configure clients 
-
-You find a list of clients the navigation menu on the left hand side.
-you can copy a client to a new one, delete a client directly in the menu by using the buttons next to the name.
-
-#### Configure permissions for ITSM modules
-
-On the top navigation bar you can select the menu you need to configure. In the sub navigation bar you see the available sections.
-You can add new fields or constants using the "+" button on the upper right corner of the table, or edit and remove fields and constants using the pencil or trash buttons.
-
-    
-#### Configure permissions for CMDB classes
-If you need to specify a fields for any class other than BaseElement you can use the "Add Class +" and add the Class of your choice.
-You just need to Enter the Name without prefix. For example "ComputerSystem"
-Then specify the fields the same way as above.
-
-To remove a class, just hide the trash icon next to the class name.
-
-### Configure client using ITSM Wizard
-If you need to send tickets to this client use the ITSM Wizard to configure this client in itsm and smartit.
-
-Select the ITSM Wizard in the left hand navigation to open the ITSM Wizard. 
-Specify the 
-
-    Vendor 
-    Vendor Organization 
-    Vendor Group 
-for the ITSM Suite and choose for which modules you want to enable this client. 
-
-### Export / Import Mapping and Clients
-
-Open Export / Import Section on the left and use the download button to save the config to your local drive.
-Use the upload button to upload a local file to smileconnect.
-
-## Use Custom AI Job Templates
-
-We provide custom AI Job templates for outbound communication for
-incident
-change
-worklog
-problem
-
-those templates include error handling. For each module we provide two transformation.
-One for Ticket Modify Event, one for the Worklog Event
-
-This section will explain the usage of the template using change as example.
-
-    1. Save the template with a different name before you use it
-    2. open Get CHG_Modified Events and speficy the VendorID in the Qualification
-    3. open Set URLs and change Url to your SSO URL and UrlCHG to your Endpoint
-    4. Open Change Lookup step and provide all Fields in the return from lookup table section you need
-    5. Implement your mapping if needed. Use Map Status and Map Prio as samples.
-    6. If you are using OAUTH2 you can use the HTTP Post Step to get the token.
-    7. Open the "Create Ouput" to create the output you need (json sample is included)
-    8. "Rest Client" Step is a sample for the output, change it to the step you need. Rest, Soap, etc.
-    9. There is a dummy step, for the update, if the ticket has already been send.  
-    
-
-
-
-
-
-
-
-
-

package/docs/old/preinstall.md

@@ -1,19 +0,0 @@
-# Prepare your environment for the SMILEconnect installation
-
-# SSO environment
-
-1. If you are already running an OIDC System create a new realm for SMILEconnect. if not you can setup for example Keykloak.
-2. For each of your interfaces create a client with credential
-3. Create a client with credentials for the SMILEconnect-Eventmanager
-4. Create a client with implicit flow for SMILEconnectGUI and set the web-origin URL to your SMILEconnectGUI URL 
-5. Get the public certificate from your SSO Realm 
-
-
-# Docker
-1. Setup docker and docker-compose on your liunx server
-2. Setup your server to access https://\*.docker.io/\* and https://\*.docker.com/\*
-3. Login to the docker-environment with the docker-hub user we provided to you.
-   
-        docker login <username>
-        
-

package/docs/old/tags.html

@@ -1,34 +0,0 @@
----
-layout: page
-title: 'Tag Index'
----
-
-{%- capture site_tags -%}
-    {%- for tag in site.tags -%}
-        {{- tag | first -}}{%- unless forloop.last -%},{%- endunless -%}
-    {%- endfor -%}
-{%- endcapture -%}
-{%- assign tags_list = site_tags | split:',' | sort -%}
-
-{%- for tag in tags_list -%}
-    <a href="#{{- tag -}}" class="btn btn-primary tag-btn"><i class="fa fa-tag" aria-hidden="true"></i>&nbsp;{{- tag -}}&nbsp;({{site.tags[tag].size}})</a>
-{%- endfor -%}
-
-<div id="full-tags-list">
-{%- for tag in tags_list -%}
-    <h2 id="{{- tag -}}" class="linked-section">
-        <i class="fa fa-tag" aria-hidden="true"></i>
-        &nbsp;{{- tag -}}&nbsp;({{site.tags[tag].size}})
-    </h2>
-    <div class="post-list">
-        {%- for post in site.tags[tag] -%}
-            <div class="tag-entry">
-                <a href="{{ post.url | relative_url }}">{{- post.title -}}</a>
-                <div class="entry-date">
-                    <time datetime="{{- post.date | date_to_xmlschema -}}">{{- post.date | date: "%B %d, %Y" -}}</time>
-                </div>
-            </div>
-        {%- endfor -%}
-    </div>
-{%- endfor -%}
-</div>