Including Special pages
Special Pages are such wizard pages that can perform some specific actions, that are built into the Docupace system code. These pages cannot hold fields on them and do not have a visualization. Special pages do have additional settings, that allow to configure their behavior.
- Open the JSON tab of the Docupace Builder screen. This tab lets you edit the underlying JavaScript code of the wizard directly. It also let you add features that cannot be added visually, yet. Currently Special Pages can be added through JSON tab, and then configured through the Wizard tab.
- Add code within the pages object to create a new Special page.
Image Added
Adding new special pages in JSON tab
The following special pages are currently supported:
Page type & Description | Code sample |
initStartingPointData
Loads any initial data for this wizard, if such is available. E.g. if the wizard is launched from another wizard, previously filled data is forwarded on to this wizard. This page is created automatically for a new wizard. | "initStartingPointData": {
"pageType": "initStartingPointData"
}, |
mapStartingPointData
Loads additional data for this wizard. This data is added to data loaded with the initStartingPointData page. There are mappings configured in "FM M-to-M converters (249)" domain, which define what data will be loaded by this page. Some are built-in based on Docupace version. Others are configured per customer site. | "mapStartingPointData": {
"pageType": "mapStartingPointData"
}, |
searchableTilesSelect
Loads a page with the data displayed as large tiles with names and icons, where one tile can be selected and the corresponding action launched. For example, a list of vendors as tiles. | "searchableTilesSelect": {
"pageName": "Vendor selection",
"pageType": "searchableTilesSelect"
}, |
createWorkItem
Creates a Work Item, passing to it the data entered in previous pages. Documents can be uploaded to the created Work Item and Work Item's ID can then be displayed. | "createWorkItem": {
"pageName": "Creating Work Item...",
"pageType": "createWorkItem"
}, |
createOrUpdateWorkItem
If information about a previously created WI is available, this WI will be updated. If not - a new WI will be created.
The following fields are required in page config:
"workItemIdMetaField": "Request1.Ari.Id",
"workItemNamespace": "BASE"
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0f7aa058-5dfb-4f5a-8d39-4c419ba6b126"><ac:plain-text-body><![CDATA[Request1.Ari.Id - means that id of WI to update will be present in startingPointData under this key (startingPointData["Request1.Ari.Id"])
]]></ac:plain-text-body></ac:structured-macro>
Namespace defines the source of field data. If data is created within Docupace, workItemNamespace = BASE. But if imported from other systems, could be something else, e.g. REDTAIL, ESIGN, etc.
List of namespaces are defined in the "FM Namespaces (247)" domain. | "createOrUpdateWorkItem": {
"pageName": "Updating Work Item...",
"workItemIdMetaField": "Request1.Ari.Id",
"pageType": "createOrUpdateWorkItem",
"workItemNamespace": "BASE"
}, |
skipTo
Navigates to a different page, based on defined conditions.
Only transition with the name "skip" will work. This transition will define to which page the wizard will be redirected.
You can also have multiple conditions with different page IDs. Conditions will be checked one by one. First condition which is evaluated to truthful value, defines the page to go to. | " skipTo": {
"pageType": "skipTo",
"skipTransition": "skip"
}, |
- Open the Wizard tab of the Docupace Builder screen. Select the page name of the newly created page from the list and click +Add button to add the Special Page to the page tree.
Image Added
Adding new special pages in Wizard tab
- Select the page name of the newly created page in the page tree and click Page Settings button.
Image Added
Page Settings for a Special Page
- Fill out the Page settings depending on the type of Special page you have created. Most settings are common to regular wizard pages as well as to the Special pages. All settings are described in the Page Settings topic.
Image Added
Custom Page Settings for a Special Page
- Click Apply button in the bottom of the screen to close the Widget Design Screen and apply changes. Then click Save button in the top of the Widget Details Screen to save these changes.
