The Calendar Generator Color Manager is the collection of colors that will be used in generating a random calendar. Only the colors listed in the collection will be used in calendar generation.
The Settings Tab brings up all of the available setting options for the Calendar Generator tool. You can read of the settings available in the Calendar Settings article.
Add Color Button
The Add Color Button allows you to add a new color to the collection of colors used for calendar generation. Please see the section below for adding a new color.
The Search Colors text area allows you to display only the colors that match a specific text value, used to quickly locate the color you are searching for.
A color can be deleted from the collection of colors by clicking the Trash Icon next to the name of each color.
The Available Colors are all of the colors that will be potentially used in color Generation. Note, if a color has no users associated with it, that color may be excluded depending on the "Include Empty Colors" checkbox under the Settings tab of the Calendar Generator (please see the Calendar Settings article for more information).
Settings For Each Individual Color
Each individual color has a number of settings associated with it of both an informational and functional nature. These settings allow you to customize the behavior of a given color within the Calendar Generator.
The Test Effective Window setting for a color is for informational purposes only, and is designed to allow the agency to provide context to the color in regards to the nature of testing performed on a user with that color. It refers to the effective window of time a given test is effective to detect a substance, rather than the specific test used itself to do so. For example, a PBT test has an effective window of approximately 4 hours while a EtG test has an effective window of 80 hours. Thus you may elect to assign all users being tested using a PBT to one color and an EtG to another, using this flag to distinguish them for the agency.
The Frequency setting for a color maps to one of the frequency percentages defined in the Calendar Settings to the color and can be a value from "Very Low" to "Very High". This will determine how likely the color is to be called on a given day and, thus, how frequently it is called in a given month.
The Publish Time setting for a color refers to the time of day (using the portal's configured time zone) the specific color in question should be published if called on that day. If a color is calculated to be called on the 2nd Monday at 2pm, on that date it will not be published until 2pm local time.
Adding a New Color to the Collection
To Add a new color to the collection of colors used in generating a calendar, click the Add Color button. This will bring up a dialog allowing you to add a new color to the list.
Close / Cancel
Click the X in the upper right hand corner to close the dialog window and cancel the adding new color operation.
A search bar allowing you to search for a new color to add from our database of available colors. Simply start typing in the color you wish to add to see a list of available options:
Once you have found a color that suits your need, click it to select and auto-populate the remainder of the form with it.
You are not required to use the Color Search feature to add a new color, but it is recommended.
Used Color Name
When using the Color Search feature, as shown in the image above, a simple color name such as "Blue" returns a number of versions of that color using different names. The Color Name box indicates how the color should be presented when published. Color names can only contain alphanumeric characters and hyphens. For compound names of colors (such as "Alice Blue") the Platform will automatically translate it to a suitable Color Name value for use (i.e. "alice-blue").
It is recommended whenever possible to replace the name provided with the simplest name for that color on your platform. If you only have one "blue" color on your calendar it should be named simply "blue" instead of "alice-blue". The more complicated the name is the more possibility for confusion by the users of the automated dial in system, etc. Compound Color names should only be used when you have multiple versions of the same color (i.e. "baby-blue" and "alice-blue").
The Color Hex value should be automatically assigned for any color added using the Color Search tool, and refers to the actual visible color used to render this identifier in the calendar and elsewhere in the platform. Manually setting the Color Hex value is recommended only for advanced users with a prior understanding of its meaning. If you are interested in learning how this value is created and used, we recommend reading this article that explains it in detail.
This is the Effective Window value discussed earlier in this article for the new color
This is the Frequency value discussed earlier in this article for the new color
Once the color has been properly configured to your desired settings click the "Save New Color" button to add it to the collection of available colors.