- Branding level : An org unit type within the organization; for example, Department. All courses descended from a branding-level are branded in the same way. A branding-level and its children are called a branding area.
- Branding source: An org unit (typically a course offering, but not necessarily) whose active homepage, active navbar, colours, and tool statuses are copied out to other org units.
- Branding destination: The org units (course offering) that are branded from a source.
- Branding runs can have multiple sources and multiple destinations. A CSV file can define a source and destination for each line in the file. A full sweep may have one source for each branding area in the organization and apply its branding to thousands of destination courses.
Course Branding tool currently has four supported modes:
- CsvSimple mode
- Full mode
- add-ignore mode
- remove-ignore mode
You can only specify a single mode to run at a time. The Course Branding processes add-ignore and remove-ignore every run, and as such they do not need to specify these modes.
This mode of execution reads csv files from the directory declared in the “path/csv-in” config setting.
Every CSV file consists of two columns: the org unit id or org unit code of the source course, and the org unit id of the destination course. For each row in the CSV file, the Course Branding tool takes the active branding of the source course and applies it to the destination.
This mode of execution causes the Course Branding tool to attempt to brand all courses in the organization inside the designated branding-level (if no branding level is provided, the default value, Department, is used instead). Course offerings not inside an org unit of the branding-level type are not branded (e.g., courses not in departments are not branded).
The tool first builds a list of all branding-level org units in the organization. It then builds a list of all Course Offering children for each of these org units and identifies the source branding org unit (either the branding org unit itself, or the navshell Course Offering). Finally, it applies branding from the source to all other courses.
A course will not be branded if:
- It is not within a branding area (e.g., not in a department);
- Its branding area does not have a navshell Course Offering; and/or
- Its Course Offering Code matches the navshell pattern, even if the course has not been chosen as the branding source.
This mode of execution reads all CSV files in the add-ignore-in folder (defined in the config file). Each row contains an org unit id or org unit code that will be added to the ignore list. Courses in the ignore list are not branded unless force branding is set to true.
When complete, this execution mode moves the CSV files to the add-ignore-out folder.
This mode of execution reads all CSV files in the remove-ignore-in folder (defined in the configuration). Each row contains an org unit id or org unit code that will be removed from the ignore list. Courses in the ignore list are not branded unless force branding is set to true.
When complete, this execution mode moves the CSV files to the remove-ignore-out folder.
By default, the task runs once a day, typically overnight or early morning. To adjust the start time or add additional runs, submit a Request to Add or Modify Scheduled Task through the Service Request Catalog, detailing the desired scheduled task adjustments for custom Course Branding.