Finance Utilities
Organization administration - Electronic reporting export connection
Organization administration - Electronic reporting export connection
Finance utilities includes functionality to export an Electronic reporting format to a secure location.
The following section will describe the required setup for Step 1 for the secure location which is available in Electronic reporting export connections.
Users can access the page by navigating to Organisation administration > Electronic reporting > Electronic reporting export connections
Select New to create the location where GER file is to be saved. Connection options include FTP/FTPS, SFTP, Azure blob or API Endpoint
| Field | Description | Example or Options |
|---|---|---|
| Name | Enter a name for your connection | ANZ_FTP |
| Connection type | Select the applicable connection type | • FTP • Azure blob • SFTP • API Endpoint |
| Error action | The action to take when there is an error with the connection | • Error • Warning |
| Enable file encryption/decryption | Set to Yes if the export file should be encrypted | • No • Yes |
| Encryption key name | Select applicable Encryption key name. See DXC encryption parameters for additional details. |
|
| Enable business event | Option to create an event when file is saved to Azure blob. Setup required: • Set this option to Yes • Active Business event ‘Electronic reporting file exported to azure blob’ • No • Yes |
Select Save and the applicable Setup will be displayed as per the 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 |
|
| Path | Enter the path where the files are to be saved on the FTP site. | /GER_ANZ |
| Port | Specify the Port for the FTP site | 22 |
| Enable TLS | Select to enable FTPS using TLS | • Yes: FTPS • No: FTP |
| User | Specify the Username used for authentication to the FTP site | |
| Credential type | Select applicable Credential type for FTP site | • Key vault • Database |
| Password | Enabled when Credential type is set to Database. Specify the Password used for authentication to the FTP site. Note: this is encrypted and displayed as •••••••••• within the form. |
|
| Key vault certificate | Enabled when Credential type is set to Key vault. | Select the applicable Key vault certificate. |
| Field | Description | Example or Options |
|---|---|---|
| Container name | Specify the blob storage container | |
| Credential type | Select applicable Credential type for Azure blob | • Key vault • Database |
| Storage account name | Enabled when Credential type is set to Database | |
| Storage account key | Enabled when Credential type is set to Database | |
| Connection string | Enabled when Credential type is set to Key vault. Azure SAS Storage account level tokens also supported. |
| Field | Description | Example or Options |
|---|---|---|
| Host | Specify the Host for the SFTP site Note: SFTP:// is not required |
|
| Path | Enter the path where the files are to be saved on the SFTP site. | /GER_ANZ |
| Port | Specify the Port for the SFTP site | 22 |
| Enable TLS | Select to enable SFTP over TLS | • Yes: SFTP over TLS • No: SFTP |
| User | Specify the Username used for authentication to the SFTP site | |
| Credential type | Select applicable Credential type for SFTP site | • Key vault • Database • Private key (SSH key file stored in Azure) |
| Password | Enabled when Credential type is set to Database. 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 |
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 export 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:
Where the bank requires a static IP address for connections for sending bank payment files to their SFTP