global static List<fferpcore.MappingService.CustomMapping> getCustomMappings(String process)

Retrieve the custom mappings for a specific process.
The process must match the name of the Foundations configuration item, including the relevant namespace prefix.
The Process field on the Foundations configuration item record must contain: Foundations Mapping Process.

Input Parameters

Return Value

A list of custom mappings for the specified process.

global static Map<String, List<fferpcore.MappingService.CustomMapping>> getCustomMappings(Set<String> processes)

Retrieve the custom mappings for multiple processes.
The processes must match the names of the Foundations configuration items, including the relevant namespace prefixes.
The Process field on each Foundations configuration item record must contain: Foundations Mapping Process.

Input Parameters

Return Value

A map of custom mappings objects for the specified processes, keyed by process name.

global CustomMapping(String process, List<List<String>> sourceKeys, List<List<String>> targetKeys)

Create a custom mapping.
Necessary when overriding the custom mappings in a fferpcore.MappingDescriber .

Input Parameters

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

String process = 'c2g__SomeProcess';

List<List<String>> sourceKeys = new List<List<String>>{
    new List<String>{'SomeRelationship__r', 'SomeSourceField__c'},
    new List<String>{'SomeOtherRelationship__r', 'SomeOtherSourceField__c'}
};

List<List<String>> targetKeys = new List<List<String>>{
    new List<String>{'SomeTargetField__c'}
};

fferpcore.MappingService.CustomMapping customMapping =
    new fferpcore.MappingService.CustomMapping(process, sourceKeys, targetKeys);

global fferpcore.MappingService.CustomMapping withName(String name)

Specify a name for the custom mapping.
If no name is specified, a name is generated in the form: custom_[SourceKey].

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withType(String type)

Specify the custom mapping type.
If no type is specified, the default type of Standard is used.

The following values are valid:

• fferpcore.MappingService.MAPPING_TYPE_STANDARD
• fferpcore.MappingService.MAPPING_TYPE_RELATIONSHIP

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withSourcePath(List<String> path)

Specify the source path of the custom mapping.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

Sample Data

List<String> path: new List<String>{'SomeRelationship__r', 'SomeNestedRelationship__r'}

global fferpcore.MappingService.CustomMapping withTargetPath(List<String> path)

Specify the target path of the custom mapping.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

Sample Data

List<String> path: new List<String>{'SomeRelationship__r', 'SomeNestedRelationship__r'}

global fferpcore.MappingService.CustomMapping withTransformationTable(Id transformationTable)

Specify a data transformation table to apply to the custom mapping.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withStaticData(String staticData)

Specify the static data for the custom mapping.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withStaticDescription(String staticDescription)

Specify a description for the static data in the custom mapping.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withCorrelationStrategy(String correlationStrategy)

Specify a correlation strategy for the custom mapping to determine whether child records are created or updated.
The following values are valid:

• Append
• Replace
• Update
• UpdateTotal

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withCorrelationSourceKey(List<String> correlationSourceKey)

Specify the field on the source that contains a unique identifier.
This is used to synchronize source and target data.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withCorrelationTargetKey(String correlationTargetKey)

Specify a field on the target in which to store the source's unique identifier.
The unique identifier is compared when updating the target.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withFilters(List<String> filters)

Specify a filter that determines whether to create or update target records.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withLookupField(String lookupField)

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withAdditionalLookupField(String additionalLookupField)

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withTargetChildType(String targetChildType)

Specify the name of the category for the target child record.
Target child types enable you to create multiple target child records from a single source child record.
For example, Default, Debit Line, or Admin Fee.
If blank, Default is assigned as the target child type.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withCondition(List<String> condition)

Specify the condition key to use for this mapping.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withDisabled(Boolean disabled)

Specify whether the mapping is disabled. If null or not specified using this function or withEnabled(), the mapping cannot be disabled in the FDN Mappings component.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global fferpcore.MappingService.CustomMapping withEnabled(Boolean enabled)

Specify whether the mapping is enabled. If null or not specified using this function or withDisabled(), the mapping cannot be disabled in the FDN Mappings component.

Input Parameters

Return Value

The CustomMapping instance to allow further method calls.

global String getProcess()

Return Value

The process this custom mapping belongs to.

global String getName()

Return Value

The name of the custom mapping. Null if no name was provided.

global String getType()

Identify the type of the custom mapping.

The following values can be returned:

• fferpcore.MappingService.MAPPING_TYPE_STANDARD
• fferpcore.MappingService.MAPPING_TYPE_RELATIONSHIP

Return Value

The type of the custom mapping.

global List<List<String>> getSourceKeys()

Return Value

All the source key paths.

Sample Data

SomeField__c
SomeLookup__r, SomeOtherField__c

global List<String> getSourceKey()

Return Value

The first source key path.

Sample Data

SomeLookup__r, SomeOtherField__c

global String getSingleSourceKey()

Return Value

The first source key in the first source key path.

Sample Data

SomeField__c

global List<List<String>> getTargetKeys()

Retrieve the target keys for the custom mapping.
This is not currently required. The FDN Mappings component currently only supports mappings with a single target key.

Return Value

All the target key paths.

global String getSingleTargetKey()

The first target key in the first target key path.

Sample Data

SomeTargetField__c

global List<String> getSourcePath()

Return Value

The relationship keys that identify the location of the source data in the record hierarchy.

Sample Data

SomeRelationship__r, SomeNestedRelationship__r

global List<String> getTargetPath()

Return Value

The relationship keys that identify the location of the target data in the record hierarchy.

Sample Data

SomeRelationship__r, SomeNestedRelationship__r

global Id getTransformationTable()

Return Value

The record ID of the data transformation table associated with the mapping.

global String getStaticData()

Return Value

The exact value to map to the target location.

global String getStaticDescription()

Return Value

The description of the static data.

global String getCorrelationStrategy()

Identify the correlation strategy of the custom mapping.
The following values can be returned:

• Append
• Replace
• Update
• UpdateTotal

Return Value

The correlation strategy, which specifies how to create and maintain linked data.

global List<String> getCorrelationSourceKey()

Return Value

The field on the source that contains a unique identifier. This is used to synchronize source and target data.

global String getCorrelationTargetKey()

Return Value

The target field that contains the source's unique identifier. The unique identifier is compared when updating the target.

global List<String> getFilters()

Return Value

The source field that determines whether records are created or updated. For records to be created or updated, the value must evaluate to true.

global String getLookupField()

Return Value

The API name of the primary field on the source. This is used for lookup mappings to identify a lookup record.

global String getAdditionalLookupField()

Return Value

The API name of an additional field on the source. This is used for lookup mappings to identify a single lookup record when record names are not unique.

global String getTargetChildType()

Return Value

The name of the category for the child record. Target child types enable you to create multiple target child records from a single source child record.

Sample Data

Default, Debit Line, Admin Fee

global List<String> getCondition()

Return Value

The condition key for this mapping. Conditions enable you to update a target field based on specific information on the source. When specified, the source data value must evaluate to true for the mapping to be applied.

global Boolean getDisabled()

Return Value

The value that indicates whether the mapping is currently disabled. A null value indicates that this mapping cannot be disabled in the FDN Mappings component.

global Boolean getEnabled()

Return Value

The value that indicates whether the mapping is currently enabled. A null value indicates that this mapping cannot be disabled in the FDN Mappings component.