GDW_Export

The GDW_Export command performs the Sterling Gentran:Server® Export function. This function processes documents from In Documents. You can restrict the export to only documents for a specified trading partner profile ID and/or documents of a specified type.

The export function writes documents to the defined export file. If the export file exists prior to the export, the new export data is concatenated with the existing file. If you do not specify a filename, the documents are written to the default export file (defined for the inbound relationship for this partner). If a filename is specified without a file path, the default Export folder (specified in the System Configuration program) is used.

Note: This filename can contain a mix of regular characters and formatting characters (listed on the following page) that are replaced by the translator with the runtime value they represent. The following caveats apply:
  • If you use the GDW_Export command to export to a single file with a defined export filename, all documents from the same interchange are exported to a single file. If you use formatting characters in the filename, that filename contains the Document Key of the first document exported, the Process ID from that instance of the translator, and a Unique ID.
  • If you use the GDW_Export command to export to a default file where the export filename is defined in the inbound partner relationship, all documents from the same interchange are exported to a single file. If you use formatting characters in the filename, that filename contains the Document Key of the first document exported, the Process ID from that instance of the translator, and a Unique ID.
  • You can use a special character, such as an underscore, to separate values within the filename. For example, you could specify %Y_%M_%D to indicate year_month_day as the filename. However, do not use a period in a filename to separate values. A period can only be used to indicate the filename extension, such as .txt.

You can use Command Parameter 2 (Select Partner Profile ID) and Command Parameter 3 (Select Document Type) to restrict the exported documents.

Note: You must have an export translation object registered with the system.

You can also use the GDW_Export command to allow the output of an inbound translation to be delivered back to the Mailbox Server. This allows the Mailbox Server to act as a message broker to be responsible for delivering the data to its final destination.

Table 1. Command parameters for GDW_Export
Number Command Parameter What to Type
1 filename "Type the name of the file to which you want to export. If this filename is not specified, the default export file specified in the trading partner relationship is used."
Notes:
  • The filename can contain a mix of regular characters and formatting characters that are replaced by the translator with the runtime values they represent.
  • You can use a special character, such as an underscore, to separate values within the filename. For example, you could specify %Y_%M_%D to indicate year_month_day as the filename. However, do not use a period in a filename to separate values. A period can only be used to indicate the filename extension, such as .txt.

Formatting characters supported

  • %y (two-digit year)
  • %Y (four-digit year)
  • %m (abbreviated month name)
  • %M (month as a decimal number)
  • %d (abbreviated weekday name)
  • %D (day of the month as a decimal number)
  • %H (hour in 24-hour format)
  • %N (minutes)
  • %S (seconds)
  • %K (document key)
  • %P (process identifier)
  • %U (unique number derived using the current time, export filename, process identifier, and the rand() function)
2 Partner "Type a partner profile ID to restrict the action to only documents for that partner."
3 Transaction "Type a document type (transaction set or message) to restrict the export to only documents of that type."
4 Document "Type ‘Do not move to InDrawer' to specify the document should not be moved or type ‘Move to InDrawer' to move the documents after the export operation is performed."
5   ""
6 Recipient Mailbox Name "Type the recipient mailbox name if you want to use the Send Mailbox function."
7 Recipient E-mail Address "Type the recipient E-mail address if you want to use the Send Mailbox function."
8 Content Type/Content Subtype "Type the content type/content subtype if you want to use the Send Mailbox function."
9   ""
10   ""
11   ""
12   ""
13 True or False "Type ‘true' if you want to export the file or files to a mailbox or type ‘false' if you do not want to export to a mailbox."