Integrating Transact Explorer with External DMS

IRIS API acts as an adapter between Transact Explorer (TE) and any external system to minimize the components used for integration. It provides endpoints and operations exposed to TE that allow vendor-agnostic consumption. The external Document Management system (DMS) integration offers search, download, generate, and upload features.

To enable integration with TE, configure the below values in config.properties (tb-server.war\WEB-INF\classes\config.properties) or add them as JVM option in the startup bat files.

com.temenos.te.api.externalDMS.baseUrl=http://localhost:9089/irf-document-services/v1.0.0
com.temenos.te.api.externalDMS.documentSearchApiPath=/documents
com.temenos.te.api.externalDMS.documentDownloadApiPath=/documents/{id}/download
com.temenos.te.api.externalDMS.documentUploadApiPath=/documents
com.temenos.te.api.externalDMS.documentDefinitionApiPath=/document-definitions/
com.temenos.te.api.externalDMS.documentGenerateApiPath=/documents/generation
com.temenos.te.api.externalDMS.enquiriesEnabledForDocumentGenerate=SECTOR|CUSTOMER.INFO|CUSTOMER.SCV|CUSTOMER.LIST

The following section helps you to enable the document search, download, generate and upload features.

Searching a Document

To enable document search,

1. Copy the below files in to t24lib > EB_API.jar.
   • Nofile routine class (NOFILE.EXTERNAL.DMS.SEARCH)
   • Component class
2. Create a STANDARD.SELECTION record with the same field names as document-keys available in the external DMS.

   

3. Create an enquiry based on NoFile record created above, specific to the search type available in the external DMS.

   

   The field names in the enquiry definition should be the same as the field names in irf-document-services.war.
   

   

4. Launch the newly created enquiry in TE (ENQ EXTERNAL.DMS.SEARCH) to verify the results.
   
   

Downloading a Document

To download a document, perform the following steps:

1. Define a drill down as shown below for the EXTERNAL.DMS.STMT.DOCUMENT.SEARCH enquiry.

   

2. Launch ENQ EXTERNAL.DMS.STMT.DOCUMENT.SEARCH and verify if the drill down is available in the page.

   

   On clicking the drilldown, the document gets downloaded within the same page as shown below.

   

3. Create an enquiry (ENQUIRY I EXTERNAL.DMS.PHOTO.DISPLAY) to display images in TE from the external DMS.

   

4. Launch ENQ EXTERNAL.DMS.PHOTO.DISPLAY to display the customer photo.
   

5. Create an enquiry record (ENQUIRY I EXTERNAL.DMS.SIGNATURE.DISPLAY) to display the signature.

   

6. Launch ENQ EXTERNAL.SIGNATURE.DISPLAY to display the customer signature.

   

Generating Documents

Configure config.properties in tb-server.war or add as JVM option to enable the generate option for the enquiries in the properties file.

• For specific enquiries, mention the enquiry names by using the pipe symbol (|) separated as shown below:

  com.temenos.te.api.externalDMS.enquiriesEnabledForDocumentGenerate=SECTOR|CUSTOMER.INFO|CUSTOMER.SCV|CUSTOMER.LIST

• For all enquiries, specify as shown below:

  com.temenos.te.api.externalDMS.enquiriesEnabledForDocumentGenerate=ALL

  

Uploading Documents

To enable the document upload feature,

1. Create a new datatype for upload as shown below and attach it to the file while creating an application.
   
2. Create a new application for uploading documents into external DMS using EB.TABLE.DEFINTION.
3. Enter the application name as EB.EXTERNAL.DMS.UPLOAD and Product as EB-System Core.
   
4. Define the fields with same field name as document-keys available in the external DMS.
5. Update the application name created above in the COMPANY record for Auto ID population while launching an application or version.
   
6. Create a version (VERSION I EB.EXTERNAL.DMS.UPLOAD,UPLOAD.DOCUMENT) based on the new application and define document type as hot field where the validation occurs automatically.
   
7. Launch the version created above using EB.EXTERNAL.DMS.UPLOAD,UPLOAD.DOCUMENT I F3.
   
8. Select any Document Type, and the required fields are visible.
   
9. Fill the required details and upload the files and commit the record.

   

Alternatively,

1. Create a version and default the Document Type field as customer-image/statement/portfolio-statement.
2. Upload documents specific to that type in VERSION I EB.EXTERNAL.DMS.UPLOAD,CUSTOMER.IMAGE.

   

3. Launch the version created above (EB.UXPB.EXTERNAL.DMS.UPLOAD,IMAGE I F3 ) to upload customer images only.

   

4. Fill the required details and commit the record.

   

Integrating TE and DMS with COS

To integrate the version and enquiry created previously into the Customer Overview (COS) page instead of using the standard model bank enquiry,

1. Search and check if the details of the customer match to the specific customer as given below.
   

2. Click Capture New Image and check if the enquiry (EXTERNAL.DMS.CAPTURE.NEWIMAGE, EXTERNAL.DMS.CAPTURE.NEWDOCUMENT) launches, to upload customer images.
   Ensure capture enquiries attached in composite screen starts with EXTERNAL.DMS.CAPTURE.
   
3. Enter the required details and commit the record to move the uploaded images to the external DMS.
   
4. Check if the image, signature and the account details belong to the specific customer in COS.

   

Configuring IRIS R18 Document Service

Read Configuring IRIS R18 Document Service in UXPB for more information.