Integrating UXPB with External Document Management System

This section describes how the UXPB can be integrated with any external Document Management System(DMS). It now offers search, download, generate and upload features thereby minimising the number of components to be used during integration.

To enable integration with UXPB, specify the following in the BRPRuntimeProperties.properties file available under {TEMENOS_HOME}\properties.

browser.options.externalDMS.enable=Y
browser.options.externalDMS.baseUrl=http://localhost:9089/irf-document-services/v1.0.0
browser.options.externalDMS.documentSearchApiPath=/documents
browser.options.externalDMS.documentDownloadApiPath=/documents/{id}/download
browser.options.externalDMS.documentUploadApiPath=/documents
browser.options.externalDMS.documentDefinitionApiPath=/document-definitions/
browser.options.externalDMS.documentGenerateApiPath=/documents/generation
browser.options.externalDMS.enquiriesEnabledForDocumentGenerate=SECTOR|CUSTOMER.INFO|CUSTOMER.SCV|CUSTOMER.LIST
browser.options.externalDMS.targetMVDelimiterForDocumentGenerate=##
browser.options.externalDMS.targetSVDelimiterForDocumentGenerate=??

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

Document Search

To enable document search,

1. Copy the NOFILE.UXPB.EXTERNAL.DMS.SEARCH Nofile routine class and component class files into the Transact library files available in the environment.
2. Create a STANDARD.SELECTION record with field names as documentKeys available in the external DMS. The application name should be: NOFILE.UXPB.EXTERNAL.DMS.SEARCH.

   

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

   

4. The field names in the enquiry definition should be the same as the field names in the search-document-response_transformer.json in irf-document-services.war as highlighted below.
   
5. Launch the newly created enquiry in UXPB (ENQ EXTERNAL.ACCT.SEARCH) to verify the results. It retrieves only the account statements as shown below.
   

Document Download

To download a document, perform the following steps:

1. Define a drill down as shown below for the EXTERNAL.ACCT.SEARCH enquiry.

   

2. Launch the enquiry (ENQ EXTERNAL.ACCT.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. To display images in UXPB from the external DMS, create ENQUIRY I EXTERNAL.PHOTO.DISPLAY.

   

4. On launching the image enquiry (ENQ EXTERNAL.PHOTO.DISPLAY) , it displays only the customer photo.
   

5. To display the signature, create ENQUIRY I EXTERNAL.SIGNATURE.DISPLAY.

   

6. On launching the signature enquiry (ENQ EXTERNAL.SIGNATURE.DISPLAY) the system displays the customer signature.

   

Document Generate

Configure the BRPRunTimeProperties.properties such that Document Generate option in the Enquiry Results Toolbar becomes available for those enquiries specified in the properties file.

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

  browser.options.externalDMS.enquiriesEnabledForDocumentGenerate=SECTOR|CUSTOMER.INFO|CUSTOMER.SCV|CUSTOMER.LIST

• For all enquiries, specify as shown below:

  browser.options.externalDMS.enquiriesEnabledForDocumentGenerate=ALL

  

Document Upload

To enable the document upload feature,

1. Create a new datatype for upload as shown below and attach it the File field while creating an application.

   

2. Create a new application for uploading documents into external DMS using EB.TABLE.DEFINTION. The application name should be UXPB.EXTERNAL.DMS.UPLOAD and Product should be EB. Define the fields as document-keys available in the external DMS.
3. Update the application name created above in the COMPANY record for Auto Id population while launching an application or version.

   

4. Create a version based on the new application and make the document-type field as a hotfield where the validation occurs automatically (VERSION I EB.UXPB.EXTERNAL.DMS.UPLOAD,CAPTURE).

   

5. Launch the version created above using EB.UXPB.EXTERNAL.DMS.UPLOAD,CAPTURE I F3.

   

6. Select any document-type, and the required fields are made visible.
   
7. Fill the required details and upload the files and commit the record.

   

8. Verify that the document is moved to the external DMS.

   

Alternatively,

1. Create a version and default the document-type field as customer-image/statement/portfolio-statement and upload documents specific to that type.(VERSION I EB.UXPB.EXTERNAL.DMS.UPLOAD,IMAGE)

   

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

   

3. Fill the required details and commit the record.

   

4. Verify if the image is moved to the external DMS.

   

Integration of UXPB and DMS within COS

Integrate the version and enquiry created previously into the Customer Overview (COS) page instead of using the standard model bank enquiry.

1. Check if the image and signature belong to the specific customer.
   

2. Check if the account statement is related to this particular account or not.

   

3. View the account statement related to that particular account from the external DMS.
   
4. Check if you can move either images or any documents to the external DMS, using the options below in the Customer Overview page.

   

5. Use the Capture New Image icon and check if the version(EB.UXPB.EXTERNAL.DMS.UPLOAD,IMAGE) launches, to upload customer images.

   

6. Fill the required details and commit the record to move the uploaded images to the external DMS.

   

Configuring IRIS R18 Document Service

The following are the configurations required for IRIS R18 document service.