How to configure a section for runtime authoring
Section has the capability to take many forms with the options available under its “Settings” tab of its ruleform. We can go over few of those options with regards to runtime authoring.
Non-template Section settings
A regular or non-templated section is created when a section rule is created with the option to “Create Section using a Design Template” unchecked.
For any non-templated section following options are available with “Standard section” as default.
We will focus on following options since it will be used in runtime authoring
-
Workarea widget: An example of this kind of section is pyAssignmentListGadget. This configuration is used in a special case where a section using design template is marked as a “Workarea layout”. There are few out-of-the-box sections with this configuration and it is sourced from D_pzWidgetSections datapage . This is discussed later in this document.
-
Design template: An example of this kind of section is pySecondaryColumnPageTemplate. This configuration is used when a repeated data structure can be templatized and used while creating a section using this template. As of 8.1 version there are 22 layouts available out-of-the-box. Developer can add their own templates if needed by configuring the section “Settings” tab using this option. To learn more about design templates refer the following post:
Template Section settings
A templated section can be created by selecting the “Create Section using a Design Template” checkbox at section creation time.
When this option is selected at creation time it adds the value 'templated':'true' to the section’s data-ui-meta attribute which is used at runtime to determine if that section could have full property panel access or limited with the “Design Mode” ON.
Sections not in Data-Portal or Data-Portal-PegaExpress or @baseclass class
If you have a section using design templates that is not in the Data-Portal or Data-Portal-PegaExpress or @baseclass class then you would see the following list of options under “Setting” tab of the ruleform.
Allow section to be edited at runtime
The “Allow section to be edited at runtime” checkbox is significant in determining if this section should be allowed for editing its content at runtime. When this option is selected at design time it adds the value 'editable':'true' to the section’s data-ui-meta attribute which is used at runtime to determine if highlighting to edit should happen with the “Design Mode” ON. This highlighting happens on hover over that section.
By default, all the sections marked for editing would show dotted outline around it.
The runtime editing is limited and for runtime authoring capabilities refer the following post:
The section marked as “Workarea layout” has unique features and pyCaseMainInner is one such section:
-
This is designed mainly for case content area to move its different sections/forms keeping it at the higher level and will not allow granular level interaction like adding or updating fields. The purpose is to move sections within the template.
-
Sections marked as “Workarea widget” can be added from layout editor’s region header “+” icon.
-
Change to a different template using “Change” button from the layout editor.
In App Studio such section would have the highlighted infobar with title “Workarea” with the “Design Mode” ON.
Sections in Data-Portal or Data-Portal-PegaExpress or @baseclass class
If a section is in Data-Portal or Data-Portal-PegaExpress or @baseclass class then it has additional options listed under its “Standard” selection.
This feature is for marking a section to be used as a component for web channel creation. The above out-of-the-box section pyCaseWorkerAlternatePortalHeader is marked to be listed as “Header” while creating web channel.