Configuring the Export Destination
The Export Destination page specifies the destination of the export. Data can be exported to a standard file system directory and/or to a configured SonicMQ Broker queue. Both export options support a retry option if an export fails, and the export file will be written to the configured Retry Folder (for Export to File System) or the Resend Folder (for Export to SonicMQ broker queue).
|
SonicMQ EIE - Export Destination Page |
The properties for each section of this page are described below.
| Property | Description |
|---|---|
|
Export to Filesystem |
Select this option to export data to a specified folder in the standard file system. |
|
Folder Path |
Specify the path to the folder in the standard file system where the data will be saved. For example: E:\Apps\CygNet\ImportExportHistory\SMQ Note: This folder path supports the use of system environment variable tokens. See System Environment Variable Tokens below for more information. |
|
Max Files |
Specify the maximum number of files that can be stored in the folder. |
|
Retry Folder Path |
If writing a new export to the resolved export Folder Path fails, the export file will be written to this Retry Folder Path. Specify the path to the retry folder in the standard file system. For example: .\Retry Note: This folder path supports the use of system environment variable tokens. See System Environment Variable Tokens below for more information. Also see Export Retry/Resend below for more information about export failures. |
|
Retry Max Files |
Specify the maximum number of files that can be stored in the retry folder. |
|
Export to SonicMQ |
Select this option to export data to the SonicMQ broker. |
|
Queue Name |
Specify the SonicMQ queue name. |
|
Broker/IP |
Specity the computer name or TCP/IP address hosting the primary SonicMQ broker. |
|
Port |
Specify the port number of the primary SonicMQ broker. |
|
Backup (Broker/IP) |
Specify a secondary computer name or TCP/IP address used in case the primary broker fails. |
|
Backup Port |
Specify the port number of the secondary SonicMQ broker. |
|
Username |
Specify the username required to connect to the SonicMQ broker. |
|
Password |
Specify the password required to connect to the SonicMQ broker. |
|
Msg. Lifespan |
Specify the amount of time the message stays on the SonicMQ broker. |
|
Msg. Priority |
Select the priority of the message from the drop-down menu. Messages with a higher priority are processed first. |
|
Resend Folder |
Specify the path to the folder in the standard file system to the files that need to be resent. For example: E:\Apps\CygNet\ImportExportHistory\SMQ Note: This folder path supports the use of system environment variable tokens. See System Environment Variable Tokens below for more information. Also see Export Retry/Resend below for more information about export failures. |
System Environment Variable Tokens
The folder path options for the SonicMQ export support the use of Windows system environment variable tokens. The format of the environment variable tokens must be in the form “%MY_SPECIAL_ENV_VAR%\Listener”.
Note: The RSM that controls the UIS that is hosting the SonicMQ export drivers must be restarted whenever an environment variable embedded in a folder path is changed so that the new settings are picked up by the UIS process.
Windows system environment variable tokens configuration:
- Go to Settings and type "environment" and select to edit the system environment variables.
- Open the System Properties dialog box on the computer name where the SonicMQ Export device is configured.
- Click Environment Variables to open the variables for the system.
- Click New under the System variables field to configure a new variable:
- Specify a Variable name, e.g., MY_SPECIAL_ENV_VAR
- Specify a Variable value, e.g., D:\UseThisFolderFor\Export
- Click OK three times.
Export Retry/Resend
If writing a new export to the configured export Folder Path fails, the export file will be written to the configured Retry Folder. The following notes apply to retry logic:
-
The next time an export is executed, before generating a new export file, the driver will retry to post any and all files that existing in the Retry Folder.
-
The original filename of retried export files will be maintained.
-
If duplicate filenames are encountered in either the Export Folder or Retry Folder, the driver will append a zero-padded four digit number to the end of the file, starting with 0000 up to 9999, in an attempt to generate a unique filename.
