Overview
This article contains instructions for users needing to create and maintain Event Text Library elements. The Event Text Library is a feature of the Events module in Cumulus.
For instructions on how to link an Event Text Library element to a plan billing object, go to this article.
To learn what the Event Text Library is and how it might be used in your business, see this section.
Event Text Element Statuses
Library elements can have one of two states.
| Status | Description and Behavior |
|---|---|
| Draft | Text elements are being drafted and not ready for use. Elements in the draft status will not be used regardless of the effective date, and whether or not the template variable has been added to the event template. |
| Active | The text element is ready to be used, and is being used, provided all other configuration has been completed correctly. |
Accessing The Event Text Library
Users can access the Event Text Library at the following location:
Packages and Plans > Event Text Library
The user will be taken to the front page of the library where a list of text elements that have already been created will be shown in a list.
This list page shows:
- The basic details of the text element
- the system event type that the element will be used in
- the status of the text element
- the number of textural content elements stored within the library element.
Use the search filters to return the library items you're looking for.
Creating a New Library Element
To create a new library item, click the Create New Event Text Item button. The new library item page will be displayed.
The first 3 fields define the text element. Complete the fields as follows:
| Field | Description |
|---|---|
| Name | Give your new text element a name. |
| Description | Give your new text element a description. |
| Event Variable | Choose the event variable and event type combination that will be used to insert this text element into the event. The format of the list is as follows: [Event Type Name] - [variable_name] When the chosen variable is inserted in the event template, the content from the element will be used in the same way as other event variables. |
The following fields define the actual content element
| Status | The status of the element. See this section for the definitions. |
| Effective Date | The content can be used in an event from this date. This works independently of the status. If the status = active but the effective date has not been reached, the element will not be used. |
| Text | Enter the text of your message into this field. |
When you are done, press Submit.
Textural library elements are limited to 265 characters and formatting is limited to ASCII characters only. No HTML or other formatting is supported.
Editing a Library Element
To view or edit, start at the Event Text Library list page:
Click on the ID of the element. The element's detail page will open with:
- a summary section under the heading containing the item's definition.
- a Content sub tab underneath provides access to the content element list.
To edit the library item summary information:
- Click the Edit button to put the section into EDIT mode.
- Make the changes as required.
- Press Save to save the changes and return to the text item's page.
To view the content of an Approved element:
- Click the ID of the element that is to be edited in the contact sub tab.
To view, edit or approve the content of a Draft element:
- Click the Edit button to put the section into EDIT mode.
- Make the changes as required.
- Press Save to save the changes and return to the text item's page.
Discontinue Use of a Library Element
Library items can not be deleted and there is no appropriate status that can be used to stop the system using yhe element.
To discontinue the use of the library item, users have the following options:
- remove the template variable from the event template.
- update the effective to date of the element mapping to a date in the past.
used when the library element is mapped to the plan will not override the status or effective dates set on the library element itself. If the item in the library is not active, the Effective From date has not been reached or the Effective To date is in the past, the event will not use the text element regardless of the effective dates that are set in the mapping.