RIO Ed - Term Offerings Cloning
rio_ed:termOfferingsCloning
Table of Contents
RIO Ed - Term Offerings Cloning
Component Name | RIO Ed - Term Offerings Cloning |
---|---|
API Name | rio_ed:termOfferingsCloning |
Type | Standalone |
Recommended Pages | Term Record Page |
Supported In | Salesforce internal |
The RIO Ed - Term Offerings Cloning Wizard is used to create and monitor course offerings cloning jobs based on a term. The following outlines each feature of this wizard.
The main screen of the wizard is the Job Queue Group Monitor. The job queue table displays job queue records that match the statuses configured in the system attributes and the specified job operation context with a record ID.
For example, the default job operation context for this wizard is Term_Offerings_Cloning. The wizard will display job queue records that have a job operation context in the format Term_Offerings_Cloning_{RecordId}.
There are a total of six buttons on the main screen:
1. New
This button allows the user to create a new offerings cloning job for the current term. The process contains four screens, outlined below.
Course Selection Screen:
This screen allows the user to select the courses from which they want to clone the course offerings.
Below are the fields that need to be selected:
- Term to Clone From: Specifies the originating term from which course offerings will be cloned.
- Campus: Defines the campus from which the course offerings will be cloned.
-
Courses: Determines which course should be included in the cloning process. Users can choose between:
- All: Includes all courses that have course offerings set up in the selected term and campus (default selection).
- Manual Selection: Allows users to specify individual courses for cloning.
Note: The course table will only include courses that have course offerings offered in the selected term and campus, and that are in the configured course offering statuses as defined in the configurable attributes of this wizard.
Course Offerings Selection Screen:
This screen allows the user to select the course offerings they want to clone.
This step will only consider the course offerings associated with the selected courses, term, and campus from the courses selection screen.
By default, all course offerings are selected. Users can switch to "Manual Selection" to choose specific course offerings.
Note:
- The Course Offerings table is displayed only if "Manual Selection" is chosen.
- If the number of course offerings exceeds the "Maximum Row Number for Custom Datatable" set in the system settings, some records may not appear. To avoid this, users can refine their selections in Step 1 (e.g., by reducing the number of courses to limit the number of course offerings per batch).
Additional Options Screen:
This screen allows the user to select additional options such as renaming the Course Offering according to the latest Term, and whether to clone the Sessions.
Below are the fields that need to be selected:
- Retain Course Offering name: Specifies whether to retain the Course Offering name or rename it according to the Term.
- Would you like to include Sessions: Determines whether to clone the Sessions.
- Retain Sessions name: Specifies whether to retain the Session name or rename it according to the Term
Summary Screen:
This is the final screen, where the user can review the offerings cloning details that will be added to the job queue. After clicking the Add Job button, an asynchronous job queue is created and placed in the queue. Users can navigate to the Job Queue records to check the status of the offerings cloning process.
2. Cancel Job(s)
This button allows the user to cancel jobs that have not yet started processing.
3. Retry Job(s)
This button allows the user to retry jobs that have completed.
4. Refresh
This button allows the user to refresh the Term Offerings Cloning Wizard.
5. Clear All Jobs
This button allows the user to delete all job queue records in the list.
6. Help
This button opens the help modal, which provides an overview of the steps in the Term Offerings Cloning process.
Supported Configurations
Attribute Name | API Name | Description | Default Value |
---|---|---|---|
Modal Title | modalTitle | Component modal title. | Term Offerings Cloning Wizard |
Modal Icon Name | modalIconName | Modal Icon Name, for example: standard:work_plan_template. | standard:work_plan_template |
Job Operation | jobOperation | The job operation name that matches the job configuration in the custom metadata, for example: Term_Offerings_Cloning. | Term_Offerings_Cloning |
Job Queue Group Fields | jobQueueFields | Job Queue Group table fields in semi-colon separated value e.g., Field_A__c;Field_B__c;Field_C__c. | Name;CreatedDate;rio_ed__Total_Records__c;rio_ed__Success_Records__c;rio_ed__Error_Records__c;rio_ed__Status__c |
Job Queue Group Statuses | jobQueueStatuses | Semi-colon separated list of Job Queue Group Statuses to show in the table. | Pending;Processing;Completed;Failed |
Job Queue Group Table Max Height | jobQueueTableMaxHeight | Job Queue Group Table Max Height. | 500 |
Course Fields | courseFields | Semi-colon separated list of Course fields for the new job screen. | Name;hed__Course_ID__c |
Course Table Max Height | courseTableMaxHeight | Study Unit Table Max Height. | 500 |
Course Offering Fields | courseOfferingFields | Semi-colon separated list of Course Offering fields for the study offering selection screen. | Name;hed__Course__c |
Course Offering Statuses | courseOfferingStatuses | Semi-colon separated list of course offering statuses used to filter the courses and course offerings displayed in the table. | Draft;Not Started;Pre-enrollment Opened;Enrollment Opened;Enrollment Closed;Running (Enrollment Opened);Running;Completed |
Course Offering Table Max Height | courseOfferingTableMaxHeight | Course Offering Table Max Height. | 500 |
Course Offering Table Maximum Row Number | courseOfferingTableMaximumRowNumber | Course Offering Table Maximum Row Number | 500 |
Debug Mode | enableDebugMode | Enable debug mode. | false |