Administrator

How do I manage Domain Settings?

Follow
Ryan Richins
  • Agilix team member

During the summer of 2017, we released a new Buzz UI, giving you the same features and functionality with a cleaner, simpler user experience!

Until all users have switched to the new UI, our Help Center articles will include information for both. 

Click the header below that aligns with the Buzz UI version you are using (Old UI or New UI); if you don't know which version you are using, review the example images in the Old UI vs. New UI section and/or contact your system admin or Agilix account manager.

Old UI

Manage domains, users, courses, styles & themes, and integrations.

Opening Settings in the Domain toolbar gives access to six tabbed screens that allow you to easily customize your domain to best suit your district or organization.

The XML Editor is available in the bottom left corner of all the tabs. It is useful for troubleshooting and for users who prefer it to using this screen.

This article walks through each screen in Settings to give an overview of this powerful feature.

Domain Options

  • Bookmarks: Buzz allows you to create Bookmarks that appear in a Links tool for users. From this screen, you can add and delete Bookmarks. To edit existing Bookmarks, click XML Editor at the bottom of the screen and edit the elements under the <bookmark-list> tag in Buzz Settings. To create a bookmark here, you are asked to provide:
    • A Title.
    • A URL.
    • An Icon image file.
    • The user Roles for whom the bookmarks should appear (optional).
    • The necessary Rights users need to access the Bookmark (optional).
    • The Userspaces in which the Bookmark should appear (optional).
  • Editor: These fields control elements of the Editor tool. From this screen, you can:
    • Hide Activities (activity types) in the Editor by listing them in the field; separate items with commas.
    • Rights specify which rights you want a user to have in order to see the Editor tool.
    • Add and delete Sections that appear in the right panel of the Editor.
    • Add, edit, and delete item (folders and activities) using Templates options.
  • Landing Content: Easily create domain-wide landing page content that appears on the user's Home and specify when and which roles see it.
  • Menu Entries - Standard: Buzz allows you to manage the default entries in your Main Menu. To add an entry, you are asked to provide:
    • An indication of which standard entry .
    • The entry's placement Order ("0" = top placement).
    • The entry Title.
    • The entry's URL if necessary.
    • The desired Icon; choose from the Font Awesome icon library. Prefix Font Awesome icon names with "fa-".
  • Menu Entries - Custom: Buzz allows you to add custom entries to your Main Menu. From this screen, you can add and delete non-default entries. To add an item, you are asked to provide:
    • The entry's ID.
    • The entry's placement Order ("0" = top placement).
    • The entry Title.
    • The entry's URL if necessary.
    • The desired Icon; choose from the Font Awesome icon library. Prefix Font Awesome icon names with "fa-".
    • The pencil (edit) icon asks for:
      • An indication about whether you want to Show menu item, Open URL in external window, Require the user to choose a course, and/or Do not allow the user to choose a course.
      • The user Roles for whom the entry should appear (optional).
      • The Rights users need to access the entry (optional).
      • The Userspaces in which the entry should appear (optional).
  • Custom Clipboard Tabs: Add tabs for third-party apps to seamlessly integrate for intervention or other personalized learning goals. For example, you may integrate with a messaging tool. To do so, provide:
    • A tab ID that you create.
    • A tab Title.
    • The third-party URL.
  • Login Redirects: Add redirects to allow users to access Buzz data in a third-party app, by authenticating in Buzz first. To do so, provide:
    • The ID of the redirect entry.
    • The third-party URL.
  • Default course navigation: Choose your domain's default Activities tool layout from two options:
    • Full View shows the course tree structure in the sidebar when a user opens a folder.

    • Simplified shows only the contents of the folder the user is in. 

  • Idle Timeout: Enter, in minutes, the amount of time Buzz can remain idle before logging a user out. Providing a timeout value prevents users from staying logged in indefinitely and having that time recorded and reported as activity. If you leave this field blank, users are not logged out due to inactivity.
  • Prohibited Files: List any file types that you want to prohibit users from uploading to Buzz. Separate items with commas.
  • Hide side menu when not expanded: Check this box if you want this to be the default behavior across your domain.
  • Hide audio and video uploading controls: Check this box to disable audio/video uploads.

Tips

User Options

Course Options

  • Activity Metadata: Buzz allows you to add and remove the metadata sections associated with items (folders and activities) in the Editor tool for the teacher role. From this screen, you can add, edit, and delete metadata sections. To create a metadata section, you are asked to:
    • Provide a Name, which is not visible to the users and cannot include spaces or special characters (you can underscore or hyphenate between words).
    • Provide a Title, which is visible to students.
    • Choose Input Type from the options listed here. The content entered in these fields is used to create searchable metadata tags.
    • Use the Default field to define the default state or content that you want present in the field (this is not available for the Rich Text input type).
    • Indicate the Levels within the course folder structure at which you want this metadata displayed. Level one is the first level of folders under the course folder, level two impacts any folders or activities you add to those folders, and so forth. If you don't specify here, the field is shown at all levels.
    • Choose the Item Type for which the section should appear (folders, activities, or all).
    • Indicate whether you want to Allow setting per group.
    • Indicate whether you want to make the item Visible to students when they select the item in the Activities tool (only applicable to folders).
    • Indicate whether you want the metadata Editable in Clipboard in the Teacher app. Checking this box causes the metadata field to appear in the Clipboard when creating activities.
  • Badges: Buzz allows course authors to set up badges that can be automatically awarded to students upon their completion of a specified activity or accomplishment, or awarded manually by a teacher or grader. From this screen, you can add, edit, and delete these Badges.
  • Course Metadata: Create metadata fields for teachers, course authors, etc to complete for courses.
  • Question Metadata: Buzz allows you to create metadata fields for questions by providing a:
    • Name: The XML element name for the data.
    • Title: What you want shown in the UI.
  • Rubrics: Upload existing rubrics as xml files for course authors to use.
  • Scoring Objectives: Buzz allows you to add Scoring Objectives. From this screen, you can add and delete them. To add a Scoring Objective, click Edit, and then New. Buzz generates a Guid and you are asked to choose a color to represent the objective using the color chooser or providing the hexadecimal number. To delete existing objectives, click the garbage can (delete) icon.
  • Learning Standards: To help assess objective mastery, Buzz allows you to align course activities with Standards from various states and/or organizations (these are drawn from the Achievement Standards Network (ASN) catalogue). To make an organization's standards available in your courses, provide its code and separate the items with commas. Check the boxes for the grade levels that you want included as well. By default, Buzz makes the following standards available to all domains (contact your Agilix account manager to add standards to your domain):
  • Activity Templates: If enabled, Buzz allows you to Add activity templates that content authors can copy to their courses and edit for their own needs.
    • Provide the Order you want each added item to appear in, the template Title, and the course you want the templates copied from. Content authors are given access to copy items from the syllabus of the indicated course.
    • Clicking the pencil (edit) icon opens the Editor for the indicated course.
  • Template Courses: If enabled, Buzz allows you to Add course templates that content authors can use as a structure when creating new courses.
    • Provide the Order you want each added item to appear in, the template Title, and the courses you want to provide as templates. Content authors can access these templates when creating a new course with the Teacher app.
    • Clicking the pencil (edit) icon opens the Editor for the indicated course.

Integrations

  • Authentication: Buzz supports the use of Single Sign-on (SSO) features to allow users to sign into one application (for example, a student information system) and be automatically logged into Buzz without needing to re-enter credentials.
    • To enable SSO, select CAS or SAML from this dropdown and:
      • Provide the server URL if you choose CAS.
      • Provide the idp-meta.xml if you select SAML.
      • Indicate whether you want to prevent users from logging in with Buzz credentials.
    • If you don't want to set up SSO, choose Buzz from this dropdown and:
      • Use the checkbox to indicate whether or not you want to Allow users to create their own accounts.
      • Check the Set password policy to specify password requirements.
    • If you want to allow another domain to be used to authenticate the current domain, select Domain, and indicate whether you want to prevent users from logging in with Buzz credentials.
  • Google Drive: Buzz allows districts and schools to enable a deep integration with Google Drive, so users can submit and view documents directly in Buzz. To configure this:
  • Library Extensions: Buzz allows you to make content from various online resources available in a Digital Library. These can include other courses within their district or organization as well as open sources like EdGate, OpenEd, and Kahn Academy. From this screen, you can add, edit, and delete library extensions for this library. To add a Library Extension, you are asked to provide:
    • An ID.
    • A Title.
    • The Provider name.
    • The URL.
    • A Thumbnail URL.
    • A decision to Show library or not.
  • LTI Credentials: Buzz allows you to integrate with other learning tools. From this screen, you can add and delete Learning Tools Interoperability (LTI) Credentials. To add a new LTI Credential, you are asked to provide the Hostname URL, the Key, and the Secret.

Advanced

  • String Override: Buzz's customizations options include the ability to automate word string replacements for any terminology in the app that doesn't match your organization, teaching model, branding, etc. From this screen, you can add and delete word String Overrides. To add an override, click Add and provide the Existing string and the desired Replacement String.

New UI

Manage domains, users, courses, styles & themes, and integrations.

Domain Settings gives access to five tabbed screens where you can customize your domain to best suit your district or organization. This article walks through each screen in Settings to give an overview of this powerful feature.

  1. Open the side menu in Domain > Details.  
  2. Select Edit Settings.

The XML Editor is available in the bottom left corner of all the tabs. It is useful for troubleshooting and for users who prefer it to using this screen.

Domain Options

  • Bookmarks: Buzz allows you to create Bookmarks that appear in a Links tool for users. From this screen, you can add and delete Bookmarks. To edit existing Bookmarks, click XML Editor at the bottom of the screen and edit the elements under the <bookmark-list> tag in Buzz Settings. To create a bookmark here, you are asked to provide:
    • A Title.
    • A URL.
    • An Icon image file.
    • The user Roles for whom the bookmarks should appear (optional).
    • The necessary Rights users need to access the Bookmark (optional).
    • The Userspaces in which the Bookmark should appear (optional).
  • Editor: These fields control elements of the Editor tool. From this screen, you can:
    • Hide Activities (activity types) in the Editor by listing them in the field; separate items with commas.
    • Rights specify which rights you want a user to have in order to see the Editor tool.
    • Add and delete Sections that appear in the right panel of the Editor.
    • Add, edit, and delete item (folders and activities) using Templates options.
  • Landing Content: Easily create domain-wide landing page content that appears on the user's Home and specify when and which roles see it.
  • Menu Entries - Standard: Buzz allows you to manage the default entries in your Main Menu. To add an entry, you are asked to provide:
    • An indication of which standard entry .
    • The entry's placement Order ("0" = top placement).
    • The entry Title.
    • The entry's URL if necessary.
    • The desired Icon; choose from the Font Awesome icon library. Prefix Font Awesome icon names with "fa-".
  • Menu Entries - Custom: Buzz allows you to add custom entries to your Main Menu. From this screen, you can add and delete non-default entries. To add an item, you are asked to provide:
    • The entry's ID.
    • The entry's placement Order ("0" = top placement).
    • The entry Title.
    • The entry's URL if necessary.
    • The desired Icon; choose from the Font Awesome icon library. Prefix Font Awesome icon names with "fa-".
    • The pencil (edit) icon asks for:
      • An indication about whether you want to Show menu item, Open URL in external window, Require the user to choose a course, and/or Do not allow the user to choose a course.
      • The user Roles for whom the entry should appear (optional).
      • The Rights users need to access the entry (optional).
      • The Userspaces in which the entry should appear (optional).
  • Custom Clipboard Tabs: Add tabs for third-party apps to seamlessly integrate for intervention or other personalized learning goals. For example, you may integrate with a messaging tool. To do so, provide:
    • A tab ID that you create.
    • A tab Title.
    • The third-party URL.
  • Login Redirects: Add redirects to allow users to access Buzz data in a third-party app, by authenticating in Buzz first. To do so, provide:
    • The ID of the redirect entry.
    • The third-party URL.
  • Default course navigation: Choose your domain's default Activities tool layout from two options:
    • Full View shows the course tree structure in the sidebar when a user opens a folder.

    • Simplified shows only the contents of the folder the user is in. 

  • Idle Timeout: Enter, in minutes, the amount of time Buzz can remain idle before logging a user out. Providing a timeout value prevents users from staying logged in indefinitely and having that time recorded and reported as activity. If you leave this field blank, users are not logged out due to inactivity.
  • Prohibited Files: List any file types that you want to prohibit users from uploading to Buzz. Separate items with commas.
  • Hide audio and video uploading controls: Check this box to disable audio/video uploads.

Tips

User Options

Course Options

  • Activity Metadata: Buzz allows you to add and remove the metadata sections associated with items (folders and activities) in the Editor tool for the teacher role. From this screen, you can add, edit, and delete metadata sections. To create a metadata section, you are asked to:
    • Provide a Name, which is not visible to the users and cannot include spaces or special characters (you can underscore or hyphenate between words).
    • Provide a Title, which is visible to students.
    • Choose Input Type from the options listed here. The content entered in these fields is used to create searchable metadata tags
    • Use the Default field to define the default state or content that you want present in the field (this is not available for the Rich Text input type).
    • Indicate the Levels within the course folder structure at which you want this metadata displayed. Level one is the first level of folders under the course folder, level two impacts any folders or activities you add to those folders, and so forth. If you don't specify here, the field is shown at all levels.
    • Choose the Item Type for which the section should appear (folders, activities, or all).
    • Indicate whether you want to Allow setting per group.
    • Indicate whether you want to make the item Visible to students when they select the item in the Activities tool (only applicable to folders).
    • Indicate whether you want the metadata Editable in Clipboard in the Teacher app. Checking this box causes the metadata field to appear in the Clipboard when creating activities.
  • Badges: Buzz allows course authors to set up badges that can be automatically awarded to students upon their completion of a specified activity or accomplishment, or awarded manually by a teacher or grader. From this screen, you can add, edit, and delete these Badges.
  • Course Metadata: Create metadata fields for teachers, course authors, etc to complete for courses.
  • Question Metadata: Buzz allows you to create metadata fields for questions by providing a:
    • Name: The XML element name for the data.
    • Title: What you want shown in the UI.
  • Rubrics: Upload existing rubrics as xml files for course authors to use.
  • Scoring Objectives: Buzz allows you to add Scoring Objectives. From this screen, you can add and delete them. To add a Scoring Objective, click Edit, and then New. Buzz generates a Guid and you are asked to choose a color to represent the objective using the color chooser or providing the hexadecimal number. To delete existing objectives, click the garbage can (delete) icon.
  • Learning Standards: To help assess objective mastery, Buzz allows you to align course activities with Standards from various states and/or organizations (these are drawn from the Achievement Standards Network (ASN) catalogue). To make an organization's standards available in your courses, provide its code and separate the items with commas. Check the boxes for the grade levels that you want included as well. By default, Buzz makes the following standards available to all domains (contact your Agilix account manager to add standards to your domain):
  • Activity Templates: If enabled, Buzz allows you to Add activity templates that content authors can copy to their courses and edit for their own needs.
    • Provide the Order you want each added item to appear in, the template Title, and the course you want the templates copied from. Content authors are given access to copy items from the syllabus of the indicated course.
    • Clicking the pencil (edit) icon opens the Editor for the indicated course.
  • Template Courses: If enabled, Buzz allows you to Add course templates that content authors can use as a structure when creating new courses.
    • Provide the Order you want each added item to appear in, the template Title, and the courses you want to provide as templates. Content authors can access these templates when creating a new course with the Teacher app.
    • Clicking the pencil (edit) icon opens the Editor for the indicated course.

Integrations

  • Authentication: Buzz supports the use of Single Sign-on (SSO) features to allow users to sign into one application (for example, a student information system) and be automatically logged into Buzz without needing to re-enter credentials.
    • To enable SSO, select CAS or SAML from this dropdown and:
      • Provide the server URL if you choose CAS.
      • Provide the idp-meta.xml if you select SAML.
      • Indicate whether you want to prevent users from logging in with Buzz credentials.
    • If you don't want to set up SSO, choose Buzz from this dropdown and:
      • Use the checkbox to indicate whether or not you want to Allow users to create their own accounts.
      • Check the Set password policy to specify password requirements.
    • If you want to allow another domain to be used to authenticate the current domain, select Domain, and indicate whether you want to prevent users from logging in with Buzz credentials.
  • Google Drive: Buzz allows districts and schools to enable a deep integration with Google Drive, so users can submit and view documents directly in Buzz. To configure this:
  • Library Extensions: Buzz allows you to make content from various online resources available in a Digital Library. These can include other courses within their district or organization as well as open sources like EdGate, OpenEd, and Kahn Academy. From this screen, you can add, edit, and delete library extensions for this library. To add a Library Extension, you are asked to provide:
    • An ID.
    • A Title.
    • The Provider name.
    • The URL.
    • A Thumbnail URL.
    • A decision to Show library or not.
  • LTI Credentials: Buzz allows you to integrate with other learning tools. From this screen, you can add and delete Learning Tools Interoperability (LTI) Credentials. To add a new LTI Credential, you are asked to provide the Hostname URL, the Key, and the Secret.

Advanced

  • String Override: Buzz's customizations options include the ability to automate word string replacements for any terminology in the app that doesn't match your organization, teaching model, branding, etc. From this screen, you can add and delete word String Overrides. To add an override, click Add and provide the Existing string and the desired Replacement String.

Old UI vs. New UI

Old Toolbar New Toolbar
Old Main Menu New Main Menu

Comments (3)

Sort by
Kevin Healy

When customizing my domain under "Settings --> Domain Options --> Menu Entries-Standard, it will not allow me to edit any settings for any admin level menu items. I have full permissions to the domain, but every time I click to edit Competencies, for example, it disappears and an objectives option creates itself under the Menu Entries-Custom. Any thoughts or advice?

Brad Marshall
  • Agilix team member

Hey Kevin, this is a bug. Those options shouldn't jump down to Custom. However, even though it is under Custom, you can still edit them. "objectives" is the ID for the tool that you call Competencies. 

Matthew Marichiba

The Menu Entries - custom section above doesn't mention the URL substitution variables. The only place I've seen those is in old BrainHoney docs. I needed that info just now, so figured I'd paste it here.

url - URL to display in a top level iframe when a user clicks the menu entry. This URL can contain dynamic replacement variables by surrounding them with double curly braces: {{VAR}}. These are the supported replacement variables:

  • TOKEN - The xLi authentication token for the currently logged in user. When using this variable, url must be a secure URL that starts with https.
  • USERID - The ID for the currently logged in user.
  • USERDOMAINID - The domain ID for the currently logged in user.
  • USERSPACE - The userspace for the customization domain, or the domain userspace visible in the top level URL.
  • ENROLLMENTID - The ID of the currently selected enrollment.
  • COURSEID - The ID of the course associated with the currently selected enrollment.
  • QUERY-<param> - The value of the top page's query parameter with the case-sensitive name of <param>. The application only replaces this variable if external is not set to true.
Please sign in to leave a comment.