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.
Once the File gateway downloads orders from the Outbox folder the form Messages in the process of sending will display information about the sent files (Fig. 1.1):
Creation time – time, when message got into the queue to be sent;
Refresh time – time of the last operation on the message;
Repository code – company code assigned by the repository;
Source file – name of the sent file;
Correlationid – unique message ID number, manually assigned by the user;
Attachments – additional PDF files to be sent. Message XML file should contain a link to the attachment file in accordance with the FpML format;
Status – information about order sending.
Figure 1 – Messages in the process of sending form
Sent messages are displayed in the web interface in the form of a list. The buttons on the top panel allow the user to sort records:
by the sendig status:
Complete – messages successfully sent to the repository;
Cancelled – messages that were canceled by the user from web interface;
Errors – messages that were not sent because of an error.
Information about orders delivered to the repository will be displayed in the Sent packets form.
The Sent packets form shows the list of all messages successfully delivered to the repository.
Figure 2 – Sent packets form
Each record includes information about the sent message (Fig. 2.1):
Packet name – name of the package, assigned by the repository system;
Source file – path to the source file;
Correlationid – unique message ID number, manually assigned by the user ;
Attachments – name of the file attached to the message;
Status – information about order sending.
To view information about the orders for the previous days use the buttons on the top panel (Fig. 2.2). A message record in the form can be deleted by clicking . In this case the message file is not deleted.
Upon receipt of the response messages from the repository the File gateway decrypts the packet, checks the electronic signature and saves files in xml format in your inbox. The Downloaded packets form displays information about messages received from the repository for the current day (Fig. 3.1):
Packet number – repository number of the incoming packet;
Package name – name of the package assigned by the repository system;
Path to downloaded files – path to the folder where the file is located.
Figure 3 – Sent packets form
To view information about sent orders for the previous days use the buttons on the top panel (Fig. 2.2). A record in the form can be deleted by clicking
, In this case the downloaded files are not deleted.The Error sending form displays records about messages that were impossible to send. A record contains the following data:
Source file – path to the folder, where the file is located;
Correlationid – unique message ID number, manually assigned by the user ;
Attachments – names of attached files ;
Status – information about order sending;
Error – short information about the error.
Figure 4 – Error sending form
For more details on the error and its cause click
. This will open a block with the description of the causes (Fig. 5).Figure 5 – viewing error code
To view information about the orders sent within the previous days use the buttons on the top panel (Fig. 2.2). A record in the form can be deleted by clicking
, In this case the downloaded files are not deleted.