FINS Synergy Documents System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
Module | Description |
---|---|
create-document-images-soap-request | SOAP Request mapping for creating a Document Image with Indexes in Synergy |
create-images-response | Create DocImages in Synergy response mapping |
get-document-image-content-response | Retrieve Document Image Content from Synergy |
get-document-image-content-soap-request | SOAP Request mapping for retrieving a Document Image content from Synergy |
get-indexes-response | Retrieve Document Image Indexes from Jack Henry Synergy response mapping |
get-indexes-soap-request | SOAP Request mapping for retrieving a Document Image Indexes from Synergy |
create-document-images-soap-request
SOAP Request mapping for creating a Document Image with Indexes in Synergy
Source:
./src/main/resources/dwl/create-document-images-soap-request.dwl
create-images-response
Create DocImages in Synergy response mapping
Source:
./src/main/resources/dwl/create-images-response.dwl
Mapping Tables
The DocImgAdd Operation of the ImageService is used to create a Document Image in Synergy Maps the DocImgAdd response to CIM Document Indexes format
CIM | DocImgAddResponse.DocImgInfoRsArray.DocImgInfoRs.DocImgIdxArray.DocImgIdx | Description | |
---|---|---|---|
indexName | DocImgIdxArray.DocImgIdx.DocImgIdxName | Display name of the document index. | |
indexType | DocImgIdxArray.DocImgIdx.DocImgIdxType | Indicates the type of document index this represents | such as an account number. |
indexValue | DocImgIdxArray.DocImgIdx.DocImgIdxValue | Value of the document index corresponding to the index type. |
get-document-image-content-response
Retrieve Document Image Content from Synergy
Source:
./src/main/resources/dwl/get-document-image-content-response.dwl
Mapping Tables
The DocImgSrch Operation of the ImageService is used to retrieve the Document Image Content Indexes from Synergy Maps the DocImgSrch response to CIM Document Images format
CIM | DocImgSrchResponse.DocImgSrchArray.DocImgSrchInfo | Description | |
---|---|---|---|
name | DocName | The name of the Document in Synergy. | |
description | DocName | The description of the Document in Synergy. | |
images.imageFormat | DocImgDetArray.DocImgDetInfo.DocImgFormat | Format of the encoded image. | |
images.imageContent | DocImgDetArray.DocImgDetInfo.DocImg | Image content encoded as Base64. | |
images.imageSize | DocImgDetArray.DocImgDetInfo.DocImgSize | Image size in bytes. | |
images.imageSequence | DocImgDetArray.DocImgDetInfo.DocImgProcSeq | Processing sequence for reconstructing multi-part images. | |
indexes.indexName | DocImgIdxArray.DocImgIdx.DocImgIdxName | Display name of the document index. | |
indexes.indexType | DocImgIdxArray.DocImgIdx.DocImgIdxType | Indicates the type of document index this represents | such as an account number. |
indexes.indexValue | DocImgIdxArray.DocImgIdx.DocImgIdxValue | Value of the document index corresponding to the index type. | |
auditInfo.createdDate | now() | Timestamp of when the customer was created - set as Current Time. | |
auditInfo.createdBy | DocImgSrchResponse.SrchMsgRsHdr.jXchangeHdr.AuditUsrId | Identifies the system or user which created the customer. | |
auditInfo.updatedDate | now() | Timestamp of when the customer was last updated. | |
auditInfo.updatedBy | DocImgSrchResponse.SrchMsgRsHdr.jXchangeHdr.AuditUsrId | Identifies the system or user which last updated the customer. | |
auditInfo.isDeleted | false | Indicates whether or not the customer has been soft-deleted - set as false. |
get-document-image-content-soap-request
SOAP Request mapping for retrieving a Document Image content from Synergy
Source:
./src/main/resources/dwl/get-document-image-content-soap-request.dwl
get-indexes-response
Retrieve Document Image Indexes from Jack Henry Synergy response mapping
Source:
./src/main/resources/dwl/get-indexes-response.dwl
Mapping Tables
The DocImgSrch Operation of the ImageService is used to retrieve the Document Indexes from Synergy Maps the DocImgSrch response to CIM Document Images format
CIM | DocImgSrchResponse.DocImgSrchArray.DocImgSrchInfo | Description | |
---|---|---|---|
name | DocName | The name of the Document in Synergy. | |
description | DocName | The description of the Document in Synergy. | |
indexes.indexName | DocImgIdxArray.DocImgIdx.DocImgIdxName | Display name of the document index. | |
indexes.indexType | DocImgIdxArray.DocImgIdx.DocImgIdxType | Indicates the type of document index this represents | such as an account number. |
indexes.indexValue | DocImgIdxArray.DocImgIdx.DocImgIdxValue | Value of the document index corresponding to the index type. | |
auditInfo.createdDate | now() | Timestamp of when the customer was created - Set as Current Time. | |
auditInfo.createdBy | DocImgSrchResponse.MsgRsHdr.jXchangeHdr.AuditUsrId | Identifies the system or user which created the customer. | |
auditInfo.updatedDate | now() | Timestamp of when the customer was last updated. | |
auditInfo.updatedBy | DocImgSrchResponse.MsgRsHdr.jXchangeHdr.AuditUsrId | Identifies the system or user which last updated the customer. | |
auditInfo.isDeleted | false | Indicates whether or not the customer has been soft-deleted - Set as false. |
get-indexes-soap-request
SOAP Request mapping for retrieving a Document Image Indexes from Synergy
Source:
./src/main/resources/dwl/get-indexes-soap-request.dwl