How to assign Program Templates

This article provides step-by-step instructions on how to assign Program Templates on Symbol Security, either through the MSP portal or via the API.

From the MSP Portal

1. Access the Program Templates List

   • Log in to the MSP Portal.

   • Navigate to the Program Templates section to view the list of available templates.

2. Locate the Desired Template

   • Browse or search for the Program Template you want to assign.

3. Assign the Template

   • Click the “Assign” button next to the template you wish to assign.

4. Configure Assignment Details
   Once you're in the New Program Assignment form, ensure you configure the following important details based on your requirements.
   

   1. Override Mandatory Content Option:

      • If enabled, this option will replace the existing mandatory content of the selected companies with the content defined in the Program Template.

      • If disabled, the mandatory content of the companies will remain unchanged, and only the monthly content from the template will be added.

   2. Run Schedule Option
      By enabling the Run Schedule checkbox, the app will auto-start running the program schedules for each of the selected companies. If any of the selected companies already have running schedules, they will remain the same.
   3. Starting Month Option
      
      This option allows you to schedule content to begin in a specific month in the future.
      Example: Assign a Program Template in August and set the content to start in October, giving you more time to organize schedules in advance.
5. Select Companies or Groups
   • At the bottom of the form, you can select the companies or groups to which you want to assign the template.

   • Use the search or filter options to locate specific companies or groups.

6. Complete the Assignment

• • Once you’ve selected the companies/groups and configured the options, click “Assign”.

  • The assets and simulations included in the Program Template will be added to the security programs of the selected companies within the next hour.

Assigning a Program Template via the API

To assign a Program Template programmatically, use the following API endpoints:

1. Retrieve the Program Template ID

   • Call the endpoint:

     GET /msp/program_templates

   • This will return a list of available Program Templates. Locate the program_template_id of the template you want to assign.

2. Retrieve the Company ID

   • Call the endpoint:

     GET /msp/companies

   • This will return a list of companies. Locate the company_id of the company to which you want to assign the template.

3. Assign the Program Template

   • Use the following endpoint to assign the template to a specific company:

     POST /msp/companies/{company_id}/programs/{program_template_id}/assign

   • Replace {company_id} and {program_template_id} with the appropriate IDs retrieved in the previous steps.

   • The "override mandatory content" setting is not allowed at the API yet, so content will be overridden by default.
4. Verify the Assignment

• • Once the API call is successful, the assets and simulations from the Program Template will be added to the company’s security program.

Important Notes

• Override Mandatory Content: Use this option carefully, as enabling it will replace the existing mandatory content of the assigned companies with the content from the Program Template.

• Assignment Delay: Depending on the # of companies and content selected, the assignments made through the MSP portal will take some time to be assigned, so we will notify you via email when it has finished. 

• API Rate Limits: Be mindful of API rate limits when assigning templates programmatically to multiple companies.

For further assistance, contact Symbol Security Support or refer to the API Documentation for additional details.