@manyos/smileconnect-api 1.39.1 → 1.40.1

package/docs/general/config.md

@@ -1,201 +0,0 @@
----
-layout: page
-title: Config Options
-subtitle: The global configuration of our API
-use-site-title: true
----
-
-All of the following config options needs to be set as Environment Variables.
-
-## AR Server Connection
-
-### BASEURL
-
-Base URL of the used arrestfulapi
-
-Sample: 
-
-*BASEURL=http://localhost:8080*
-
-### AR_SERVER
-
-Remedy Server to connect to.
-
-Sample: 
-
-*AR_SERVER=pier1*
- 
-### AR_PORT
-
-Remedy Server TCP Port.
-
-Sample: 
-
-*AR_PORT=1234*
- 
-### AR_USER
-
-Remedy Admin User who is used for all queries.
-
-Sample: 
-
-*AR_USER=Demo*
-
-### AR_PASSWORD
-
-Remedy Admin User password.
-
-Sample: 
-
-*AR_PASSWORD=password*
- 
-## SSO Server Connection
-
-### SSO_PUBLIC_KEY
-
-Public Key used to validate JWT tokens.
-
-Sample:
-
-*SSO_PUBLIC_KEY=1635rN5xkbubgmuNQCnKKFu7OlAD3QxiDwecg1bJvFhJW9Qj5YhOwGuX5/4sOSCjmdTcKT1mCHL61FJ5mzxtbrct97zVwXmi4F4KDKj2PsW+qxUg0Jz/06iTVjtv2H1yBq1*
-
-### SSO_AUDIENCE
-
-Audience (Clients) which are allowed to use JWT tokens. This parameter is optional. If it is not set, no check against the JWT token will be performed.
-
-Sample:
-
-*SSO_AUDIENCE=gihub, jira*
-
-### SSO_ISSUER
-
-Issuer (SSO Server) of the JWT tokens.
-
-Sample:
-
-*SSO_ISSUER=https://sso.manyos.it/auth/realms/itsmproxy*
-
-### ADMIN_USERS
-
-List of users who are allowed to access /v1/appconfig endpoints.
-
-Sample:
-ADMIN_USERS=username1, username2
-
-### MASTER_CLIENTS
-
-List of clients that can act on behalf of other clients. 
-
-The URL Parameter *clientId* is used for this.
-
-Sample:
-MASTER_CLIENTS=idm,adminTool
-
-## Cache
-
-### CACHETTL_CMDB
-Interval in seconds in which before cached CMDB Data is deleted from the cache.
-
-Default: *600*
-
-Sample: 
-
-*CACHETTL_CMDB=2800*
-
-### CACHETTL_ORGDATA
-Interval in seconds in which before cached Org Data like People, Support Groups, Organisations are deleted from the cache.
-
-Default: *3600*
-
-Sample: 
-
-*CACHETTL_ORGDATA=7200*
-
-### CACHETTL_CHANGE
-Interval in seconds in which before cached Change Data is deleted from the cache.
-
-Default: *1*
-
-Sample: 
-
-*CACHETTL_CHANGE=600*
-
-### CACHETTL_INCIDENT
-
-Interval in seconds in which before cached Incident Data is deleted from the cache.
-
-Default: *1*
-
-Sample: 
-
-*CACHETTL_INCIDENT=600*
-
-### CACHETTL_WORKORDER
-
-Interval in seconds in which before cached Work Order Data is deleted from the cache.
-
-Default: *1*
-
-Sample: 
-
-*CACHETTL_WORKORDER=600*
-
-### CACHETTL_TASK
-
-Interval in seconds in which before cached Task Data is deleted from the cache.
-
-Default: *1*
-
-Sample: 
-
-*CACHETTL_TASK=600*
-
-## Loglevel
-
-Loglevel of the api. Defaults to *error*
-
-## RATE_LIMIT
-
-Defines how many API requests from a single IP are allowed within a 15min timeframe.
-
-Default *10000*
-
-Sample: 
-
-*RATE_LIMIT=600* 
-
-## LIMIT_DEFAULT
-
-Limits the resultsize of all queries against the Remedy Server. Sets a default that can be overwritten by requests. Can be used to prevent performance issues.
-Affects also relations. 
-
-Default *unlimited*
-
-Sample: 
-
-*LIMIT_DEFAULT=100* 
-
-## LIMIT_MAX
-
-Limits the resultsize of all queries against the Remedy Server. Defines a global maximum that can not be overwritten by requests. Will only be overwritten by Limits defined for certains clients. Can be used to prevent performance issues.
-Affects also relations. 
-
-Default *unlimited*
-
-Sample: 
-
-*LIMIT_MAX=100* 
-
-## MAX_HTTP_SOCKETS
-
-Defines how many TCP Sockets are used for outgoing connections. (Parallel connections to the Remedy REST API.)
-
-Reduce this parameter if you see ECONNRESET or socket hang up errors.
-
-This parameter has direct impact on performance.
-
-Default *10*
-
-Sample: 
-
-*MAX_HTTP_SOCKETS=15* 

package/docs/general/field-management.md

@@ -1,119 +0,0 @@
-# Client Config
-
-On a per client base it can be configured which fields are returned for each object and if a basequery is applied. This expose certain fields only dedicated clients. It also allows to define which rows a client can access. Clients are configured in conf/clients.json
-
-{% highlight json linenos %}
-[
-  {
-    "name": "jira",
-    "config": {
-      "options" : {
-        "dateFormat" : "dd.MM.yyyy HH:mm.ss",
-        "clientLimit": 100
-      },
-      "cmdbobject": {
-        "basequery": "'Data Set Id' = \"BMC.ASSET\" AND ('Mark As Deleted' = \"No\" OR 'Mark As Deleted' = $NULL$) AND 'Class Id' = \"BMC_COMPUTERSYSTEM\"",
-        "fields": [
-          "Instance Id",
-          "Tag Number",
-          "Name",
-          "AssetLifecycleStatus",
-          "Category",
-          "Item",
-          "Type",
-          "Availability",
-          "Confidentiality",
-          "Integrity",
-          "Authenticity",
-          "Model Number",
-          "Class Id",
-          "Reconciliation Identity"
-        ]
-      },
-      "orgdata": {
-        "basequeryPeople": "'Profile Status' = \"Enabled\"",
-        "basequeryOrganisation": "'Status'=\"Enabled\"",
-        "basequerySupportGroup": "'Status'=\"Enabled\""
-      },
-      "change": {
-        "fields": [
-          "Infrastructure Change ID",
-          "Categorization Tier 1",
-          "Categorization Tier 2",
-          "Categorization Tier 3",
-          "Product Cat Tier 1",
-          "Product Cat Tier 2",
-          "Product Cat Tier 3",
-          "Product Name (2)",
-          "Description",
-          "Detailed Description",
-          "Status Reason",
-          "Change Request Status",
-          "Requested Start Date",
-          "Requested End Date",
-          "Scheduled Start Date",
-          "Scheduled End Date",
-          "Support Group ID",
-          "Support Group ID 2",
-          "Customer Person ID"
-        ],
-        "constants" : [
-          {"name": "Location Company", "value" : "Calbro Services"},
-          {"name": "Company", "value" : "Calbro Services"},
-          {"name": "RequesterLoginID", "value" : "Allen"}
-        ]
-      }
-    }
-  }
-]
-{% endhighlight %}
-    
-# Field Mappings
-
-Field mappings are configured in conf/mapping.json and are used globally for all clients.
-
-{% highlight json linenos %}
-{
-  "cmdbobject":[
-    {"oldName":"Instance Id", "newName" : "id"},
-    {"oldName":"Tag Number", "newName" : "tagNumber"},
-    {"oldName":"Name", "newName" : "name"},
-    {"oldName":"AssetLifecycleStatus", "newName" : "assetlifecycleStatus"},
-    {"oldName":"Category", "newName" : "category"},
-    {"oldName":"Item", "newName" : "item"},
-    {"oldName":"Type", "newName" : "type"},
-    {"oldName":"Availability", "newName" : "availability"},
-    {"oldName":"Confidentiality", "newName" : "confidentiality"},
-    {"oldName":"Integrity", "newName" : "integrity"},
-    {"oldName":"Authenticity", "newName" : "authenticity"},
-    {"oldName":"Model Number", "newName" : "model"},
-    {"oldName":"Class Id", "newName" : "classId"},
-    {"oldName":"Reconciliation Identity", "newName" : "reconId"}
-  ],
-  "change":[
-    {"oldName":"Infrastructure Change ID", "newName" : "id"},
-    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
-    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
-    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
-    {"oldName":"Product Cat Tier 1", "newName" : "prodCat1"},
-    {"oldName":"Product Cat Tier 2", "newName" : "prodCat2"},
-    {"oldName":"Product Cat Tier 3", "newName" : "prodCat3"},
-    {"oldName":"Product Name (2)", "newName" : "productName"},
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
-    {"oldName":"Status Reason", "newName" : "statusReason"},
-    {"oldName":"Change Request Status", "newName" : "status"},
-    {"oldName":"Requested Start Date", "newName" : "requestedStartDate"},
-    {"oldName":"Requested End Date", "newName" : "requestedEndDate"},
-    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
-    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
-    {"oldName":"Support Group ID", "newName" : "managerGroup"},
-    {"oldName":"Support Group ID 2", "newName" : "coordinatorGroup"},
-    {"oldName":"Customer Person ID", "newName" : "customerId"}
-  ],
-  "newChange":[
-    {"oldName":"Description", "newName" : "summary"},
-    {"oldName":"TemplateID", "newName" : "template"}
-  ]
-}
-{% endhighlight %}

package/docs/general/release-notes.md

@@ -1,9 +0,0 @@
----
-layout: page
-title: Architecture
-subtitle: How it fits together
-use-site-title: true
-version: 1.2.3
----
-
-Release Notes