Administrator

Themes are a combination of a color and a background image. Each user can select from the available colors or background images to create their own unique theme. Administrators can configure what the default theme would be for their users that have not selected their own theme, and what colors and background images are available for user selection.Default theme

The default theme allows a domain to establish its brand for new and existing users. The customizable attributes are:

• background: The background image to use for the default theme and sign-in screen. The default is a color that matches the theme color. This attribute’s value is the relative path to the image. The ideal size for this image is 1600x1200.
• backgroundThumbnail: The thumbnail background image to use for the default theme. This attribute’s value is the relative to the image. The ideal size for this image is 150x112.
• theme: The default theme color to use. This attribute’s value is any of the values in ‘Theme Colors.’

To configure your default theme in your domain:

1. Open the Configure tool in the Admin app.
2. Select the Manage Resources page.
3. Upload an image for each attribute you want to customize.
4. Select the Customize Domain page.
5. Within the <settings> element, add a <defaultTheme> element.
6. Within the <defaultTheme> element, add the attribute for each item you want to customize.
7. For each attribute, add a value of the relative path or theme color.
8. Save your customization.

Example:

<defaultTheme
     background="background.jpg"
     backgroundThumbnail="background-thumb.jpg"
     theme="Red" />Theme Colors

By default, all theme colors are available to users to select. Administrators can define the themes colors that are available for the users to choose. The theme colors are listed in the table below.

| Name | Color (dark version) | | Red | #B71C1C | | Pink | #880E4F | | Purple | #4A148C | | DeepPurple | #311B92 | | Indigo | #1A237E | | Blue | #0D47A1 | | LightBlue | #01579B | | Cyan | #006064 | | Teal | #004D40 | | Green | #1B5E20 | | LightGreen | #33691E | | Lime | #827717 | | Amber | #FF6F00 | | Orange | #E65100 | | DeepOrange | #BF360C | | Brown | #3E2723 | | Grey | #212121 | | BlueGrey | #263238 | | HighContrast | red, white |

To configure your default theme in your domain:

1. Open the Configure tool in the Admin app.
2. Select the Customize Domain page.
3. Within the <settings> element, add a <defaultTheme> element.
4. Within the <defaultTheme> element, add a <themes> element.
5. Within the <themes> element, add a <theme> element for each theme color you want.
6. For each <theme> element, add a name attribute.
7. For each name attribute, add a value of the theme color “name.”
8. Save your customization.

Example:

<defaultTheme
     <themes>
          <theme name="Cyan" />
          <theme name="Lime" />
          <theme name="Grey" />
     </themes>
</defaultTheme>Theme Backgrounds

By default, all theme background images are available to users. Administrators can define the theme backgrounds that are available for the users to choose, as well as provide additional backgrounds. The default available theme backgrounds are displayed in the table below.

| Name | Image | | Stars |  | | Elephants |  | | Birds |  | | Umbrella |  | | Diamonds |  | | Television |  | | Football |  | | Baseball |  | | Aurora |  | | Electronics |  | | Fish |  | | Grassy Texture |  | | Kitten |  | | Soccer |  | | Boat |  | | Books In Field |  | | Golf |  | | Rays |  | | Winter Sunrise |  |

When providing additional backgrounds, the customizable attributes are:

• name: The name of the background image to show. Valid values for existing images are the theme background “name.” Otherwise, supply a unique name for a custom background.
• path: Relative path to a custom background image. The ideal size for this image is 1600x1200.
• thumbnail: Relative path to a custom background image thumbnail. The ideal size for this image is 150x112.

To configure the theme backgrounds in your domain:

1. Open the Configure tool in the Admin app.
2. For custom backgrounds, select the Manage Resources page.
3. For custom backgrounds, Upload each custom background image you want to include.
4. Select the Customize Domain page.
5. Within the <settings> element, add a <defaultTheme> element.
6. Within the <defaultTheme> element, add a <backgrounds> element.
7. Within the <backgrounds> element, add a <background> element for each theme background you want.
8. For each <background> element, add a name, path (if custom background), thumbnail (if custom background) attribute.
9. For each attribute, add the appropriate value for the theme background.
10. Save your customization.

Example:

<defaultTheme
     <backgrounds>
          <background name="Fish" />
          <background name="Kitten" />
          <background name="My Custom Background" path="mySchool.png" thumbnail="mySchoolThumbnail.png" />
     </backgrounds>
</defaultTheme>

Notes

• Domain configuration is inherited by all subdomains unless explicitly overwritten by a subdomain.
• For better display on high-density screen, store any image with a resolution two times the rendered size. For better performance, store large images as a compressed JPG files.

Additional articles

• How do I brand my domain?
• Buzz Technical Documentation: Customizing Buzz

Tips

• To complete this task, you will need to edit your domain configuration; if you need help, contact the Agilix Support team.