Pipelet ExportMetaData

Exports the system metadata according to the input parameters.

Group:

ImpEx

Flags:

Error Connector

Input Parameters

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.

ExportFile : String Required

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

ExportSystemTypes : Boolean Optional

A flag indicating whether or not to export system object types.

ExportCustomTypes : Boolean Optional

A flag indicating whether or not to export custom object types.

ExportCustomPreferences : Boolean Optional

Deprecated: A flag indicating whether or not to export custom preference definition.

SystemTypes : Iterator Optional

Selected SystemTypes to export

CustomTypes : Iterator Optional

Selected CustomTypes to export

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 within the 'log' directory which is under the IMPEX directory location.

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-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.