Configure Service Module Options

In the ServiceManagerConfiguration.config XML file, the root element, ConnectorConfigurations, contains four sets of child elements, each named ConnectorConfiguration. Each CampusVueConnectorConfiguration element, in turn, has individual child elements that contain the configuration settings.

The four sets of ConnectorConfiguration elements correspond to the four modules, and two special sets contain options for the CampusVue Agent module. The component name elements, ComponentName at the beginning of each element set identify the service modules to which that set’s options belong.

The four components are:

• Cmc.CampusVueConnector.CampusVueAgent
• Cmc.CampusVueConnector.TalismaAgent
• Cmc.CampusVueConnector.CampusVueAgent.Orphan
• Cmc.CampusVueConnector.CampusVueAgent.Purge

At the beginning of each ConnectorConfiguration element set, certain general options common to all four service modules are made available. Next, each element set contains a Settings child element that has options specific to each service module.

When required, you modify default values of these options that come with the ServiceManagerConfigurationCustom.Config XML file.

The general steps involved in setting a value for the configurable options are the same for all options. These steps are described first in the Task section shown next. The actual configurable options with the default values are listed in the sections that follow.

1. Navigate to the C:\Program Files\CMC\C2000\CampusVue Connector folder in the system where the Connector Service Manager is installed by default.

2. Edit the ServiceManagerConfigurationCustom.config file and save it.

   1. Locate the ServiceManagerConfigurationCustom.config file and open it using an XML editor.

   2. Modify the specific configuration option(s). (Refer to the options shown in the tables in the sections that follow.)

   3. Save the ServiceManagerConfigurationCustom.config file.

3. Start (or restart) the Windows Service.

The Connector Service Manager automatically encrypts passwords of the CampusNexus CRM and Anthology Student systems, within the ServiceManagerConfigurationCustom.config file, after the Windows Service is started.

If you choose to modify the username and password fields after the service has been started and running for a while, you need to stop the service and reconfigure this file. In such cases, ensure that you clear the encrypted text within the username and password fields within the file, and re-enter these fields.

General Options

Each ConnectorConfiguration element set in the ServiceManagerConfiguration.config XML file has eleven general options common to the four service modules and made available under the six components.

In the following table the default values of the eleven general options are shown for the CampusVue Agent module. Using this table as a guide, you can modify the default values of options under all six components.

Options in CampusVueConnectorConfig.config
Option: ComponentName Description: Unique name used to store configuration in the service. Default Value: Cmc.CampusVueConnector.CampusVueAgent
Option: Description Description: Description of process. Default Value: Cmc.CampusVueConnector.CampusVueAgent
Option: AssemblyPath Description: The dll file path location. Default Value: C:\Program Files\CMC\C2000\Services\CampusVue Connector Service Manager
Option: DllName Description: Name of dll file to load. Default Value: Cmc.CampusVueConnector.CampusVueAgent.dll
Option: ClassName Description: Name of class within dll file that executes. Default Value: Cmc.CampusVueConnector.CampusVueAgent.MessageProcessor
Option: Interval Description: Number of milliseconds that service pauses before re-loading dll file. Default Value: 20000 To optimize the performance of the Connector, decrease this value to 2000 milliseconds.
Option: NumberOfModules Description: Number of instances of each Connector module that has to be created at start up. Default Value: 1 Increasing the number of modules will increase the performance of the Connector.
Option: Active Description: Flag indicating whether dll file ought to be loaded. Default Value: false
Option: AuthenticationUrl Description: URL of CampusLink Authentication API. Default Value: http://localhost:11008/cmc.campuslink.webservices.security/Authentication.asmx

CampusVue Agent Module Options

The CampusVue Agent module has nine configurable options that are available under the following components:

• Cmc.CampusVueConnector.CampusVueAgent
• Cmc.CampusVueConnector.CampusVueAgent.Orphan
• Cmc.CampusVueConnector.CampusVueAgent.Purge

CampusVueAgent Options

The following table lists the options of the Cmc.CampusVueConnector.CampusVueAgent component:

Options in Cmc.CampusVueConnector.CampusVueAgent
Option: FieldMapConfig Description: Full path and name of the mapping XML file. Default Value: C:\Program Files\CMC\C2000\Services\CampusVue Connector Service Manager 12.1.A\FieldMapConfig.CampusVueAgent.xml
Option: TalismaUser Description: Username of the System Administrator level user of CampusNexus CRM. Default Value: TalismaAdmin
Option: TalismaPassword Description: Password of the System Administrator level user of CampusNexus CRM. Default Value: talisma
Option: TalismaLoginType Description: Talisma Login Type. Default Value: 2
Option: TalismaUrlBase Description: The URL of CampusNexus CRM iServices. Default Value: http://CltDevCrm3/HEFoundationiService/SISConnectorSvc.asmx
Option: PendingMsgCount Description: The number of messages that will be processed each time the process runs. Default Value: 10 To optimize the performance of the Connector, set this value to 10.
Option: MaxLoopCount Description: The number of time the process will run before the dll unloads. Default Value: 100 To optimize the performance of the Connector, set this value to 500.
Option: LogCounters Description: The log that records the number of messages processed, the number of messages that were processed successfully, and the number of messages that had errors. To log the number of records processed by the connector, set this value to 1. Default Value: 0 To optimize the performance of the Connector, set this value to 0.
Option: ValidEmailText Description: A list of e-mail address values that can be set in this configuration file. If a value set in this option matches with an e-mail address in CampusNexus CRM, the value in the option will be set to blank. Default Value: Do not contact

E-mail Address Validation

In Anthology Student, there is no validation for the e-mail address property. However, in CampusNexus CRM, the e-mail address property is validated for its format. This causes errors in the Connector during data integration from Anthology Student to CampusNexus CRM. To resolve this issue, during data integration, format validation is performed for the values in the e-mail address property in Anthology Student. If the format validation is successful, the value in the e-mail address property is sent to CampusNexus CRM.

Examples of e-mail addresses that are valid in Anthology Student but invalid in CampusNexus CRM are n/a, 414-315-0687, b/a, dnc, Do Not Contact, E-Mail, and falpax.

No value is sent to the e-mail address property in CampusNexus CRM if:

• The format validation fails.

• The e-mail address property contains any of the text that is configured in the ValidEmailText option in the Cmc.CampusVueConnector.CampusVueAgent component.

The value of the corresponding e-mail address property in CampusNexus CRM will be blank.

The following text values can be configured for the ValidEmailText option: dnc, Do Not Contact, n/a, etc.

Further, if any property other than e-mail address is updated in CampusNexus CRM, during data integration, the CampusLink API validates the value of the e-mail address property sent from CampusNexus CRM with the corresponding property available in Anthology Student. As there is a mismatch between the e-mail address property values in CampusNexus CRM and Anthology Student, an API error occurs. To resolve this issue, code for e-mail validation must be removed from the CampusLink API. To do so:

1. Open the Cmc.CampusLink.Soa.BusinessProcess.Master.config file in an edit mode. The file is available in the cmc.campuslink.webservices API folder.

2. Navigate to the following section:

   <validation name="AddNewLeadInMsgValidation">

3. Delete the following code:

   <field name="Email" type="System.String" operator="EMAIL" />

4. Navigate to the following section:

   <validation name="UpdateStudentInfoInMsgValidation">

5. Delete the following code:

   <field name="Email" type="System.String" operator="EMAIL" />

6. Save the Cmc.CampusLink.Soa.BusinessProcess.Master.config file.

CampusVueAgent.Orphan Options

The following table lists the options of the Cmc.CampusVueConnector.CampusVueAgent.Orphan component. Orphaned records in the CmSISQueue table within Anthology Student are defined as a record where the Status is 1 and the TagID is not Null.

Options in Cmc.CampusVueConnector.CampusVueAgent.Orphan
Option: OrphanMinuteCount Description: Age of orphan records in minutes: on the execution of this module, orphans older than 60 minutes will be released and made available for processing. Default Value: 60 minutes
Option: OrphanMinuteCount Interval Description: The frequency of the release orphans task from the CampusVue Outgoing Queue, in milliseconds. Default Value: 300000 milliseconds (5 Minutes)

CampusVueAgent.Purge Options

The following table lists the options of the Cmc.CampusVueConnector.CampusVueAgent.Purge component:

Options in Cmc.CampusVueConnector.CampusVueAgent.Purge
Option: PurgeDayCount Description: Age of records in days: on the execution of this module, records older than 90 days will be removed from the CmSISQueue table (CampusVue Outgoing Transaction table). Default Value: 90 days
Option: PurgeDayCount Interval Description: The frequency of the purge records task from the CampusVue Outgoing Queue, in milliseconds. Default Value: 86400000 milliseconds (1 Day)

Talisma Agent Module Options

The following table lists the options of the Cmc.CampusVueConnector.TalismaAgent component:

Options in Cmc.CampusVueConnector.TalismaAgent
Option: FieldMapConfig Description: Full path and name of the mapping XML file. Default Value: C:\Program Files\CMC\C2000\Services\CampusVue Connector Service Manager 12.1.A\FieldMapConfig.TalismaAgent.xml
Option: TalismaUser Description: Username of System Administrator level user of CampusNexus CRM system. Default Value: TalismaAdmin
Option: TalismaPassword Description: Password for System Administrator level user. Default Value: talisma
Option: TalismaLoginType Description: Talisma Login Type. Default Value: 2
Option: TalismaUrlBase Description: iServices URL. Default Value: http://CltDevCrm3/HEFoundationiService/SISConnectorSvc.asmx
Option: PendingMsgCount Description: The number of messages that will be processed each time the process runs. Default Value: 10 To optimize the performance of Connector, set this value to 10.
Option: MaxLoopCount Description: The number of time the process will run before the dll unloads. Default Value: 100 To optimize the performance of Connector, set this value to 500.
Option: LogCounters Description: The log that records the number of messages processed, the number of messages that were processed successfully, and the number of messages that had errors. To log the number of records processed by the connector, set this value to 1. Default Value: 0 To optimize the performance of Connector, set this value to 0.