@manyos/smileconnect-api 1.28.0

package/docs/postinstall.md

@@ -0,0 +1,169 @@
+# 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/preinstall.md

@@ -0,0 +1,19 @@
+# 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/spec/index.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>SMILEconnect API Specification</title>
+    <!-- needed for adaptive design -->
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+    <!--
+    ReDoc doesn't change outer page styles
+    -->
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url='https://smileconnect.manyosdocs.de/openapi.json'></redoc>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+  </body>
+</html>

package/docs/staticman.yml

@@ -0,0 +1,110 @@
+# Name of the property. You can have multiple properties with completely
+# different config blocks for different sections of your site.
+# For example, you can have one property to handle comment submission and
+# another one to handle posts.
+# To encrypt strings use the following endpoint:
+# https://{STATICMAN API INSTANCE}/v3/encrypt/{TEXT TO BE ENCRYPTED}
+# {STATICMAN API INSTANCE} should match the `endpoint` in the theme config
+# file. It defaults to "staticman3.herokuapp.com".
+
+comments:
+  # (*) REQUIRED
+  #
+  # Names of the fields the form is allowed to submit. If a field that is
+  # not here is part of the request, an error will be thrown.
+  allowedFields: ["name", "email", "url", "message"]
+
+  # (*) REQUIRED WHEN USING NOTIFICATIONS
+  #
+  # When allowedOrigins is defined, only requests sent from one of the domains
+  # listed will be accepted. The origin is sent as part as the `options` object
+  # (e.g. <input name="options[origin]" value="http://yourdomain.com/post1")
+  # allowedOrigins: ["https://example.com"]
+
+  # (*) REQUIRED
+  #
+  # Name of the branch being used. Must match the `branch` in the theme config
+  # file.
+  branch: "master"   #  use "master" for user page or "gh-pages" for project pages
+
+  commitMessage: "New comment by {fields.name}"
+
+  # (*) REQUIRED
+  #
+  # Destination path (filename) for the data files. Accepts placeholders.
+  filename: "comment-{@timestamp}"
+
+  # The format of the generated data files. Accepted values are "json", "yaml"
+  # or "frontmatter"
+  format: "yaml"
+
+  # List of fields to be populated automatically by Staticman and included in
+  # the data file. Keys are the name of the field. The value can be an object
+  # with a `type` property, which configures the generated field, or any value
+  # to be used directly (e.g. a string, number or array)
+  generatedFields:
+    date:
+      type: "date"
+      options:
+        format: "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
+
+  # Whether entries need to be approved before they are published to the main
+  # branch. If set to `true`, a pull request will be created for your approval.
+  # Otherwise, entries will be published to the main branch automatically.
+  moderation: false
+
+  # Akismet spam detection.
+  # akismet:
+  #   enabled: true
+  #   author: "name"
+  #   authorEmail: "email"
+  #   authorUrl: "url"
+  #   content: "message"
+  #   type: "comment"
+
+  # Name of the site. Used in notification emails.
+  # name: "Your Site"
+
+  # Notification settings. When enabled, users can choose to receive notifications
+  # via email when someone adds a reply or a new comment. This requires an account
+  # with Mailgun, which you can get for free at http://mailgun.com.
+  # notifications:
+    # Enable notifications
+    # enabled: true
+
+    # (!) ENCRYPTED
+    #
+    # Mailgun API key
+    # apiKey: ""
+
+    # (!) ENCRYPTED
+    #
+    # Mailgun domain (encrypted)
+    # domain: ""
+
+  # (*) REQUIRED
+  #
+  # Destination path (directory) for the data files. Accepts placeholders.
+  path: "_data/comments/{options.slug}" # (default)
+
+  # Names of required files. If any of these isn't in the request or is empty,
+  # an error will be thrown.
+  requiredFields: ["name", "email", "message"]
+
+  # List of transformations to apply to any of the fields supplied. Keys are
+  # the name of the field and values are possible transformation types.
+  transforms:
+    email: md5
+
+  # reCAPTCHA (OPTIONAL)
+  # To enable reCAPTCHA:
+  # 1. Set `enabled` to `true`
+  # 2. Register your domain at https://www.google.com/recaptcha/ and choose reCAPTCHA V2
+  # 3. Uncomment `siteKey` and `secret` and fill them in with your values
+  reCaptcha:
+    enabled: false
+    #siteKey: ""
+    # ENCRYPT reCaptcha secret key using Staticman /encrypt endpoint
+    # i.e. https://{STATICMAN API INSTANCE}/v3/encrypt/{your-site-secret}
+    # For more information, visit https://staticman.net/docs/encryption
+    #secret: ""

package/docs/tags.html

@@ -0,0 +1,34 @@
+---
+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>

package/docs/workflow.md

@@ -0,0 +1,127 @@
+
+# SMILEconnect Workflow
+
+
+
+## Onboarding Wizard
+The SMILEconnect onboarding wizard handels everything you need for a new Vendor.
+
+The Activelinks running on the Form: MYS:SMILEconnect_NewVendor
+
+Create Entries in the following Forms:
+
+    COM:Company
+    SPG:Support Group
+    MYS:SMILEconnect_Vendors
+    SMT:SmartIT_ProviderAction_Template
+    SMT:SmartIT_ProviderAction_TemplateMapping
+    SMT:SmartIT_ProviderAction_Definition
+    SMT:SmartIT_ProviderAction_Definition_Properties
+
+
+For the modules **Change, Workorder, Incident** you just need to refresh the SmartIT metadata.
+
+For the module **Problem** you need to create an provider action in smart-it with the action name: SentToSMILEconnect_< Vendorname >
+
+
+## Workflow for Tickets
+The following illustration will show the Workflow for Tickets and Worklogs:
+
+![Workflow Illustration](img/workflow.png)
+
+
+## Workflow for Ticketregistration
+
+The following filters will register the ticket for SMILEconnect, and will send it to the vendor:
+
+**Incident:**
+
+    MYS:SMILEconnect_MarkasSMILEconnect_INC
+    MYS:SMILEconnect_MarkasSMILEconnect_INC_Error
+    MYS:SMILEconnect_MarkasSMILEconnect_INC_CheckVendors
+
+
+**Workorder:**
+
+    MYS:SMILEconnect_MarkasSMILEconnect_WOI
+    MYS:SMILEconnect_MarkasSMILEconnect_WOI_Error
+    MYS:SMILEconnect_MarkasSMILEconnect_WOI_CheckVendors
+
+**Change:**
+
+    MYS:SMILEconnect_MarkasSMILEconnect_CM
+    MYS:SMILEconnect_MarkasSMILEconnect_CM_CheckVendors
+    MYS:SMILEconnect_MarkasSMILEconnect_CM_Error
+
+**Problem:**
+
+    MYS:SMILEconnect_PBM_SetError
+    MYS:SMILEconnect_PBM_Actions
+    MYS:SMILEconnect_PBM_SetVendor
+    MYS:SMILEconnect_PBM_CheckVendor
+
+After the ticket is registert for SMILEconnect the following filters will monitor Modifications on the tickets and Worklogs:
+
+**Incident:**
+
+    MYS:SMILEconnect_Queue_INC_Modifed_Incident
+    MYS:SMILEconnect_Queue_INC_Modifed_WorkInfo
+
+**Workorder:**
+
+    MYS:SMILEconnect_Queue_WO_Modifed_WorkOrder
+    MYS:SMILEconnect_Queue_WO_Modifed_WorkInfo
+
+**Change:**
+
+    MYS:SMILEconnect_Queue_CHG_Modifed_Change
+    MYS:SMILEconnect_Queue_CHG_Modifed_WorkInfo
+
+**Problem:**
+
+    MYS:SMILEconnect_Queue_PBM_Modifed_Problem
+    MYS:SMILEconnect_Queue_PBM_Modifed_WorkInfo
+
+Additional there is the form "MYS:SMILEconnect_WorkInfo_Checker" which will check if the ticket is registered and the worklog type is correct.
+
+**Incident:**
+
+    MYS:SMILEconnect_WorkInfo_Checker_Check_Incident
+    MYS:SMILEconnect_WorkInfo_Checker_Check_Incident2
+
+**Workorder:**
+
+    MYS:SMILEconnect_WorkInfo_Checker_Check_WorkOrder
+    MYS:SMILEconnect_WorkInfo_Checker_Check_WorkOrder2
+
+**Change:**
+
+    MYS:SMILEconnect_WorkInfo_Checker_Check_Change
+    MYS:SMILEconnect_WorkInfo_Checker_Check_Change2
+
+**Problem:**
+
+    MYS:SMILEconnect_WorkInfo_Checker_Check_Problem
+    MYS:SMILEconnect_WorkInfo_Checker_Check_Problem2
+
+
+
+Workflow for ticket unregistration
+
+The unregistration will be handled by the following filters:
+
+**Incident:**
+
+    MYS:SMILEconnect_INC_UnregisterSMILEconnect
+
+**Workorder:**
+
+    MYS:SMILEconnect_WOI_UnregisterSMILEconnect
+
+**Change:**
+
+    MYS:SMILEconnect_CM_UnregisterSMILEconnect
+
+**Problem:**
+
+    MYS:SMILEconnect_PBM_UnregisterSMILEconnect

package/nodemon.json

@@ -0,0 +1,3 @@
+{
+  "ignore": ["conf/*.json", "Config"]
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@manyos/smileconnect-api",
+  "version": "1.28.0",
+  "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
+  "main": "app.js",
+  "scripts": {
+    "test-bak": "mocha --exit || true",
+    "start": "version=$npm_package_version node app.js",
+    "test": "jenkins-mocha --exit || true"
+  },
+  "author": "Robert Hannemann",
+  "license": "ISC",
+  "dependencies": {
+    "@manyos/logger": "^1.3.0",
+    "bunyan": "^1.8.15",
+    "bunyan-express-serializer": "^1.0.0",
+    "compression": "^1.7.4",
+    "cors": "^2.8.4",
+    "dotenv": "^4.0.0",
+    "express": "^4.17.1",
+    "express-fileupload": "^1.2.1",
+    "express-rate-limit": "^5.2.6",
+    "express-request-id": "^1.4.1",
+    "express-validator": "^5.3.1",
+    "moment": "^2.29.1",
+    "mongoose": "^5.12.1",
+    "node-cache": "^4.2.1",
+    "only": "0.0.2",
+    "p-limit": "^2.3.0",
+    "passport": "^0.4.1",
+    "passport-http-bearer": "^1.0.1",
+    "passport-jwt": "^4.0.0",
+    "request": "^2.88.2",
+    "request-promise": "^4.2.6",
+    "request-promise-native": "^1.0.9",
+    "socket.io": "^2.4.1",
+    "uuid": "^3.4.0",
+    "vm2": "^3.9.2"
+  },
+  "devDependencies": {
+    "chai": "^4.3.4",
+    "chai-http": "^4.3.0",
+    "jenkins-mocha": "^8.0.0",
+    "mocha": "^5.2.0"
+  }
+}