Overview
This article contains instructions on how to map Event Text Library elements to a plan object. The Event Text Library is a feature of the Events module in Cumulus.
For instructions on how to create these elements and maintain them in your library, see this article.
To learn what the Event Text Library is and how it might be used in your business, see this section.
Mapping the Library Element To A Plan
Under each supported plan object is a sub tab called Event Text Elements. This sub tab is used to link an event text element located in the library to a plan so the text will be included in the notification.
Users cannot control the status of the mapping record. The status is derived from the effective from and effective to date fields.
The effective dates 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.
Below is a pictorial representation comprising:
- an overarching timeline covering a two month period
- a text element in the library that is active for the entire period.
- two plan mappings with a gap in between.
The system will insert the custom text when both the library element and the plan mappings are in the status of is Active.
Once a text element has been correctly set up and configured, it can be mapped to one of the following billing objects in Cumulus:
| Billing Object | Location In Cumulus |
|---|---|
Package Plan | Packages and Plans > Package Plan > Package Plan Details > Event Text Elements |
| Service Plan | Packages and Plans > Service Plan > Service Plan Details > Event Text Elements |
| Bolt-On | Packages and Plans > Bolt-Ons > Bolt-On Details > Event Text Elements |
| Bolt-on Add-on | Packages and Plans > Bolt-On Add-On > Bolt-On Add-On Details > Event Text Elements |
To map your library item to a plan, follow the steps below.
- Click the Map Library Element button and complete the fields.
- Select the library item from the drop down list.
- Enter the Effective From date.
- Enter an optional Effective To date.
- Save your changes.