Page tree
Skip to end of metadata
Go to start of metadata

The first step of the integration process of LYNX for Colleague UniData is to prepare your Colleague environment. This will ensure that CollegeNET's interfacing application can connect to your database and populate the LYNX history tables created in the following step.

Technical Requirements

  • Colleague Release 18 + - Data transactions (2002)
  • Colleague App Listener (DMI updates)

Colleague Deployment

See pages 61-65 of "Updating Colleague Software (Release 18)" if you are unsure of how to perform steps 3-5 of the following section. This file can be found in the Ellucian documentation.

  1. Find the CNColleagueLYNXLink_v4.zip folder you downloaded earlier.
  2. Copy the following subdirectory (contains the Colleague Package) to your Colleague application server:

    1. ./Colleague_Package/G78_X25.LIVE.DATA.EXC_JT3_002/
  3. Log in to Colleague as an administrative user.
  4. Within the CPIE form, import the package contents into your Local Product Repository (LPR).
    1. Package Name: G78_X25.LIVE.DATA.EXC_JT3
    2. Package ID: G78_X25.LIVE.DATA.EXC_JT3*002
  5. Use the process to apply the update to Colleague to import the package contents (just like a normal Ellucian update).
  6. Within the MSUG form, install the package from your LPR to the Colleague environment of your choice.

Once installed, the Colleague data contract (X.25LIVE.DATA.EXCHANGE.TRN) will be used by CNColleagueLYNXLink.exe to sync data between Colleague and LYNX.

Configure Colleague Service User Account

This integration requires a service user account which connects through a DMI session of a Colleague application listener. It does not need access to any Colleague screens or forms.

Create a user with the following characteristics:

  • a DRUS record
  • a SOD record
  • security class 'DMI_REG_GUEST'

For more information about the specific Data File, Fields and level of access needed, see Mapped Fields in Colleague UniData for LYNX.

After setting up the user, try signing in to the Colleague web interface to confirm that the user was granted the ability to "login on".

For LDAP users:

This integration uses the web user credentials rather than the 'database' user.

Check to see if your Colleague APP-Listener is set up to use LDAP instead of native Colleague authentication. If it does use LDAP, you will want to reset the credentials of the Service Account in your contact directory for it to properly authenticate.

Confirm VOC Record is Created For S.GRAS

According to an Ellucian Change Request, there can be an issue where no VOC record exists for S.GRAS. You will likely encounter this error while operating LYNX unless you have already addressed the root cause. This issue is not unique to LYNX, so it is possible that it has already been fixed in your environment. If you aren't sure, then there's no harm in applying the solution again.

Error when no VOC record exists for S.GRAS

A cataloging error will be encountered when attempting to fetch COURSE.SEC.MEETING data from UniData.

Sending : GetData^18818^MEETINGS
Sending Request : 2019-10-22 13:13:35
Error Subset Found: Server error-00302-The server was unable to process your request.  This may be due to a cataloging problem.  Please contact your system administrator

To prevent errors, follow the steps provided in the workaround noted by Ellucian Customer Center #000029289. To perform these steps, you will need to create an Envision terminal session to each Colleague environment you have.

  1. Create Envision Terminal session to Colleague environment
  2. Enter the following command "AE VOC S_GRAS"
    You will see the following output "Top of "S_GRAS" in "VOC", 2 lines, 24 characters. "
  3. Enter the following command "P"
    You will see the following output
    • 001: C 
      002: UT.SUBROUTINES/_S_GRAS 
      Bottom. 
  4. Enter the following command "SAVE S.GRAS"
    If successful, you should see the following output " Record "S.GRAS" saved in "VOC". "

If steps 2 - 4 have been done correctly, you should see this:

:AE VOC S_GRAS 
Top of "S_GRAS" in "VOC", 2 lines, 24 characters. 
*--: P 
001: C 
002: UT.SUBROUTINES/_S_GRAS 
Bottom. 
*--: SAVE S.GRAS 
Record "S.GRAS" saved in "VOC".

Adjust DMI Timeout Defaults (Optional)

This optional step is for institutions with very large data sets. Most customers will not need to update the DMI Timeout default for the application listener that will be used. However, you may want to consider adjusting these settings if a timeout is encountered during one of the initial sync processes while testing.

Restarting the Colleague application listener(s) will disrupt any active connections to Colleague, so it's best to perform this step during a maintenance period.

  1. Log into Colleague's SA_VALET
  2. Navigate to the DMI defaults
  3. Adjust Timeout settings if needed
    • Set thread timeout to 600
    • Set web executable timeout to 1200
  4. Perform a hard restart on app listeners to adjust timeout settings

Unable to render {include} The included page could not be found.


  • No labels