Custom SQL Commands

From UmsWiki
Jump to: navigation, search

Custom SQL Commands is a feature for executing customized SQL at specific times in various background jobs. The time depends on the job you attach the SQL command to.

This feature is found at: Configurator -> Settings -> Custom SQL Commands

Custom SQL commands.jpg

Program

The list of UMS programs that supports Custom SQL commands. The list is only filed with programs that you have a license for.

Show commands after addon file has been run

Some of the programs have a custom file that it can run instead of the one supplied by UMS.

If you do not have a custom file then ignore this chekbox

Show commands after <Program name> has run

This allows you to run custom SQL commands after the specific program has finished running. This could be a program like SLI.

If this is not checked the custom SQL commands will run before the program starts.

Jobs

The following is a list of all programs you can attach Custom SQL commands to. Note that you will only see the programs you have licenses for. (GetStudents requires no license)

GetStudents

Always use the table ImportFromDB instead of the Students table when doing these SQL commands.

Custom SQL commands GetStudents.jpg

Description

Enter a name.

Priority

This control in which order commands should run. (1 is first)

SQL command

Enter the SQL command UMS will run.

You can create a Store Procedure and run that instead use the command "Exec <Stored Procedure Name>"

Add users to groups

This option allows you to create new groups in UMS. These groups will be handled like any other group coming from the administrative system.

Custom SQL commands GetStudents Add users to groups.jpg

SQL Command

Only write the part that comes after the SQL Where sentence and not the whole SQL sentence.

GetStudents

All fields under this setting are text fields.

The action should always be left with the text Add.

GetTimetable

Moodle

Moodle Cohort

Canvas

Google Apps Drive Sync

Google Apps Sites Sync

Fronter

ELEARNINGFORCE

Export User Info to Admin systems

Office 365 SharePoint Sync

OneNote Class Notebook

SLI

FAQ

If you ever want to use the UNILOGIN column, you'll need to run it after SLI - use the checkbox to change from before to after.