School Defined Field Integration

In certain instances, your institution may come across the need to record information about its students, information other than the standard fields provided by the standard out-of-the-box version of Anthology Student. In such instances, Anthology Student provides you, as the application administrator, the option to define and create data fields that are unique to operations in your institution. Such fields unique to that institution are called School Defined Fields (SDFs).

Anthology Student provides the option to create SDFs under its Setup>School Defined Field Setup option. Refer to Anthology Student Online Help, for more information on creating and recording School Defined data.

When your installation of Anthology Student has SDFs, these fields are tracked by the system, and they need to be integrated with the CampusNexus CRM system. The objects that are affected are the Student Object in Anthology Student that is mapped to the Contact Object in CampusNexus CRM. As a result, changes made are only at the Object property level and affect only the Student and Contact objects.

Execute the following steps, in the given sequence, for the Connector component to handle data integration between the two systems correctly.

Direction of Integration

Support is provided for bidirectional integration of Anthology Student School Defined Fields with Custom Properties on the Student Object in CampusNexus CRM.

Supported SDF Data Types

The Connector supports different data types for the integration of SDFs between Anthology Student and CampusNexus CRM. The following table outlines the supported data types and associated supported constraints.

Supported Data Types
Anthology Student Data Type	CampusNexus CRM Data Type	Validation Supported	List Values Supported	Range Values Supported	Multi-Select List Values Supported
Character	Text	Yes	Yes	N/A	No
Numeric	Number	Yes	Yes	Yes	No
Date	Date	Yes	Yes	No	No

Enable SDF Integration

When SDFs are created, edited, or deleted in Anthology Student, perform the following steps to enable integration of SDFs between Anthology Student and CampusNexus CRM:

(Refer to Anthology Student Help for more information on creating, editing, or deleting SDFs).

Identify the SyUserDictID for each SDF. Run the following SQL query in the Anthology Student Database to determine the SyUserDictID for each Anthology Student SDF that you want to integrate to CampusNexus CRM:

select syUserDictID from syUserDict where Descrip = 'Test SDF Enum'

where, the Descrip column holds labels of the School Defined Field.

Update the SyRegistry table to integrate all or specific SDFs between Anthology Student and CampusNexus CRM. Based on your requirement, run one of the following SQL queries to update the SyRegistry table:

To integrate all SDFs

exec dbo.proc_SyUpdateSyRegistry
@RegKey = 'CrmSDFAll',
@RegValue = '-1',
@DisplayOrder = 0,
@Prompt = 'Crm SDF',
@ListType = '',
@ValueList = '',
@LongPrompt = '',
@MaxLength = 10

To integrate specific SDFs

exec dbo.proc_SyUpdateSyRegistry
@RegKey = 'CrmSDF1',
@RegValue = '64', --> syUserDictID for Test SDF Enum
@DisplayOrder = 0,
@Prompt = 'Crm SDF',
@ListType = '',
@ValueList = '',
@LongPrompt = '',
@MaxLength = 10

In a fresh installation of Anthology Student, there will not be any entry for SDFs in the SyRegistry table. Therefore none of the SDFs will be integrated. However, if there are some entries in the SyRegistry table in an existing installation, and you do not want to integrate any SDFs between Anthology Student and CampusNexus CRM, run the following SQL query:

delete from SyRegistry where RegKey like 'CRMSDF%'

Modify the CampusNexus CRM Contact Object that is integrated with the Anthology Student Student Object. Determine the Property ID for each Contact Property.

Select * from tblcolumnmain in the TlMain CampusNexus CRM Database to determine the Property ID for each CampusNexus CRM Custom property that you want to integrate to Anthology Student.
Modify the FieldMapConfig.CampusVueAgent.Custom.xml and FieldMapConfig.TalismaAgent.Custom.xml Connector XML mapping files to meet integration requirement(s). In the FieldMapConfig XML configuration files, link the Anthology Student SDF ID with the CampusNexus CRM Contact Property ID.
Notes:
- You cannot configure multiple SDFs in a single action.
- For SDF field integrations that have enumerated values, in addition to the modifying the FieldMapConfig.CampusVueAgent.Custom.xml file per the standard above, the mappings for SDFs in the FieldMapConfig.CampusVueAgent.Custom.xml and FieldMapConfig.TalismaAgent.Custom.xml files must be modified to include a <LookupName> node that contains the CampusNexus CRM Constraint ID. This is in addition to the standard the <SrcLabel> and <TgtLabel> nodes for these mapping files.
  
  Example:
```

    <FieldMapList>
      <Name>SDF</Name>
      <Items>
        
        <FieldMap>
          <SrcLabel>64</SrcLabel>
          <TgtLabel>21477</TgtLabel>
          <LookupName>10138</LookupName>
        </FieldMap>
      </Items>
    </FieldMapList>
```
1. Modify the FieldMapConfig.CampusVueAgent.Custom.xml file by adding a mapping for each SDF that you want to integrate from Anthology Student to CampusNexus CRM.
  
  Sample SDF section from the FieldMapConfig.CampusVueAgent.Custom.xml file:
```

      <Name>SDF</Name>
      <Items>
        <FieldMap>
          <SrcLabel>5</SrcLabel> (This is the SYUserDictID for the CampusNexus Student SDF)
          <TgtLabel>21477</TgtLabel> (This is the Contact Property ID for CampusNexus CRM)
        </FieldMap>
        <FieldMap>
          <SrcLabel>6</SrcLabel>
          <TgtLabel>21478</TgtLabel>
        </FieldMap>
      </Items>
    </FieldMapList>
```
2. Modify the FieldMapConfig.TalismaAgent.Custom.xml file by adding a mapping for each SDF that you want to integrate from CampusNexus CRM to Anthology Student.
  
  Sample SDF section from the FieldMapConfig.TalismaAgent.Custom.xml file:
```

      <Name>SDF</Name>
      <Value>SDF</Value>
      <Items>
        <FieldMap>
          <SrcLabel>21477</SrcLabel> (This is the Contact Property ID for CampusNexus CRM)
          <TgtLabel>Course Information</TgtLabel> (This is the SDF property name for the CampusNexus Student SDF)
        </FieldMap>
        <FieldMap>
          <SrcLabel>21478</SrcLabel>
          <TgtLabel>Catalog Year</TgtLabel>
        </FieldMap>       
      </Items>
```
Restart the Connector Windows Service.
Verify that the integration is working correctly.