sections in the article
To use Planner, you need to set up the Model to support the Planner requirements in the Model Menu in Control Center.
1. Create CVLs
You should create the following CVLs in Control Center (if they do not already exist):
- ActivityStatus – CVL(ActivityStatus)
- MilestoneStatus – CVL (MilestoneStatus)
Also add CVL with Year, Quarter, Month and Week to maximize the filtration possibilities. Read more here.
2. Create EntityType for an activity
Add the following FieldTypes to the EntityType:
- ActivityName (String)
- ActivityDescription (String)
- ActivityStartDate (DateTime) -- MANDATORY
- ActivityEndDate (DateTime) -- MANDATORY
- ActivityStatus – CVL(ActivityStatus)
Note: If you want to show date bars in the overview, you need to add the two date fields EntityStartDate and EntityEndDate to your Entity, in this case the fields ActivityStartDate (DateTime) and ActivityEndDate (DateTime).
3. Create entityType for a milestone
A Milestone is basically a one-day event Entity that is displayed as a Milestone in Planner. Add the following FieldTypes to the EntityType:
- MilestoneNodeName (String)
- MilestoneDescription (String)
- MilestoneStartDate (DateTime) -- MANDATORY
- MilestoneEndDate (DateTime) -- MANDATORY
- MilestoneStatus – CVL (MilestoneStatus)
Note: If you want to show date bars in the overview, you need to add the two date fields EntityStartDate and EntityEndDate to your Entity, in this case the fields MilestoneStartDate (DateTime) and MilestoneEndDate (DateTime).
4. Create the following linkTypes on the entity:
Since Activity in this case is the top-level Entity, you should create these links under "Includes" on the Entity in Control Center.
- ActivityMilestones
- Source: Activity
- Target: Milestone
- ActivityResources (If the Model has EntityType Resource)
- Source: Activity
- Target: Resource
5. Add server settings
You must create the following Server Settings in the Setting model in Control Center (if they do not already exist):
- PLANNER_ENTITYTYPES: Activity,Milestone
- PLANNER_MILESTONE_ENTITYTYPES: Milestone
- PLANNER_TOOLTIPS_ENABLED: true/false
- PLANNER_INTERACTIVE_EDITING_ENABLED: true/false
- PLANNER_COLORS: [Empty]
- SHOW_WEEKS_IN_DATE_PICKER: true/false
PLANNER_ENTITYTYPES: Activity,Milestone
Here is where we setup the EntityTypes that should be included in the Planner (you can set up your own Entities in Control Center for your Planner module. Always place the top-level EntityType as the first entry in the list. In our example, Activity is the top EntityType that have a relation (LinkType) to (Activity->Milestone,).
PLANNER_MILESTONE_ENTITYTYPES: Milestone
The Milestone EntityType setting specifies which Entity (Entities) should be displayed as Milestones (basically a one-day event) in the Planner.
PLANNER_TOOLTIPS_ENABLED: true/false
Shows tool tips in the Planner overview. To show an image in the Tool Tips, make sure to have a LinkType between shown EntityType and Resource.
PLANNER_INTERACTIVE_EDITING_ENABLED: true/false
Makes it possible to change the start and end date directly in the Planner overview.
PLANNER_COLORS (leave empty)
Here you set up the container for colors that are used on the bars in the overview. The colors are configured in Planner, under the Configuration tab. You need to be an Admin user to access the Configuration tab. Please note that it is only single value CVLs that can be used when setting colors in the Planner, multi-value CVLs will not work.
SHOW_WEEKS_IN_DATE_PICKER: true/false
Here you set if you want to display the week number in a date picker on a Planner Entity.
6. Completeness rules for planner
You can set up Completeness rules on the Entity to see the progress of your planned activities.
7. Templates
You can set up predefined templates for e.g. marketing activities, campaigns, product launches etc. Add a CVL that defines if this Entity is of type template or not. Set the default value to no.
8. API
You can add your own functionality by using inriver Extensions.
Comments
0 comments
Please sign in to leave a comment.