This is the documentation for the console version of File Gateway. The old version is no longer supported.
Documentation for the new version of File Gateway is located here.
Messages between the client and the repository are exchanged through active channels. Each channel operates with its own set of folders and repository code. To configure the active channel:
Page contents:
fill in the network parameters (Fig. 2.1). Description of the parameters is provided in table 1.
Figure 2 – configuration parameters
Table 1 – File gateway configuration parameters
Parameter | Description |
---|---|
Repository code | Repository code of the company. The channel will send and receive messages using this repository code |
Path to the inbox folder | Path to the incoming messages from the repository. The folder must be writable |
Path to the outbox folder | Path to the folder with messages to be sent to the repository. The folder must be writable |
Path to the sent message folder | The path to the messages successfully sent to the repository. The folder must be writable |
Path to the error folder | Path to the error folder. The folder must be writable |
click OK (Fig. 2.2).
As a result, the form list will display information about the created channel (Fig. 3.1).
Figure 3 – list of channels
To protect the transmitted information specify cryptographic settings in the channel configuration by doing the following:
Table 2 – Cryptography parameters
Parameter | Description |
---|---|
Cryptography parameters | |
Serial number of the NSD encryption certificate | Used to encrypt messages Allowed value type: 40:40:00:00:00:00:00:00:00:00:00:00:00:00:00:00 |
Serial number of the client certificate | Serial number of the certificate used to access the repository’s WSL-service. Allowed value type: 40:40:00:00:00:00:00:00:00:00:00:00:00:00:00:00 |
Validata profile | Validata profile used, such as My |
Cryptography type | Cryptography type – GOST or RSA |
Refresh intervals | |
Incoming messages refresh intervals | Interval of refreshing incoming messages in the HH:MM:SS format. For example, 00:01:30 is 1 min 30 sec Minimum value – 00:00:10 |
Time delay while monitoring the outgoing messages | Wait time for downloading several file attachments, if multiple files are downloaded in one folder. Wait time for outgoing messages in the HH:MM:SS format. For example, 00:01:30 means 1 min 30 sec. It is recommended to set the value of the seconds order Minimum value is 00:00:01 |
The settings will be applied after restarting the File gateway (Fig. 5).
Figure 5 – informational message
To delete a channel, click (Fig. 3.3) to disable – click on the link (Fig. 3.4).
To navigate to the file svc.config you need to paste %LOCALAPPDATA% into the Windows Explorer and press Enter on the keyboard,then go to the installation folder NSD.FileGateway.
To configure the channel, you must change the required parameters in the svc.config XML file. Valid options are presented in table 1.
Table 1 – File Gateway Setup Parameters
XPath-expression | Description |
---|---|
/fileGateway/channels/channel | The /fileGateway/channels/channel elements contain settings of the service channels. Each channel operates with its own set of folders and their repository code. You must specify at least one active channel for successful service operation |
/fileGateway/channels/channel/@enabled | Evidence of channel activity. Valid values:
Inactive channels are ignored |
/fileGateway/channels/channel/@repositoryCode | Repository code for the channel. The channel will send and receive messages on behalf of the repository code. |
/fileGateway/channels/channel/@certificateSerialNumber | Serial number of the certificate used for signing and encrypting messages Valid value type 40:40:00:00:00:00:00:00:00:00:00:00:00:00:00:00 |
/fileGateway/channels/channel/@clientCertificateSerialNumber | Serial number of the certificate used to access the WSL- service of the repository Valid value type 40:40:00:00:00:00:00:00:00:00:00:00:00:00:00:00 |
/fileGateway/channels/channel/@validataProfile | Validata profile used, such as My |
/fileGateway/channels/channel/@cryptography | Cryptography used by the channel. Valid values: RSA, GOST |
/fileGateway/channels/channel/inbox/@path | Path to the Inbox. The service process must have access to write to this folder |
/fileGateway/channels/channel/inbox/@fetchInterval | Interval of refreshing incoming messages in the format HH:MM:SS. For example, 00:01:30 is 1 min 30 sec Minimum value – 00:00:10 |
/fileGateway/channels/channel/outbox/@path | Path to the Sent mail folder. The service process must have access to write to this folder |
/fileGateway/channels/channel/outbox/@monitoringThreshold | Interval of waiting for outgoing messages in the format HH:MM:SS. For example, 00:01:30 is 1 min 30 sec We recommend to use the second value Minimum value – 00:00:01 |
/fileGateway/channels/channel/sent/@path | Path to the Sent mail folder. The service process must have access to write to this folder |
/fileGateway/channels/channel/errors/@path | Path to error message folder. The service process must have access to write to this folder |