Merge branch 'develop'

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.2.0] - 2022-03-10
+
+### Added
+
+- A test process with task and task screen allowing to select/upload an input file and calling the Datacap transaction.
+
+### Changed
+
+- Logging changed from applog to BAW's native logging.
+
 ## [1.1.0] - 2018-12-04
 
 ### Added

README.md

@@ -1,20 +1,54 @@
 # Datacap Utils Toolkit
 
-Datacap Utils Toolkit is a collection of re-usable artifacts useful
-for integration with IBM Datacap REST services from IBM Business Automation Workflow.
+Datacap Utils Toolkit is a collection of re-usable artifacts useful for integration with IBM Datacap REST services from IBM Business Automation Workflow.
 
-Wiki:
-<a href="https://github.ibm.com/apollo-dba-community/wiki/tree/master/baw/development/toolkits/datacap-utils-toolkit" target="_blank">https://github.ibm.com/apollo-dba-community/wiki/tree/master/baw/development/toolkits/datacap-utils-toolkit</a>
+Repository: <a href="https://github.com/apollo-business-automation/datacap-utils-toolkit" target="_blank">https://github.com/apollo-business-automation/datacap-utils-toolkit</a>
 
-Releases:
-<a href="https://github.ibm.com/apollo-dba-community/releases/tree/master/datacap-utils-toolkit" target="_blank">https://github.ibm.com/apollo-dba-community/releases/tree/master/datacap-utils-toolkit</a>
+API: <a href="https://apollo-business-automation.github.io/datacap-utils-toolkit" target="_blank">https://apollo-business-automation.github.io/datacap-utils-toolkit</a>
 
-API:
-<a href="https://pages.github.ibm.com/apollo-dba-community/api/datacap-utils-toolkit" target="_blank">https://pages.github.ibm.com/apollo-dba-community/api/datacap-utils-toolkit</a>
+## Description
 
-Repository:
-<a href="https://github.ibm.com/apollo-dba-community/datacap-utils-toolkit" target="_blank">https://github.ibm.com/apollo-dba-community/datacap-utils-toolkit</a>
+The toolkit provides integration with Transactions which are provided via the Datacap Web Services REST API documented at https://www.ibm.com/docs/en/datacap/9.1.9?topic=reference-datacap-web-services-rest-api-methods
 
-For changes see <a href="https://github.ibm.com/apollo-dba-community/datacap-utils-toolkit/blob/master/CHANGELOG.md" target="_blank">CHANGELOG</a>
+## Content of the toolkit
 
-For sample usage see artifacts beginning with *ZTest*
+- Service flows – wrappers for transaction API calls:
+  - Session Logon
+  - Session Logoff
+  - Transaction Start
+  - Transaction Execute
+  - Transaction End
+  - Transaction Set File
+  - Transaction Get File
+- Sample transaction flow for TravelDocs application which comes out-of-the-box with Datacap.
+- Recoding of files from UTF-16 LE BOM and UTF-8 BOM to UTF-8
+- Sample process with a task allowing:
+  - Upload and select document
+  - Select the transaction REST endpoint
+  - Call the transaction flow and see the output
+
+## Making Traveldocs Datacap application ready for transactions
+
+A slight adjustment of the Datacap application is needed in order to make it ready for transactions.
+
+![assets/update-datacap-application-export-path.png](assets/update-datacap-application-export-path.png)
+
+Instructions:
+- Open TravelDocs application in Datacap Studio.
+- Select and lock ruleset `ExportXML` for editing.
+- Navigate to the action following the screenshot below.
+- Update value of the action parameter on the right hand side to `@PILOT(BATCHDIR)`
+- Save the changes and publish the ruleset.
+
+## Usage
+
+- Import the release twx file into Workflow Center
+- Start process `ZTest Datacap Transaction`
+- Run task `ZTest Datacap Transaction` and open the task screen
+- Select one of the sample files already attached to the process instance or upload your file.
+- Review the REST endpoint configuration and update it if needed.
+- Select conversion from the proper UTF encoding. It may differ depending on on configuration of your Datacap.
+- Click the button to call the transaction.
+- See the output.
+
+You can adjust the REST endpoint in CSHS `ZTest Datacap TravelDocs Cshs Coach`. Edit the script called `Init`.

jsdoc-conf.json

@@ -1,6 +1,7 @@
 {
   "source": {
     "exclude": [
+      "./dist/",
       "./node_modules/"
     ],
     "includePattern": ".+\\.js(doc)?$",
@@ -11,7 +12,7 @@
     "recurse": true,
     "private": false,
     "destination": "./docs",
-    "template": "./node_modules/docdash"
+    "template": "./node_modules/tui-jsdoc-template"
   },
   "tags": {
     "allowUnknownTags": true
@@ -21,11 +22,20 @@
     "default": {
       "cleverLinks": true,
       "monospaceLinks": true,
-      "outputSourceFiles": false
-    }
-  },
-  "docdash": {
-    "search": true,
-    "collapse": true
+      "outputSourceFiles": false,
+      "staticFiles": {
+        "include": ["jsdoc-static/", "assets"]
+      }
+    },
+    "footerText": "Datacap Utils Toolkit",
+    "logo": {
+      "url": "",
+      "width": "150px",
+      "height": "13px",
+      "link": ""
+    },
+    "css": [
+      "styles/custom.css"
+    ]
   }
 }

jsdoc-static/styles/custom.css

@@ -0,0 +1,14 @@
+.logo {
+  display: none;
+}
+
+.main section article table td.name,
+.main section article table td.type,
+.main section article table td.attributes,
+.main section article table td.default {
+  max-width: initial;
+}
+
+.main section article h3.subsection-title {
+  padding-top: 0;
+}