Access Keys:
Skip to content (Access Key - 0)

CIM Courses Administrative Documentation

Please note that this page and related pages are being developed as part of the CIM Courses Project and are subject to change.

This article describes several processes that are relevant to administering, troubleshooting, and testing in CIM Courses.

Table of Contents:

Administrative Tasks

Please note that to perform any of the following administrative tasks, you will need to be logged in as an administrative user.

Becoming a CIM User

  • Log into the CIM Console
  • Under the Administration section on the left panel, click the User Provisioning link. The resulting page will be a list of CIM users.
  • Highlight a user and press the Become... button.
  • You may need to refresh the CIM Courses main page before the new permissions take effect.
  • You will now interact with CIM Courses as if you were logged in as that user. Please note that you will lose administrative access for your session.

There are currently only two types of CIM users - Department Administrators and Freshman Seminar Users. In order to impersonate a Freshman Seminar User, identify a user in User Provisioning with the FSEM qualifier and become that user.

#need to update

Managing Administrative Users

  • Log into the CIM Console
  • Under the Administration section of the left panel, click the Account Management link. The resulting page will be a list of Courseleaf administrative users.
  • Options
    • Create New User - Press the New User button and input the appropriate information
    • Delete User - Highlight a user and press the Delete User button
    • Edit a User - Highlight a user and edit the appropriate information
  • Press OK to save changes

Refresh the CIM Export Data (Republish Subdirectory)

Courseleaf only updates their export data once per day (#work - at XYZ time). They refer to this process as "Publishing" the data.

For testing purposes, in order to ensure that the CIM Export Data (see Helpful Links section for the test environment link) is the most up-to-date, you will need to use the Republish Subdirectory functionality in the CIM Console. This process is a manual work-around to publish CIM data rather than waiting until the automated publishing process runs overnight. Steps:

  • Log into the CIM Console
  • Under the Administration section on the left panel, click the Republish Subdirectory link.
  • In the resulting page, type /courseadmin into the Directory to Republish input box. Do not include quotes: Republish Subdirectory input box
  • Press the OK button. You should receive a Republish Site dialog box that publishes multiple (currently 60 pages) and a message that says Republish Complete.

Getting a Subject to an "At Rest" State

**Warning** - Courseleaf has strongly advised us not to perform the following procedure in Production. These steps should only be performed in development/testing environments.

From the CIM Courses perspective, the term "At Rest" describes a Subject that is not in workflow and is not in draft format - and also has "synched" at the Banner workflow step. Because the "MIT to CIM Courses Verification Feed" is not functional in the development/testing environments, the Subject needs to circumvent the "Banner" comparison workflow step. The work-around is to remove the "Banner" workflow step from the workflow queue and approve under a different step.

  1. Submit a proposal to workflow. Make note of the first step in the workflow queue.
  2. Log into the CIM Console.
  3. Under the Administration section on the left panel, click the "Approve Pages" link.
  4. In the resulting page, change the "Your Role" dropdown value to match the first step of the workflow queue you made note of in step 1.
  5. Find and Highlight the Subject proposal in the resulting "Page Pending Approval" list.
  6. In the top right panel, press the "Workflow Status" tab (the page will default to displaying the "Page Info" tab.
  7. Press the "Update Pending Workflow" button.
  8. Remove the "Banner" step by highlighting and pressing the red "X" button. Additionally, remove all other workflow steps other than the step you used in the "Your Role" dropdown in Step 4.
  9. Press the "OK" button to save.
  10. With your Subject highlighted and Workflow Status updated, press the "Approve" button in the "PAGE REVIEW" pane. Your Subject will now be "At Rest".

Late Proposal Process

New Subject

  1. User creates a new subject proposal in CIM Courses. The proposal is then approved by the Registrar.
    1. Effective From Term will be Catalog Year (e.g. 2020FA)
  2. Subject is processed by the API
  3. Subject will be inserted into the New Subject Structure, CIS - effective 2020FA
    1. Configuration dates may prevent the MITSIS backfill record from getting processed depending on the state of the MITSIS backfill gate (located in SUBJECT_MGMT_CONFIG). 
  4. "Reset Term for a CIS Subject" will be used to reset the term code to 2019FA in CIS
  5. New SCASUBJI's "Backdate Container" button will be used to backdate the container in the New Subject Structure (e.g. to 2019FA)
    1. A MITSIS Backfill record will be created, processed, and backfilled for the Subject

Subject Edit

  1. User proposes a subject edit in CIM Courses. The proposal is then approved by the Registrar.
    1. Effective From Term will be Catalog Year (e.g. 2020FA)
  2. Subject is processed by the API
  3. Subject will be updated in the New Subject Structure, CIS - effective 2020FA
    1. Configuration dates may prevent the MITSIS backfill record from getting processed depending on the state of the MITSIS backfill gate (located in SUBJECT_MGMT_CONFIG). 
  4. "Reset Term for a CIS Subject" will be used to reset the term code to 2019FA in CIS
  5. Registrar will make the appropriate subject edits using New SCASUBJI - effective 2019FA
    1. A MITSIS Backfill record will be created, processed, and backfilled for the Subject

Integration Points

CIM Courses has two integration points with MIT systems:

  1. CIM Courses to MIT Data Feed
  2. MIT to CIM Courses Verification Feed

CIM Courses to MIT Data Feed

Subject data stored and processed in CIM Courses is consumed to populate various MIT systems.

CIS (Curricular Information System)*

Proposed Subjects

Subjects that have been submitted to the CIM workflow process are considered to be in a proposed state. As such, this type of subject data must be consumed and backfilled into the legacy CIS proposal system tables. For more information, please see the [hd:CIS Backfill Documentation].

The (#work - add job name and other details) XYZ job runs once nightly after the CIM Subject Data has been republished.

Subjects that are in a proposed state can be identified using the content of the <nextsignoff> XML element in the CIM Courses Data Export. This element will contain the party responsible for the next workflow approval in CIM, such as Registrar or COC. A subject with a workflow step other than "Banner" is considered to be in a proposed state.

After the nightly publishing of CIM Courses data, the XYZ job will pass these subjects along to the Subject Management API for processing.

Approved Subjects*

Approved Subjects will need to be backfilled to CIS as well.

Subjects that have been approved by all the manual workflow steps in CIM Courses will appear in the CIM Courses Data Export and will have "Banner" in the <nextsignoff> XML element.

*Please note that the process to backfill CIS is a transitional requirement of the CIM Courses Project. Once the CIS system has been retired, this process (and documentation) can be retired.

Subject Management Data Structure

Subjects that have been approved in CIM Courses will be consumed and imported into the Subject Management Data Structure. As already noted, Subjects that have been approved by all the manual workflow steps in CIM Courses will appear in the CIM Courses Data Export and will have "Banner" in the <nextsignoff> XML element.

MIT to CIM Courses Verification Feed

Because Courseleaf wants to ensure that they are storing accurate information about MIT Subjects, they perform an automated process to compare MIT data to their own. As such, MIT must send Subject data back to Courseleaf for the comparison.

#work - document information about this feed

Helpful Link - Courseleaf Help > Data Sync (You must be logged in as a Courseleaf user to access this page.)

Other Documentation

Manually Pushing CIM Data to the mit-subjects API

  1. Complete the "Refresh CIM Export Data" steps outlined above
  2. Go to the CIM Courses - Data Export Page (test) web page (link can be found in the "Helpful Links" section of this page)
    1. Refresh this page if you already had it open prior to refreshing the CIM export data
  3. Right click the body of the page and choose the "View Page Source" option. This will open a new tab with more structured XML.
  4. Copy and paste the necessary test data into Postman
    1. Depending on your test case, it may be helpful to verify that the subject data is staged properly (e.g. both subjects in a reflexive equivalency relationship are present)
  5. POST the data to https://mit-subjects-v1-schedtest.cloudhub.io/test/courseleafFeed endpoint
    1. You will also need to have the appropriate client_id and client_secret key/value pairs configured.
  6. You should get a response detailing the status of your POST.

Testing Shredding, Rollback, and Pushout Processes

  1. POST the proposed subject XML against https://mit-subjects-v1-test.cloudhub.io/test/courseleafFeed
    1. Ensure the POST is successful and that the CIS backfill records are processed successfully
  2. Using SQL, update the SUBJECT_CIM_INBOUND_FEED.RUN_TYPE = 'SCHEDULED' for the RUN_ID that corresponds to the subjects data processed (i.e. the run_id listed in the API response)
    1. Ensure that the update is committed to the database
  3. POST the XML for the shred, rollback, and/or pushout against https://mit-subjects-v1-test.cloudhub.io/test/courseleafFeed?processShredded=true
    1. Ensure the POST is successful (or skipped if only empty <courseleaf> tags are processed to shred) and that that the CIS backfill records are processed successfully

Subject Relationship Removal Matrix

The following matrix details the expected behavior in each system when after removing subject relationships in CIM Courses. 

Action System Type Container/Template Structure CIS MITSIS
Remove EQ CIM EQ Bookend* EQ Bookend EQ EQ stays intact for 5 years**
Remove EQSR CIM EQSR Bookend EQ
Bookend SR
Bookend EQSR EQ stays intact for 5 years
Remove cross-list or
SWE
CIM XLIST,
SWE
Create new or update template 
without cross-list or SWE
Bookend XLIST,
SWE
EQ stays intact for 5 years
Deactivate a Subject
with an EQ
CIM EQ EQ remains intact thru 999999 Bookend EQ EQ stays intact for 5 years
Deactivate a Subject
with an EQSR
CIM EQSR EQ remains intact thru 999999
Bookend SR
Bookend EQSR EQ stays intact for 5 years
Renumber a Subject CIM RENUM Create new or update template
with new Subject Number
-Change status of old 
number to "Inactive"
-Add active records for
new Subject Number
EQ stays intact for 5 years

*The term "Bookend" is used instead of other terms, such as "remove" because it better describes the fact that the EQ still exists for a time period but has ended.

**At a meeting n 8/23/2018, IS&T confirmed this expected behavior with the Registrar due to the following scenario:

  • Subject A and B are EQ for 2016FA-999999
  • Student 1 takes Subject A in 2017FA
  • The EQ between Subject A and Subject B is bookended through 2018SU (total span of EQ is 2016FA-2018SU) because there was a significant change to Subject A's subject matter.
  • If Student 1 were to take Subject B in 2019FA, he/she would be able to receive credit for Subject B even though the subject matter would be the same as Subject A's 2017FA subject matter.

Expected Behavior When A New Subject is Approved and Deactivated in the Same Proposal Term

When a subject is approved and then deactivated in same proposal term (e.g. 2019FA) the expected behavior in each environment differs. The expected behavior is as follows:

  1. New Subject Structure - TBD
  2. CIS - the subject will be archived, meaning all of the subject records will be inserted into the CIS archive tables (e.g. scrci_proposal records will be inserted into scrci_proposal_arch. The subject records will then be deleted from the non-archive CIS tables.
  3. MITSIS - the subject will be deactivated, meaning its SCRSU_VAR record will be set to inactive. 

#work - bake this section into to rest of document
*"Saved" proposals do make it into the CIM feed.

*If a proposal gets rolled back out of workflow to the "Saved" state, the proposing user will be notified via email.

*A subject with a non-reflexive equivalency will not be processed by the CIM Inbound feed - regardless if it is in proposed or approved state. 

FAQ

*Why doesn't my subject's Term Plan in CIM match the

Helpful Links

  1. CIM Console (test) - https://mit-test.courseleaf.com/courseleaf/
    The CIM Console is the general website from which many administrative tasks can be performed. Please refer to the "Administrative Tasks" section in this article for the list of tasks and how-to's. It is worth noting that this a central management console for other Courseleaf products (Course Catalog, etc.); this article will only describe CIM Courses specific issues.
  2. CIM Courses - Main Page (test) - https://mit-test.courseleaf.com/courseadmin/
    The CIM Courses main page is the page that CIM users will perform subject proposal related tasks.
  3. CIM Courses - Data Export Page (test) - https://mit-test.courseleaf.com/courseleaf/courseleaf.cgi?page=/courseleaf/index.html&step=cimexport
    The CIM Courses data export page contains the full set of subject export data for eventual consumption by MIT. Be sure to use the "Republish Subdirectory" (in the test environment) to ensure that the exported data is the most up-to-date.

Subject Management Documentation Index

The Subject Management Documentation Index is the central listing for documentation pertaining to Subject Management.

IS&T Contributions

Documentation and information provided by IS&T staff members


Last Modified:

October 15, 2018

Get Help

Request help
from the Help Desk
Report a security incident
to the Security Team
Labels:
c-scasubji c-scasubji Delete
r-style r-style Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
Feedback
This product/service is:
Easy to use
Average
Difficult to use

This article is:
Helpful
Inaccurate
Obsolete
Adaptavist Theme Builder (4.2.3) Powered by Atlassian Confluence 3.5.13, the Enterprise Wiki