Configurations in Integration Mapping Records

Importing test score information into Anthology Reach is based on logic defined in Integration Mapping records. The source column from which information is imported is defined in the Parameters field. If additional formatting or processing is required to complete the import, such settings are also specified in the Parameters field after the field {External field name}. In addition, values in the following fields are important:

  • External Field Name
  • Mapping Type
  • External Option Value
  • Internal Option Value
  • Dataset Name
  • Data Transformation Type
  • External Option Display Name
  • Internal Option Display Name

  • Record Type - The value in this field uses the, <Parent entity name>.<Child entity name>.<nth-record number>, format.

    The following table provides some example values for the Record Type field.

    Parent Entity Child Entity Name Record Number Record Type
    contact     Contact
    customeraddress Contact's Address 1 Contact.Address.1
    mshied_previouseducation Contact's PreviousEducation 1 Contact.PreviousEducation.1
    mshied_areaofinterest Contact's AreaOfInterest 1 Contact.AreaOfInterest.1
    mshied_extracurricularParticipant Contact's ExtraCurricularParticipant 1 Contact.ExtraCurricularParticipant.1
    mshied_extracurricularParticipant Contact's ExtraCurricularParticipant 2 Contact.ExtraCurricularParticipant.2
    mshied_testscore Contact's TestScore 1 Contact.TestScore.1
    cmc_applicationregistration Contact's ApplicationRegistration 1 Contact.ApplicationRegistration.1
    cmc_application Contact's ApplicationRegistration.1.Application 1 Contact.ApplicationRegistration.1.Application.1

Data Transformation Types for Import

The following table describes the values that can be configured in the Parameters field for each of the Data Transformation Type.

Administrators can use the table to understand usage of Integration Mapping records. The import framework in Integration Mapping records can be copied and then applied to new fields, or administrators can edit current mappings to enable application to scenarios unique to their institution. It is recommended that administrators make changes or enhance the import framework only after being completely aware of the implications of attempting such a change.

Value in the Data Transformation Type Field

Description - Parameters Field
CAMELCASE In the Parameters field of the integration mapping record, replace the following with the name of the field in which the value that must be displayed in camel case is stored:

{External Field Name}

The value will be imported in camel case text, i.e., the letter of each new word will be in upper case.

Camel case logic will apply only to letters, and not numerals or other characters.

Example

The value in the City field is NEW YORK, it will be imported into Anthology Reach as New York.
COALESCE Values from multiple fields in the source file are considered to determine the value of the mapped field in Anthology Reach.

Example

  1. The Gender Code field in Anthology Reach can be updated based on the value of the Gender Numeric or Gender Alpha source fields.
  2. To enable this logic, the following text is typed in the Parameters field in the Integration Mapping record:
    {Gender Numeric},{Gender Alpha}.
  3. The Internal Field Name field must be set to Gender Code.
    Unique integration mapping record must be available for each source field - in this example they are Gender Numeric and Gender Alpha. Additionally, the Internal Field Name field in such records must be blank.
  4. The first field in which the value is not null will be considered and its corresponding value will be set in the Gender field in Anthology Reach.
    To change the integration mapping definition, add or edit fields within curly braces in the Parameters field.
CONCATENATE Values from multiple source fields are merged in the order defined in the integration mapping record and then updated in the mapped field in Anthology Reach.

Example 1

  1. The source fields AreaCode and Phone are mapped to the Mobile field in Anthology Reach.
  2. The following text is typed in the Parameters field in the Integration Mapping record:
    {AreaCode},{Phone}.
    To change the integration mapping definition, add or edit fields within curly braces in the Parameters field.

Example 2

  • To include specific special characters, you can type the following in the Parameters field:

    +{CountryCode},-,{AreaCode},-,{Phone}

    The merged phone number will be displayed as follows: +1-516-2359334
DATE Values in the source date field are imported based on the following text in the Parameters field in the Integration Mapping record:

{External Field Name},<format>

Replace the text <format> with one of the following values:

  • yyyyMMdd
  • yyyyddMM
  • ddyyyyMM
  • ddMMyyyy
  • MMyyyydd
  • MMddyyyy

The imported date will be segregated into year, month and date values based on the suffixed format. The month format (MM) must be typed in upper case.

Standard date separators can also be used in the format. For example, the format can be dd/MM/yyyy.
DIVIDE The value in the source field or a number is divided by another external field or a number that's placed after the comma:

{External field name or a number},{External field name or a number}

Example 1

{Score},{100}

The External Field Name Score is mapped to the Marks field in Anthology Reach.

The value in the Score field is 255 and the value after the comma is 100. In this scenario, the value 2.55 will be saved in the Marks field, i.e., 255 will be divided by 100.

Example 2

{255},{Divisor}

The value 255 can be typed directly, and it can be divided by a field called Divisor which has the value 100. The value 255 is mapped to the Marks field in Reach. In this scenario, the value 2.55 will be saved in the Marks field.

Notes:

  • The value in the {External Field Name} will not be imported if it’s a non-numeric value.
  • If the format of the destination field is not compatible with storing a decimal number, the number will be rounded to the nearest non-decimal number
EXCLUDEWHENBEGINSWITH If the value in the source field begins with a specific character, the content of the field must not be updated in the mapped field in Anthology Reach.

Example

  1. If the source field Country Code begins with the value 00, the value in the mapped field Country_Code must not be updated in Anthology Reach.
  2. The following text is typed in the Parameters field in the Integration Mapping record:
    00,{Country Code}
HASANYVALUE Returns a Boolean value which signifies if at least one of the comma-separated values in the Parameters field has any value.
  • True: At least one of the fields has a value.
  • False: None of the fields has a value.

The Parameters field will include comma-separated external field names in curly braces.

Example

{ExternalField1-Record1},{ExternalField2-Record1},{ExternalField3-Record1}

This logic helps identify if, in a record on the many side of a one-to-many relationship, all fields in the source file are empty, thus preventing creation of the record. In a record, this transformation identifies if all data fields in a record (on the many side in a One-to-Many relationship) are empty, hence preventing record creation.

The HASANYVALUE and LOGICALAND values are typically used concurrently.

IF If the source field has a specific value, the value in another source field must be updated in the mapped destination field.

Example

  1. If the source field Type of Telephone has the value 2356, the value of the Telephone source field must be updated in the Student Phone field in Anthology Reach. If the value is not 2356, the value of the Mobile source field must be updated in the Student Phone field in Anthology Reach.
  2. The following text is typed in the Parameters field in the Integration Mapping record:
    {Type of Telephone},2356,{Telephone} {Mobile}.
  3. The schema name of the Student Phone field must be typed in the Internal Field Name field.
    To change the integration mapping definition, change the fields within curly braces in the Parameters field. Additionally, the value 2356 can be replaced with a another field in curly braces.
LOGICALAND Returns a Boolean value that signifies if creation of a record must be skipped:
  • True: The record is valid and must be created.
  • False: Record creation must be skipped.

For information about skipping record creation, see the section To Skip Entity Creation in the topic Logic for Creating and Skipping Records During Import.
LOOKUP {External Field Name},<Dataset>,<Schema name of the entity>,<Schema name of the field based on which association with the parent entity occurs>,<Optional default value>

The above text must be set in the Parameters field in the Integration Mapping record that is associated with the Integration Mapping records that comprise the dataset.

Example

Records of the Area of Interest entity are being imported, and in the Contact form, the criterion to search for an Area of interest record is the Name field. The following area of Interest records are being imported:

  • Humanities
  • Engineering
  • Zoology

To map these fields, the following Integration Mapping records are required:

  • Three integration mapping records, one for each of the above values. Values in the records must be updated as follows:
    • Mapping Type - The value DataMapping must be set.
    • External Option Display Name - In each record, type a unique source value that equates to each of the above values in Anthology Reach.
    • Internal Option Display Name - One of the following values:
      • Humanities
      • Engineering
      • Zoology

      In each Integration Mapping record, each field must be mapped to a value in the Internal Option Display Name field.

    • Dataset Name - The name of the dataset. This value must be identical in integration mapping records that comprise the dataset. In this scenario, three records must have the same value.
    • Data Transformation Type - Must be blank.
    • Parameters - Must be blank
  • An associated integration mapping record in which the following values will be included:
    • Mapping Type - Must be set to Field
    • Dataset Name - Must be blank.
    • Data Transformation Type - Must be LOOKUP
    • Parameters: {External Field Name},<Dataset>,<Schema name of the entity>,<Schema name of the field based on which association with the parent entity occurs>,<Optional default value>
      The <Dataset> must be identical to the value set in the three integration mapping records created above.
      The <Optional default value> will be set for source values of the Area of Interest if a corresponding integration mapping record is not available.
      For example, with integration mapping records available only for Humanities, Engineering and Zoology, if source values Mathematics, Chemistry and Political Science are also imported, institutions can configure a single corresponding default value to be set because these new subjects are not part of the required dataset at the institution. In this case, the equivalent value for these new subjects can be Other, which will be the text that is set in the <Optional default value>. When the import occurs, the value Other will be set for Mathematics, Chemistry and Political Science.

      • Notes:

      • The record for the value Other must be available in Anthology Reach.
      • If a direct mapping of an area of interest record exists in Anthology Reach, its status must be Active.
      • If a lookup mapping and a direct mapping are available for the same area of interest record, the lookup mapping record will be considered during the import operation.
      • If the lookup and direct mapping records are unavailable in Anthology Reach, the value will be set to Other.

In the Area of Interest lookup field in the Contact form, newly imported records can be searched based on the value in their Name field. This occurs as association of the imported records with the Contact entity is based on the schema name of the Name that's typed in the placeholder <Schema name of the field based on which association with the parent entity occurs>.

If a new Area Of Interest, Languages, needs to be included, you need to create an integration mapping record that's similar to any of the three integration mapping records created above. However, the value in the Internal Option Display Name field must be Languages.

Administrators can use this example as a framework to create integration mapping records in business cases that are applicable to their institution.

Note
To support the import of single entity value in a polymorphic lookup field, specify True as the last value in the Parameter field as shown below:
{External Field Name},<Dataset>,<Schema name of the entity>,<Schema name of the field based on which association with the parent entity occurs>,<Optional default value>,True

A polymorphic field is a single lookup type column or field which can refer to multiple other tables. For example, the Staff Member field of the Success Network entity is a polymorphic field that enables selecting a User or a Contact record.
LOWERCASE The value in the source field will be imported in lower case text, i.e., all letters in the word will be in lower case.

Example

The value in the Middle Name field is ROGER or Roger, it will be imported into Anthology Reach as roger.
NUMBER Values in the source data are imported based on the following logic:

{External Field Name},<optional number for decimal precision>

OR

<Value>

Example

In the following examples, the External Field Name Score is mapped to the Marks field in Anthology Reach.

  • In place of the optional number for decimal precision, if the value 2 is specified, the value 456 in the Score field will be recorded in the Marks field as 4.56, i.e., a decimal will be placed 2 digits to the left of the last digit.
  • In the External Field Name, the value 45 can be set Instead of Score.
    When records are imported, the value 45 will be set in all records that qualify to be updated instead of values in the Score column of the source file. In this scenario, the optional number for decimal precision is not specified.

Note: If the format of the destination field is not compatible with storing a decimal number, the number will be rounded to the nearest non-decimal number.
PREFIX The value in the source field must be prefixed with the specified character when its imported into the mapped field in Anthology Reach.

Example

  1. The source field Country Code must be prefixed with the + symbol when its imported into the mapped field Country_Code.
  2. The following text is typed in the Parameters field in the Integration Mapping record:
    +,{Country Code}
SUFFIX The value in the source field must be suffixed with the specified character when its imported into the mapped field in Anthology Reach.

Example

  1. The source field Mobile Phone must be suffixed with the text (Do not call) when its imported into the mapped field Mobile.
  2. The following text is typed in the Parameters field in the Integration Mapping record:
    DNC,{Mobile Phone}
STRING The value in the field defined in the External Field Name will be imported into the current record.
OPTIONSET

MULTISELECTOPTIONSET

TWOOPTIONS

 {External Field Name},<Dataset>

Substitute the text <Dataset> with the value that is typed in integration mapping records in the Dataset Name field.

A dataset can be equated to a set of values that can be updated in a field. For example, the Address Type field in an Address record can have one of the following values:

  • Permanent
  • Temporary
  • Campus
  • Vacation

To map these fields, the following Integration Mapping records are required:

  • Four integration mapping records, one for each of the above values. Values in the records must be updated as follows:
    • Mapping Type - The value DataMapping must be set.
    • External Option Value - In each record, type a unique source value that equates to each of the above values in Anthology Reach.
    • External Option Value - One of the following values:
      • Permanent
      • Temporary
      • Campus
      • Vacation

      In each Integration Mapping record, each of these fields must be mapped to a value in the Internal Option Value field.

    • Dataset Name - The name of the dataset. This value must be identical in integration mapping records that comprise the dataset. In this scenario, four records must have the same value.
    • Data Transformation Type - Must be blank.
    • Parameters - Must be blank
  • An associated integration mapping record in which the following values will be included:
    • Mapping Type - Must be set to Field
    • Dataset Name - Must be blank.
    • Data Transformation Type - One of the following values
      • OPTIONSET
      • MULTISELECTOPTIONSET
      • TWOOPTIONS
    • Parameters: {External Field Name},<Dataset>
      The <Dataset> must be identical to the value set in the four integration mapping records created above.

Example

Temporary and permanent address information of the contact John Doe is being imported into Anthology Reach. When the import is complete, the user can view two address records with unique values in the Address Type field (Temporary and Permanent) in Anthology Reach.

If a new Address Type, Shipping, needs to be included, you need to create an integration mapping record that's similar to any of the four integration mapping records created above. However, the value in the Internal Option Value field must be Shipping.

Administrators can use this example as a framework to create integration mapping records in business cases that are unique to their institution.
UPPERCASE In the Parameters field of the integration mapping record, replace the following with the name of the field in which the value that must be displayed in upper case is stored:

{External Field Name}

The value in the source field will be imported in upper case text, i.e., all letters in the word will be in upper case.

Example

The value in the City field is New York, it will be imported into Anthology Reach as NEW YORK.