Objective Template Manager

1. What does this feature do? (High-Level Overview)

This feature lets admin-view users manage the shared catalog of STO and LTO objective description templates used in BIP plans. It keeps template wording configurable in the app, while clinical users continue selecting active templates during manual and bulk objective creation.

2. Who is this for? (Roles & Permissions)

• Superadmin/Admin/Owner/Manager, or any role granted access_admin_view: Can open the Objective Templates manager and create, edit, deactivate, or delete templates.
• Users with BIP edit access (manage_bips): Can use active templates when creating or editing objectives and when generating objectives in bulk.
• Users with BIP view access (view_bips): Can review objective descriptions that were already rendered or saved through the BIP workflow.

Required permissions used by this feature path:

• access_admin_view: Required to access the manager page and to create, update, or delete catalog templates.
• manage_bips: Required by the BIP objective workflows that consume active catalog templates.
• view_bips: Required to view BIP content where objective descriptions appear.

3. Business Rules & Enforcements

• Rule 1: Each template must have a type: STO or LTO.
• Rule 2: Each template must include template text.
• Rule 3: Each template must be assigned to at least one supported plan category: Maladaptive, Replacement, Caregiver Training, Teacher Training, or RBT Training.
• Rule 4: Template text is trimmed before saving.
• Rule 5: Duplicate templates with the same type and same template text are not allowed.
• Rule 6: Templates can be marked Active or Inactive.
• Rule 7: BIP objective creation, objective editing, and bulk objective generation load only active templates for the selected objective type and plan category.
• Rule 8: The manager loads active and inactive templates so administrators can review or reactivate inactive items.
• Rule 9: Template lists are ordered alphabetically by template text.
• Rule 10: Deleting a template removes it from the catalog. Existing objectives keep the template text already saved on the objective.
• Rule 11: The manager supports placeholders such as {objective_number}, {client_name}, {plan_name}, {start}, {target}, {units}, {weeks}, {verb}, {comparative}, and {timeframe} for dynamic objective wording.
• Rule 12: The manager shows live previews using sample objective values for each selected category, helping users validate wording before saving.

4. UI Placement

1. Dashboard > Site Administration > Objective Templates: Opens the catalog manager.
2. Settings / Site Administration card: The Objective Templates card appears for users with access_admin_view.
3. BIP objective workflows: Active catalog templates are consumed in the Short Term Objectives section, Long Term Objectives section, objective detail modal, and Create objectives in bulk dialog.

5. How-To Guide (Step-by-Step)

Scenario A: Create a new objective template

1. Open Site Administration.
2. Select Objective Templates.
3. Click New template.
4. Choose the template type: STO or LTO.
5. Keep the status as Active if the template should be available to BIP users.
6. Enter the template text. Use placeholder buttons when the wording should pull values from the plan or objective.
7. Select one or more categories where the template should be available.
8. Review the live preview for the selected categories.
9. Click Save template.

Scenario B: Edit or deactivate an existing template

1. Open Objective Templates from Site Administration.
2. Use search, type filter, or category filter to find the template.
3. Click the edit action for the template.
4. Update the type, text, categories, or status.
5. Set the status to Inactive when the template should no longer appear in BIP objective creation flows.
6. Review the preview and click Save template.

Scenario C: Delete a template from the catalog

1. Open Objective Templates.
2. Find the template to remove.
3. Click the delete action.
4. Confirm deletion in the warning dialog.
5. The template is removed from the catalog and will no longer be offered for new selections.

Scenario D: Use managed templates when creating BIP objectives

1. Open a client’s BIP View / Update.
2. Open the relevant plan and add or edit an STO or LTO.
3. The template selector loads active templates that match the objective type and plan category.
4. Select a template and review the objective preview.
5. Save the objective. The selected template text is stored with the objective and used for its displayed description.

Scenario E: Use managed templates in bulk objective creation

1. Open a plan in BIP View / Update.
2. Click Create objectives in bulk.
3. Select an STO template and, when creating an LTO, select an LTO template.
4. Enter the generation settings such as start point, final target, weeks, and comparison operator.
5. Preview the generated objective descriptions.
6. Create the objectives. The saved objectives keep the selected template text.

6. What happens if…? (Edge Cases / FAQ)

• Q: What happens if a template is inactive?

  • A: It remains visible in the manager, but it does not appear in normal BIP objective template selectors.

• Q: What happens if no active template exists for a category?

  • A: The BIP workflow cannot offer a predefined template for that type and category. In bulk creation, the user is told that no template is configured for the selected category.

• Q: What happens if an administrator deletes a template that was already used?

  • A: Existing objectives keep their saved template text. The deleted template is no longer available for future selections.