Finance Utilities
Cash and bank management setup - Finance utilities connections
Cash and bank management setup - Finance utilities connections
When the bank statements are to be imported via the periodic task Import bank statements via financial utilities connection, the applicable connection type must be setup using the Financial utilities connections page.
Financial utilities connections are used in the following:
The import file can be attached to the created D365 bank statement(s), by setting File attachment document type on Financial utilities parameters.
Examples where a file would we moved to Import error path:
Note: If Import error path is not setup/incorrect, the file will be deleted from the import path and not archived.
To open the Financial utilities connections page, go to Cash and bank management > Setup > Advanced bank reconciliation setup > Financial utilities connections. Then set the fields as described in the following subsections.
| Field | Description | Example or Options |
|---|---|---|
| Name | Enter a name for your connection | ANZ_FTP |
| Description | Enter a description for your connection | FTP for bank 123 |
| Connection type | Select the applicable connection type | • FTP • Azure blob • SFTP • SharePoint • API Endpoint |
| Error action | The action to take when there is an error with the connection | • Error • Warning |
| Enabled | Once all the mandatory fields have been completed the connection can be enabled | • Yes • No |
| Enable file encryption/decryption | Set to Yes if the import file should be decrypted | • No • Yes |
| Encryption key name | Select applicable Encryption key name. See DXC encryption parameters for additional details. |
Click Save and the applicable Setup will be displayed as per Connection type selected.
All connection methods have the option to set Log level and Retention periods.
These logs can then be used to set Custom alerts, for example using error log to be notified when a connection can’t connect.
| Field | Description |
|---|---|
| Logging level | Select required logging level: • None (default) • Info • Warning • Error |
| Log retention | |
| Duration | Enter quantity for required duration |
| Period | Select log retention period: • Unlimited • Days • Weeks • Months • Quarters • Years |
| Field | Description |
|---|---|
| Created date and time | Date and time log was created. |
| Created by | By whom the log was created. |
| Level | Log level: Information, warning or error. |
| Log code | Code that initiated the log. |
| Message | Message for the log. |
| Field | Description | Example or Options |
|---|---|---|
| Host | Specify the Host for the FTP site > Note: FTP:// is not required |
|
| Port | Specify the Port for the FTP site | 21 |
| Enable TLS | Select to enable FTPS using TLS | • Yes: FTPS • No: FTP |
| User | Specify the Username used for authentication to the FTP site | |
| Password | Specify the Password used for authentication to the FTP site. > Note: this is encrypted and displayed as •••••••••• within the form. |
|
| Import path | Enter the path where the files are to be imported from | /Integration |
| Import archive path | Enter the path where the imported files are to be copied to | /Integration/Archive |
| Search mask | A file mask is used to match files in the Import path | Bank123* |
| Import error path | Enter the path where the files that matches the Search mask, but haven’t successfully been imported, are copied to | /Integration/Error |
| Field | Description | Example or Options |
|---|---|---|
| Container name | Specify the import blob storage container. Folders are not supported | integration-import |
| Credential type | Select applicable Credential type for Azure blob | • Key vault • Database |
| Storage account name | Enter the Storage account name where Credential type = Database | |
| Storage account key | Enter the Storage account key where Credential type = Database | |
| Connection string | Enabled when Credential type = Key vault. Select the applicable Secret as setup in Key vault parameters. Azure SAS Storage account level tokens also supported. |
|
| Archive container name | Enter the archive path where the imported files are to be copied to. Folders are not supported | integration-archive |
| Search mask | A file mask is used to match files in the Import path | Bank123* |
| Error container name | Enter the error path where the files that matches the Search mask, but haven’t successfully been imported, are copied to. Folders are not supported. | integration-error |
| Field | Description | Example or Options |
|---|---|---|
| Host | Specify the Host for the SFTP site. > Note: SFTP:// is not required |
|
| Port | Specify the Port for the SFTP site | 21 |
| Enable TLS | Select to enable SFTP over TLS | • Yes: SFTP over TLS • No: SFTP |
| Credential type | Select applicable Credential type for SFTP site | • Key vault • Database • Private key (SSH key file stored in Azure) |
| User | Specify the Username used for authentication to the SFTP site | |
| Password | Specify the Password used for authentication to the SFTP site. > Note: this is encrypted and displayed as •••••••••• within the form. |
|
| Connection string | Enabled when Credential type is set to Key vault or Private key. Private key: In ‘Key vault parameters’ create a vault to store the access key of the storage account to access the sshkey file. |
Select applicable Key vault certificate. |
| Container name | Enabled when Credential type is set to Private key. Enter the Azure container that stores the SSH key file |
|
| File name | Enabled when Credential type is set to Private key. Enter the file name for the SSH key file |
|
| Phass phrase | Enabled when Credential type is set to Private key. If applicable, enter the phass phrase for the SSH key file |
|
| Import path | Enter the path where the files are to be imported from | /Integration |
| Import archive path | Enter the path where the imported files are to be copied to | /Integration/Archive |
| Search mask | A file mask is used to match files in the Import path | Bank123* |
| Import error path | Enter the path where the files that matches the Search mask, but haven’t successfully been imported, are copied to | /Integration/Error |
Note: Setup SharePoint at Organisation administration > Document management > Document management parameters, tab SharePoint
| Field | Description | Example or Options |
|---|---|---|
| Import SharePoint address | Enter the SharePoint address where the files are to be imported from | https://…/Shared Documents/Integration |
| Archive SharePoint address | Enter the SharePoint address where the imported files are to be copied to | https://…/Shared Documents/Integration-archive |
| Import error SharePoint address | Enter the SharePoint address where the files that matches the Search mask, but haven’t successfully been imported, are copied to | https://…/Shared Documents/Integration-error |
| Search mask | A file mask is used to match files in the Import path | Bank123* |
Note: Available Web API types can be viewed on ActionPane.
Technical guide for Web API Endpoints.
| Field | Description | Example or Options |
|---|---|---|
| Web API types | Select applicable import web service | Options as per Web API types |
| Connection details | ||
| Internet address | Enter the internet address for the API Endpoint | https://XX.azurewebsites.net/ |
| Service endpoint | Enter the service point for the API Endpoint | api/DFUWebAPIImportExport/importFile |
| Validate connection endpoint | Service endpoint for Validate connection | api/HealthCheck/testConnection |
| OAUTH connection details | ||
| Application ID | Azure active directory application identifier | |
| Key vault secret name | Azure active directory application secret key | Select the applicable Secret as setup in Key vault parameters |
| Tenant ID | Azure active directory tenant identifier | XX.onmicrosoft.com |
| Authority URI | Azure active directory authority URI | https://login.microsoftonline.com/ |
Use button Validate connection to validate the following:
Once all setup has been completed, update Enabled to Yes.