Difference between revisions of "Portal Framework"
From Contensive Wiki
(→Add a Feature List) |
(→Add a Portal Feature List) |
||
(11 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
==Terms== | ==Terms== | ||
; Portals : A portal is a collection of features that create a common workspace environment. For instance the Account Manager (Invoice Manager) is a collection of features that manage accounts | ; Portals : A portal is a collection of features that create a common workspace environment. For instance the Account Manager (Invoice Manager) is a collection of features that manage accounts | ||
− | ; Portal Features : An addon, a database table, or a list of features that are associated with a portal. | + | ; Portal Features : An addon, a database table, or a list of features that are associated with a portal. Generally, when the cancel button is pressed on a feature, execution goes to the default feature, or the feature list that linked to the active feature. |
; Portal Feature List : An automatic feature created which displays buttons on a panel that each link to a portal feature. | ; Portal Feature List : An automatic feature created which displays buttons on a panel that each link to a portal feature. | ||
; Portal Default Configuration : When a portal is installed, just the portal record should be added. It contains a field called Default Configuration. When the portal is run, it detects that no features are installed and loads features based on this data file. | ; Portal Default Configuration : When a portal is installed, just the portal record should be added. It contains a field called Default Configuration. When the portal is run, it detects that no features are installed and loads features based on this data file. | ||
Line 17: | Line 17: | ||
===Create a Portal=== | ===Create a Portal=== | ||
− | # Open manage Addons, | + | # Open manage Addons, Portal Framework and click on Portals. |
− | # Add Portal Feature | + | # Click Add to add a new entry. |
− | # Select the feature | + | # Enter the portal name and select the default feature to display when the portal is first selected. |
− | # To display the portal | + | # Click OK to save the new portal. |
− | #* | + | |
+ | ===Add a Portal Feature List=== | ||
+ | |||
+ | A feature list is a single tab entry on a portal that when clicked, opens a panel of button. Use them to group a common set of features. | ||
+ | # Add a feature without an addon or content. This is the feature list. | ||
+ | # Add additional features and select the feature list you created. | ||
+ | |||
+ | ===Add Portal Features=== | ||
+ | # To add features to the new portal, click on Portal Features. | ||
+ | # Click Add. | ||
+ | # Enter the feature name and heading. | ||
+ | # Select the portal to include this feature. | ||
+ | # Select which feature list this feature will be included in. For example, People would be included in the Data Feature List. | ||
+ | # Choose the Addon or Content to which this feature should link. (If the feature runs an add-on, select it from that list; If the feature displays data, select it from the content list.) | ||
+ | # Type the name of the feature in the Alpha Sort Order field. | ||
+ | # Click OK to save the new feature. | ||
+ | |||
+ | ===To display the portal=== | ||
+ | #* If you only have one created on the site, simply run the portal addon under Portal Framework. | ||
#* If you have multiple portal records, create an addon and use any addon technology to call the portal with the correct portals record. | #* If you have multiple portal records, create an addon and use any addon technology to call the portal with the correct portals record. | ||
#** Add to the addons html the json execution string = {% { "addon":{ "addon":"portal", "portalGuid":"{12528435-EDBF-4FBB-858F-3731447E24A3}" }} %} | #** Add to the addons html the json execution string = {% { "addon":{ "addon":"portal", "portalGuid":"{12528435-EDBF-4FBB-858F-3731447E24A3}" }} %} | ||
Line 27: | Line 45: | ||
#** Write a program that executes the portal addon after calling cp.doc.setProperty( "portalId", -yourManagerId- ) or cp.doc.setProperty( "portalGuid", -yourManagerGuid- ) | #** Write a program that executes the portal addon after calling cp.doc.setProperty( "portalId", -yourManagerId- ) or cp.doc.setProperty( "portalGuid", -yourManagerGuid- ) | ||
− | ===Add a | + | ===Add a Link from one portal to another=== |
− | # | + | # Edit the portal record. |
− | # | + | # in the tab Portal Links, click the checkbox next to the portal you want included. |
− | + | ||
− | + | ||
− | === | + | ===Create an addon for a portal=== |
− | + | # Create an addon and include in its html section the following text. Replace the guid string with the guid from your addon. | |
− | # | + | |
− | + | {% {"addon":{"addon":"portal","portalGuid":"{12528435-EDBF-4FBB-858F-3731447E24A3}"}} %} | |
===Restore the installed feature configuration=== | ===Restore the installed feature configuration=== |
Latest revision as of 16:34, 27 February 2017
The Portal Framework is a quick way to create an set of tools with a common purpose, like the Account Manager (aka Invoice Manager)
This documentation will be completed with the code is released
Terms
- Portals
- A portal is a collection of features that create a common workspace environment. For instance the Account Manager (Invoice Manager) is a collection of features that manage accounts
- Portal Features
- An addon, a database table, or a list of features that are associated with a portal. Generally, when the cancel button is pressed on a feature, execution goes to the default feature, or the feature list that linked to the active feature.
- Portal Feature List
- An automatic feature created which displays buttons on a panel that each link to a portal feature.
- Portal Default Configuration
- When a portal is installed, just the portal record should be added. It contains a field called Default Configuration. When the portal is run, it detects that no features are installed and loads features based on this data file.
- Default Feature
- The portal feature that is displayed when no other feature is selected
Roles
- Developer
- A user with the developer checkbox checked. A developer creates Portals and Portal Features, and has the automatic Developer Tools Feature.
How-To
Create a Portal
- Open manage Addons, Portal Framework and click on Portals.
- Click Add to add a new entry.
- Enter the portal name and select the default feature to display when the portal is first selected.
- Click OK to save the new portal.
Add a Portal Feature List
A feature list is a single tab entry on a portal that when clicked, opens a panel of button. Use them to group a common set of features.
- Add a feature without an addon or content. This is the feature list.
- Add additional features and select the feature list you created.
Add Portal Features
- To add features to the new portal, click on Portal Features.
- Click Add.
- Enter the feature name and heading.
- Select the portal to include this feature.
- Select which feature list this feature will be included in. For example, People would be included in the Data Feature List.
- Choose the Addon or Content to which this feature should link. (If the feature runs an add-on, select it from that list; If the feature displays data, select it from the content list.)
- Type the name of the feature in the Alpha Sort Order field.
- Click OK to save the new feature.
To display the portal
- If you only have one created on the site, simply run the portal addon under Portal Framework.
- If you have multiple portal records, create an addon and use any addon technology to call the portal with the correct portals record.
- Add to the addons html the json execution string = {% { "addon":{ "addon":"portal", "portalGuid":"{12528435-EDBF-4FBB-858F-3731447E24A3}" }} %}
- Add to the addons wysiwyg editor the portals addon. Display it and turn on advanced edit. Use the instance tool (wrench) to select the portals record.
- Write a program that executes the portal addon after calling cp.doc.setProperty( "portalId", -yourManagerId- ) or cp.doc.setProperty( "portalGuid", -yourManagerGuid- )
Add a Link from one portal to another
- Edit the portal record.
- in the tab Portal Links, click the checkbox next to the portal you want included.
Create an addon for a portal
- Create an addon and include in its html section the following text. Replace the guid string with the guid from your addon.
{% {"addon":{"addon":"portal","portalGuid":"{12528435-EDBF-4FBB-858F-3731447E24A3}"}} %}
Restore the installed feature configuration
The default configuration for a portal is installed with the portal record. It is automatically restored when no features are found.
- Edit the portal record and verify the default configuration is populated
- Delete all portal feature records for this portal
- Open the portal and the default features are automatically re-populated
Save Your Portal Configuration to install on other sites
If you create a portal and want to be able to deploy it on another sites:
- Log in as a developer and an additional automatic feature appears on all portals, the Developer Tools
- On the Developer Tool, click the snapshot button. This saves the current feature configuration in the Manager's default configuration.
- Create a collection with the portal data record.
Reference
Content
The portal framework uses the following content and fields. See help under the individual fields in the installation for more details.
- Managers
- Each record is an individual portal with features
- name
- active
- default feature
- default configuration
- Manager Features
- Each record is a feature within a portal
- name
- heading
- active
- portal
- include in feature list
- add-on
- content
- sort order
Test Cases
- 1
- Delete the Sample Manager and setup a new Sample Manager to be used for testing