This article explains the command line arguments supported by CNColleagueLYNXLink. It is recommended that you run the Command Prompt as an administrator.
Within the command prompt, you will need to navigate to the directory where the CNColleagueLYNXLink.exe executable is located, which should be the ~\CNColleagueLYNXLynk\ folder. Example:
Image: Example of the command line.
Arguments
These arguments are not case-sensitive. Some come in both a short form and a long-form, which are equivalent.
Short | Long | Explanation |
|---|---|---|
(no argument) | The executable will perform the following synchronization processes in order: reference, meetings, instructors, xlist | |
-c | -config | Executable will start interactive prompt for user to update required configuration parameters. Any sensitive information will be encoded/encrypted IF testing="false" is set for that XML element. This command can be used for the "Configuration Steps" (see below.) The -c argument can be used to update fields individually. The --config argument can be used to update all fields at once. |
-t=<Term Code> | Synchronize data for a single term. This process deletes the records within LYNX Universal schema associated with supplied Term Code. Cannot be combined with other arguments. | |
f | file | Check to see if all required Colleague SDK .dll files exist in the folder with .\CNColleagueLYNXLink If any are missing, it will display the .dll file names. |
r | reference | Synchronize reference data, such as: ACAD.LEVELS, BUILDINGS, COURSES, DEPTS, DIVISIONS, EQUIPMENT, INSTR.METHODS, LOCATION.REGIONS, LOCATIONS, PARTITIONS, ROOMS, SCHED.TYPES, SUBJECTS, TERMS, CORE.VALCODES, ST.VALCODES Cannot be combined with other arguments. |
x | xlist | Synchronize cross-list data such as: COURSE.SEC.XLISTS. Cannot be combined with other arguments. |
m | meeting | To be deprecated. Do not run this manually, please. Synchronize term data such as: COURSE.SECTIONS, COURSE.SECT.MEETINGS, and PERSONS (instructors only). Cannot be combined with other arguments. |
i | instructors | To be deprecated. Do not run this manually, please. Synchronize instructor assignments for sections. COURSE.SEC.FACULTY and PERSONS (instructors only) Cannot be combined with other arguments. |
Examples
Running the Command Line Without Arguments
To run the synchronization processes (reference, meetings, instructors, xlist) simply enter the executable name with no arguments, as shown.
Image: Enter the executable name with no arguments.
Resetting All Required Data Elements
The following is a block of inputs that will reset all the required data elements in the CLI when using the --config argument:
Note that lines 14-18 of this block concern the MSSSQL database connection information.
//Server,Port, Database, User ID, Password make value for [connectionString] //if testing flag set to false for element, the value will be saved as encrypted/encoded value instead //<institution> will apply encryption/encoding to [connectionString] //<Colleague> will apply encryption/encoding to [username] and [password] // start configuration inputs from CLI y [Institution code] y [Institution name] y [Preferred Email Type] y [Server hostname] [Port] or [Instance_Name] [Database] [User ID] [Password] y [Colleague Username] [Colleague Password] // end configuration inputs from CLI
If you want to update the CNColleagueLynxLink.exe.config file:
- Copy the above block into a plain text editor (in Windows, such as Notepad++. On a Mac, such as TextEdit or BBEdit.), excluding comments
- Fill in the bracketed fields with the appropriate information, ensuring the brackets are removed
- Enter into the command prompt: CNColleagueLYNXLink.exe --config
- Press Enter
- Paste (right-click) the contents of the block edited in Step 2
- Press Enter
Other Examples
|