Import Data Mapping

Member mappings are used to derive the target members for each dimension based on source value. Member mappings are referenced during the data load, enabling Data Management to determine how to dimensionalize the data that is loaded to the target application. Member mappings define relationships between source members and target dimension members within a single dimension. You must create a member mapping for each target dimension.

You can import member mappings from a selected Excel, .CSV or .TXT file. You can also create new mappings in a text file and import them. Import member mappings support merge or replace modes, along with validate or no validate options for target members.

REST Resource

POST /aif/rest/{api_version}/jobs

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 10-9 Parameters

Name Description Type Required Default
api_version Version of the API you are working with, such as V1 Path Yes None
jobType The job type, MAPPINGIMPORT Path Yes None
jobName

The dimension name for a specific dimension to import, such as ACCOUNT, or ALL to import all dimensions

Path Yes None
fileName The file and path from which to import mappings. The file format can be .CSV, .TXT, .XLS, or .XLSX. The file must be uploaded prior to importing, either to the inbox or to a sub-directory of the inbox. Include the inbox in the file path, for example,inbox/BESSAPPJan-06.csv Path Yes None
importMode The import mode: MERGE to add new rules or replace existing rules, or REPLACE to clear prior mapping rules before import Path No MERGE
validationMode Whether to use validation mode, true or false An entry of true validates the target members against the target application; false loads the mapping file without any validations. Note that the validation process is resource intensive and takes longer than the validation mode of false; the option selected by most customers is false Path No false
locationName The Data Management location where the mapping rules should be loaded; mapping rules are specific to a location in Data Management Path No None

Example of Request Body

The following shows an example of the request body in JSON format.

{
"jobType":"MAPPINGIMPORT",
"jobName":"ACCOUNT"
"fileName":"inbox/BESSAPPJan-06.csv",
"importMode":"MERGE",
"validationMode":"false",
"locationName":"BESSAPP"
}

For sample code, see the code samples included in Running Data Rules.

Response

The following table summarizes the response parameters.

Table 10-10 Parameters

Name Description

jobId

The process ID generated in Data Management for the job, such as 1880

jobStatus

The job status, such as RUNNING

logFileName

Log file containing entries for this execution, such as outbox/logs/BESSAPP-DB_1880.log

outputFileName

Name of the output file generated, if any, or else null

processType

Type of process executed, IMPORT_MAPPING

executedBy

Login name of the user used to execute the rule, such as admin

details

Returns the exception stack trace in case of an application error, or null

Supported Media Types: application/json

Parameters

Example of Response Body

The following shows an example of the response body in JSON format.

{
"links": 
[
0]
"status":"-1"
"details":"null"
"jobId":"1880"
"jobStatus":"RUNNING",
"logFileName":"outbox/logs/BESSAPP-DB_1880.log",
"outputFileName":"null",
"processType":"IMPORT_MAPPING",
"executedBy":"admin"
}

For sample code, see the code samples included in Running Data Rules.