Pipelet: ImpEx ImportKeyValueMapping

Pipelet ImportKeyValueMapping

Imports a new mapping definition with the name MappingName into the system or replace/merge/delete an existing mapping definition with that name. For supported modes and outcome see ImportMode parameter.




Error Connector

Transaction Required

Input Parameters

MappingName : String Required

Name of the mapping. This is the parameter under which the mapping is going to be accessible if a value is retrieved. Example: 'sap-to-dwre-skus' or 'dwre-products-to-sap'.

KeyCount : Double Optional

Number of columns in CSV file that should be considered as composite key components (from left to right). Optional, default is 1: First column in CSV is a key, all other columns are going to be aggregated in a list of values.

ImportFile : String Optional

Import file path. This path must be relative to the 'src' subdirectory within the top-level IMPEX directory. Parameter is required when used in conjunction with MERGE and REPLACE import modes, and not used when used in conjunction with DELETE import mode. If this parameter is missing, IMPEX-103 is thrown.

ImportMode : String Required

Import mode. Possible values are MERGE, DELETE, REPLACE.

Output Parameters

ErrorCode : Integer : Optional

Import status code. Zero represents an import 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. 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 import operation. The status property (Status.status) will be set to 0 if the import executed without any process errors or 1 otherwise. The code property (Status.code) will be set to one of the following values:

IMPEX-0 = The import completed without any process errors.
IMPEX-100 = One or more input parameters given were null.
IMPEX-103 = The given ImportFile does not exist.
IMPEX-104 = The given ImportMode is not supported.
IMPEX-105 = The path of the given ImportFile is invalid, e.g. the path cannot contain "../".
IMPEX-130 = All parsing related errors will cause this error. It could be malformed input data or a problem with the CSV parser engine.
IMPEX-170 = Encountered an internal fatal error. Additional information is in the details of the Status object.
IMPEX-171 = System IO error.
IMPEX-172 = System file input stream close 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.

If the import executed without any process errors, the status object will also contain the following details:

Client code should consult these details to determine whether there were any problems with the data in the import file and take appropriate action. The values can be retrieved using the syntax: "Status.details.DataErrorCount" and "Status.details.DataWarningCount"