Managing Data Mapping
The services for mapping management are available in the TW.AnalysisServices.EventManagementServicesAPI resource.
The following table provides information about the purpose, input parameters, and the result of each service:
|
Service Name and Purpose
|
Input Parameters
|
Result
|
|||
|---|---|---|---|---|---|
|
Parameter Name
|
Base Type
|
Description
|
|||
|
CreateAutoMappingFromEntity — Maps all the attributes that have matching case-sensitive names with the entity as source, between the model parameters and entity parameters.
|
sourceEntityName
|
String
|
Specifies the name of the source entity on which you want to define mapping.
|
Returns the fields that were not auto-mapped as a list in the form of an infotable that has the TW.AnalysisServices.ListDataShape data shape.
|
|
|
analysisEventId
|
String
|
Specifies the ID of the analysis event for which mapping is to be defined.
|
|||
|
mappingType
|
String
|
Specifies the type of mapping as one of the following:
• inputs
• results
|
|||
|
prefixAttribute
|
String
|
If the property names in the source entity are the same as the field names of the input or result data shapes with a prefix, specify the prefix as the value of this parameter.
|
|||
|
forceUpdate
|
Boolean
|
Set to true to remove existing mappings and create new mappings.
|
|||
|
entityType
|
String
|
Specifies the type of entity that the event is to be created on as one of the following:
• Thing
• Thing template
• Thing shape
This parameter is optional.
|
|||
|
sourcePath
|
String
|
Specifies the path to the selected source infotable from the root of the data shape. If the infotable is a part of nested infotables, the path should be separated by a ‘.’ (dot).
For example: If infotable p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then sourcePropertyPath is specified as Infotable1.Infotable2.p.
If p is not an infotable, then all fields that fulfil the auto-mapping criteria are mapped.
|
|||
|
targetPath
|
String
|
Specifies the path to the selected target infotable from the root of the data shape. If the infotable is a part of nested infotables, the path should be separated by a ‘.’ (dot).
For example: If infotable p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then sourcePropertyPath is specified as Infotable1.Infotable2.p.
If p is not an infotable, then all fields that fulfil the auto-mapping criteria are mapped.
|
|||
|
CreateAutoMappingFromEvent — Maps all attributes that have matching case-sensitive names with the event as source, between the model parameters and event parameters.
|
analysisEventId
|
String
|
Specifies the ID of the analysis event for which mapping is to be defined.
|
Returns the fields that were not auto-mapped as a list in the form of an infotable that has the TW.AnalysisServices.ListDataShape data shape.
|
|
|
prefixAttribute
|
String
|
If the property names in the source entity are the same as the field names of the input or result data shapes with a prefix, specify the prefix as the value of this parameter.
|
|||
|
forceUpdate
|
Boolean
|
Set to true to remove existing mappings and create new mappings.
|
|||
|
sourcePath
|
String
|
Specifies the path to the selected source infotable from the root of the data shape. If the infotable is a part of nested infotables, the path should be separated by a ‘.’ (dot).
For example: If infotable p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then sourcePropertyPath is specified as Infotable1.Infotable2.p.
If p is not an infotable, then all fields that fulfil the auto-mapping criteria are mapped.
|
|||
|
targetPath
|
String
|
Specifies the path to the selected target infotable from the root of the data shape. If the infotable is a part of nested infotables, the path should be separated by a ‘.’ (dot).
For example: If infotable p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then sourcePropertyPath is specified as Infotable1.Infotable2.p.
If p is not an infotable, then all fields that fulfil the auto-mapping criteria are mapped.
|
|||
|
CreateInputMappingFromEntity — Creates input mapping for a particular analysis event. The mapping is created from the property of a specified entity. The entity can be a thing, a thing template, or a thing shape.
|
analysisEventId
|
String
|
Specifies the ID of the analysis event for which mapping is to be defined.
|
Returns the ID of the mapping that is created.
|
|
|
sourceEntityName
|
String
|
Specifies the name of the source entity on which you want to define mapping.
|
|||
|
sourceProperty
|
String
|
Specifies the name of the property of the source entity.
|
|||
|
sourcePropertyPath
|
String
|
Specifies the path to the sourceProperty from the root of the data shape. This parameter is optional. The value can be an empty string or null if the field is not within an infotable. If the property is a part of nested infotables, the path should be separated by a ‘.’ (dot).
For example: If property p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then sourcePropertyPath is specified as Infotable1.Infotable2.
|
|||
|
sourcePropertyBaseType
|
Basetypename
|
Specifies the base type of the source property.
|
|||
|
sourcePropertyDS
|
Datashapename
|
Specifies the data shape if the sourcePropertyBaseType is an infotable.
|
|||
|
targetAnalysisInputDatashapeField
|
String
|
Specifies the name of the field from the analysis input data shape to be the target of mapping.
|
|||
|
targetAnalysisInputDatashapeFieldPath
|
String
|
Specifies the path to the target field from the top-level infotable. The value can be an empty string or null if the field is not within an infotable. If the field is nested within infotables, the path must be separated by a ‘.’ (dot).
For example: If field a to be used in mapping is nested within infotables, [provider].[model].InputParamsDatashape->Level1InfoTable->Level2Info->a, then the path should be Level1InfoTable.Level2Info. Here, you can skip the InputParamsDatshape since it is the default root associated with the inputDatashape of the model.
|
|||
|
targetAnalysisInputDsBaseType
|
Basetypename
|
Specifies the base type of the target field.
|
|||
|
targetAnalysisInputDsFieldDS
|
Datashapename
|
Specifies the data shape if the targetAnalysisInputDsBaseType is an infotable.
|
|||
|
sourceEntityType
|
String
|
Specifies the type of entity that the event is to be created on as one of the following:
• Thing
• Thing template
• Thing shape
This parameter is optional.
|
|||
|
CreateInputMappingFromEvent — Creates input mapping for a particular analysis event. The mapping is created from the event corresponding to the specified ID of the analysis event.
|
analysisEventId
|
String
|
Specifies the ID of the analysis event for which mapping is to be defined.
|
Returns the ID of the mapping that is created.
|
|
|
eventProperty
|
String
|
Specifies the name of the property from an event to be the mapping source.
|
|||
|
eventPropertyPath
|
String
|
Specifies the path to the eventProperty from the root of the data shape. This parameter is optional. The value can be an empty string or null if the field is not within an infotable. If the property is a part of nested infotables, the path must be separated by a ‘.’ (dot).
For example: If property p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then evenpropertyPath is specified as Infotable1.Infotable2.
|
|||
|
propertyBaseType
|
Basetypename
|
Specifies the base type of the event property.
|
|||
|
propertyDS
|
Datashapename
|
Specifies the data shape if the propertyBaseType is an infotable.
|
|||
|
targetAnalysisInputDsField
|
String
|
Specifies the name of the field from the analysis input data shape to be the target of mapping.
|
|||
|
targetAnalysisInputDsFieldPath
|
String
|
Specifies the path to the target field from the top-level infotable. The value can be an empty string or null if the field is not within an infotable. If the field is nested within infotables, the path must be separated by a ‘.’ (dot).
For example: If field a to be used in mapping is nested within infotables, [provider].[model].InputParamsDatashape->Level1InfoTable->Level2Info->a, then the path should be Level1InfoTable.Level2Info. Here, you can skip the InputParamsDatshape since it is the default root associated with the inputDatashape of the model.
|
|||
|
targetAnalysisInputDsBaseType
|
Datashapename
|
Specifies the base type of the target field.
|
|||
|
targetAnalysisInputDsFieldDS
|
Datashapename
|
Specifies the data shape if the targetAnalysisInputDsBaseType is an infotable.
|
|||
|
CreateResultMapping — Creates result mapping for a particular analysis event. The mapping is created from the result fields of the analysis to the specified target field.
|
analysisEventId
|
String
|
Specifies the ID of the analysis event for which mapping is to be defined.
|
Returns the ID of the mapping that is created.
|
|
|
sourceAnalysisResultDatashapeField
|
String
|
Specifies the name of the field from the result of analysis.
|
|||
|
sourceAnalysisResultDsFieldPath
|
String
|
Specifies the path to the source field from the top-level infotable. The value can be an empty string or null if the field is not within an infotable. If the field is nested within infotables, the path must be separated by a ‘.’ (dot).
For example: If field a to be used in mapping is nested within infotables, [provider].[model].ResultDatashape->Level1InfoTable->Level2Info->a, then the path should be Level1InfoTable.Level2Info. Here, you can skip the ResultDatashape since it is the default root associated with the resultDatashape of the model.
|
|||
|
sourceAnalysisResultDsFieldBaseType
|
Basetypename
|
Specifies the base type of the source field.
|
|||
|
sourceAnalysisResultDsFieldDS
|
Datashapename
|
Specifies the data shape name if the base type of the result field is an infotable.
|
|||
|
targetEntityName
|
String
|
Specifies the name of the entity.
|
|||
|
targetFieldName
|
String
|
Specifies the name of the target field.
|
|||
|
targetFieldPath
|
String
|
Specifies the path to the targetFieldName from the root of the data shape. This parameter is optional. The parameter can be an empty string or null if the field is not within an infotable. If the field is nested within infotables, the path must be separated by a ‘.’ (dot).
For example: If property p to be mapped is a part of nested infotables, Infotable1->Infotable2->p, then targetFieldPath is specified as Infotable1.Infotable2.
|
|||
|
targetFieldBaseType
|
Basetypename
|
Specifies the base type of the target field.
|
|||
|
targetPropertyDS
|
Datashapename
|
Specifies the data shape name if the base type of the target field is an infotable.
|
|||
|
targetEntityType
|
String
|
Specifies the type of entity that the event is to be created on as one of the following:
• Thing
• Thing template
• Thing shape
This parameter is optional.
|
|||
|
DeleteMapping — Deletes the specified result or input mapping.
|
mappingId
|
String
|
Specifies the ID of the analysis input mapping or result mapping.
|
Returns a message that states either the successful completion or errors that occur during the execution of the service.
|
|
|
GetInputMappings — Retrieves all input mappings defined for a particular analysis event.
|
analysisEventId
|
String
|
Specifies the ID of the analysis event.
|
Returns all the input mappings defined for a given analysis event. This is an infotable in the same format as TW.AnalysisServices.AnalysisFieldMappingDataShape.
|
|
|
GetResultMappings — Retrieves all result mappings defined for a particular analysis event.
|
analysisEventId
|
String
|
Specifies the ID of the analysis event.
|
Returns all the result mappings defined for a given analysis event. This is an infotable in the same format as TW.AnalysisServices.AnalysisFieldMappingDataShape.
|
|
