Pipelet: ImpEx ExportOrders

Pipelet ExportOrders

Exports the specified orders, with optional encryption of payment information (credit card or bank account). Without new encryption information, masked versions will be exported. Orders are marked as exported during execution.

The ExportOrders pipelet takes care of its own transaction handling, so you cannot use the pipelet within an existing transaction.

Note: this pipelet allows access to sensitive financial and security information. Pay attention to appropriate legal and regulatory requirements.




Error Connector

Input Parameters

ExportFile : String Required

Export file path. This path is relative to the 'src' subdirectory within the top-level IMPEX directory.

OverwriteExportFile : Boolean Optional

Optional flag indicating whether to overwrite an existing export file or not. true=overwrite (default), false=don't overwrite. Default is true.

Orders : Iterator Required

Order objects to export.

EncryptionAlgorithm : String Optional

The encryption algorithm to use for payment data. Possible values are: "RSA"

EncryptionKey : String Optional

The base64 public key to use for encryption. Please refer to RSA on how to generate RSA key pairs.

UpdateExportStatus : Boolean Optional

Optional flag indicating whether the export status of the orders being exported will be set to "Exported" or not. If true, all related OnOrder inventory transactions are also turned into final inventory transactions. Default value is "true".

Output Parameters

ErrorCode : Integer : Optional

Export status code. Zero represents an export without process errors. Any other value indicates an error. This value will always be the same as the number after the "IMPEX-" prefix in Status.code.

ErrorMsg : String : Optional

Status message associated with the status code. This value will be the same as Status.message.

LogFileName : String : Optional

The name of the log file. This file is located in the 'log' subdirectory of the IMPEX area. This value will always be the same as the detail LogFileName in the returned Status object.

Status : Status : Optional

Status object representing the result of the export operation. The status property (Status.status) will be set to 0 if the export executed without any process errors or 1 otherwise. The code property (Status.code) will be set to one of the following values:

IMPEX-0 = Successful.
IMPEX-100 = One or more input parameters given were null.
IMPEX-102 = The given ExportFile exists and the OverwriteExportFile flag is false.
IMPEX-105 = The path of the given ImportFile is invalid, e.g. the path cannot contain "../".
IMPEX-153 = The 'Orders' input parameter is missing.
IMPEX-156 = There is no data to export.
IMPEX-170 = Encountered an internal fatal error. Additional information is in the details of the Status object.
IMPEX-171 = System IO error.
IMPEX-173 = System input parameter is invalid.

The status object will always have the following detail:

LogFileName = (String) The log file name in which the import logged all debug, warning, and error messages.