@manyos/smileconnect-api 1.28.0

package/docs/howto/worklog-attachment.md

@@ -0,0 +1,113 @@
+---
+layout: page
+title: Attachments
+subtitle: In this guide we'll show you how to save and read attachments from worklogs.
+use-site-title: true
+gh-badge: [star, fork, follow]
+gh-repo: daattali/beautiful-jekyll
+---
+
+In this guide we'll show you how to save and read attachments from worklogs.
+
+{: .box-note}
+**Note:** Each worklog can store one attachment. For multiple attachment you need multiple worklogs. The maximum size of the attachments is configured in BMC Remedy.
+
+To store an attachment you first need to create a worklog. The worklog contains an attachment url:
+
+{% highlight json linenos %}
+{
+    "data": {
+        "summary": "Implementation update",
+        "text": "The implementation will be completed soon. Please stand by.",
+        "id": "WLG000000001239"
+    },
+    "urls": [
+        {
+            "attachmentUrl": "/v1/incidents/INC000000000217/worklogs/WLG000000001239/attachment"
+        },
+        {
+            "self": "/v1/incidents/INC000000000217/worklogs/WLG000000001239"
+        }
+    ]
+}
+{% endhighlight %}
+
+This URL will be used to upload or download the attachment.
+
+# Add an attachment
+
+You will upload an attachment to the worklog.
+
+## Request Definition
+
+You need to do a POST request to the /v1/incidents/*incidentId*/worklogs/*worklogId*/attachment endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/incidents/*incidentId*/worklogs/*worklogId*/attachment
+
+*api-fqdn*: The hostname of your API Server
+
+*incidentId*: The id of the incident the worklog belongs to
+*worklogId*: The id of the worklog the attachment belongs to
+
+### Headers
+
+*Content-Type*: application/x-www-form-urlencoded
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Body
+
+Provide the attachment as application/x-www-form-urlencoded with the key "file".
+
+{: .box-warning}
+**Warning:** It is important to store the file in the key "file".
+
+### Sample Response
+
+POST:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000001240/attachment
+
+{% highlight json linenos %}
+"['WLG000000001240':'success']"
+{% endhighlight %}
+
+### Postman Sample Request / Response
+![architecure of isapi](../img/attachment-upload.png)
+
+# Read an attachment
+
+You will receive the attachment from the worklog.
+
+## Request Definition
+
+You need to do a GET request to the /v1/incidents/*incidentId*/worklogs/*worklogId*/attachment endpoint of your API
+
+### URL
+
+*URL*: https://*api-fqdn*/v1/incidents/*incidentId*/worklogs/*worklogId*/attachment
+
+*api-fqdn*: The hostname of your API Server
+
+*incidentId*: The id of the incident the worklog belongs to
+*worklogid*: The id of the worklog the attachment belongs to
+
+### Headers
+
+*Content-Type*: application/json
+
+### Authorization
+
+*Type*: Bearer
+
+Use your [API Token](token.md)
+
+### Sample Response
+
+GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533/attachment
+
+The file will be returned as application/octet-stream. The filename will be returned in the header Content-disposition. e.g. attachment; filename=90502081_l.jpg

package/docs/index.md

@@ -0,0 +1,41 @@
+---
+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/installation.md

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