Deployment Tool
The Deployment Tool simplifies the process of publishing forms by deploying the form onto either a Homepage or the GT eForms WorkCenter. This action takes the place of generating form task links from the Form Family Table and Form Setup page.
Users need to have the PeopleSoft Portal Admin
Role for the Deployment Tool to be able to update the CREFs during deployment.
The deploy tool has multiple sections. The sections shown will vary based on the type of deployment.
Inputs Section
This section is used to define which Family or Search Set to deploy and where to deploy it. This section displays for both Homepage and Workcenter deployments.
Field | Value/Use |
---|---|
Family/Search Set | Use the prompt to lookup an existing Form Family or Search Set. |
Where do you want to deploy? | Choose either Homepage or Workcenter |
Navigation Collection
This section displays for both Homepage and Workcenter deployments.
Navigation Collection
Field | Value/Use |
---|---|
Current State | Shows the current status of the navigation collection. If has never been deployed, the current status will show as blank. If previously deployed, will state deployed. |
Action to Take | Select either Deploy, Update or Remove. If form has not been deployed, the update and remove options will not show. |
Nav Collection Label | The Navigation Collection Label |
Navigation Collection Links
Field | Value/Use |
---|---|
Set All Actions To | Shortcut to set all actions. Options may include Deploy, Update, Remove |
Clear All Actions | Shortcut to clear all actions |
Current State | Shows the current status of the navigation collection. If has never been deployed, the current status will show as blank. If previously deployed, will state deployed. |
Action to Take | Select either Deploy, Update or Remove. If form has not been deployed, the update and remove options will not show. |
Form Type | Read-only display of the form types within the selected Form Family/Search Set. |
Form Task | Read-only display of the Form Task. ADD = Add Task UPD = Update Task EVL = Evaluate Task VWS = View Task LP – Landing Page |
Form Condition | Read-only display of the Form Condition. All forms start with one “Default” condition. |
Portal Label | Enter a label to be displayed on the Homepage/WorkCenter |
Sequence Number | Used to change the sequence order of the links. |
Additional Settings | Shows after deployment. If clicked, will open the Advanced Parameters window. |
Additional Settings
Field | Value/Use |
---|---|
From | Enter a date as a start date for when the WorkCenter or Homepage link should be available for users. |
To | Enter a date as an end date for when the WorkCenter or Homepage link should end for users. |
Additional Parameters | Additional parameters for advanced use |
Additional Settings (Landing Page)
Field | Value/Use |
---|---|
From | Enter a date as a start date for when the WorkCenter or Homepage link should be available for users. |
To | Enter a date as an end date for when the WorkCenter or Homepage link should end for users. |
Landing Page Instructions | Rich Text editor for editing Landing Page text. |
Sections When Deploying to Homepages
This section will show only when Homepage is selected.
Tile
Field | Value/Use |
---|---|
Current State | Shows the current status. If item has never been deployed, the current status will show as blank. If previously deployed, will state deployed. |
Action to Take | Select either Deploy, Update or Remove. If item has not been deployed, the update and remove options will not show. |
Tile Label | The label to display to users on the tile |
Homepages
Field | Value/Use |
---|---|
Current State | Shows the current status of the navigation collection. If has never been launched, the current status will show as blank. If previously deployed, will state deployed. |
Action to Take | Select either Deploy, Update or Remove. If form has not been deployed, the update and remove options will not show. |
Homepage Name | Use the prompt lookup to select the Homepage the form links should be launched on. |
Label | Display only, label associated with selected Homepage |
Add GT Homepage | Shortcut to add GT Homepage. Tile will be deployed to the homepage(s) selected |
Add Homepage | Add additional rows to the grid |
Sections When Deploying to WorkCenter
This section will show only when WorkCenter is selected.
WorkCenter Pagelets
Field | Value/Use |
---|---|
Current State | Will indicate Deployed or not |
Action to Take | Displays available options which may include Deploy, Update, and Remove |
Pagelet Label | Enter a label to be displayed on the Homepage |
Manage Pagelet Sequence | When clicked, opens the Manage Pagelet Sequence window. |
Manage Pagelet Sequence
Field | Value/Use |
---|---|
Pagelet Name | Full name of the pagelet, Read-only |
Portal Label | Description of the pagelet, Read-only |
Sequence Number | Sequence number determines display order |
Save Sequence Numbers | Applies changes |
Return | Closes the modal window |
Buttons/Links
This section displays for both Homepage and Workcenter deployments.
Field | Value/Use |
---|---|
Deploy/Save Changes | Save/Apply changes |
Show Content Reference Names | Toggles advanced display on and off |
Show Content Reference Names
The following is an example the sections of the Deployment Tool when “Show Content Reference Names” toggled on.
Access to Deployment Tool
There are 5 ways to access the deployment tool. The default behavior of the page will vary slightly depending on the context.
- Deployment Tool page
- Navigation: Manage GT eForms 3.x > Deployment Tool
- If nothing is deployed, everything is marked to be deployed
- Form Family Table
- Navigation: Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Form Family Table
- If nothing is deployed, everything is marked to be deployed
- Search Set Page
- Navigation: Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Search Sets
- If nothing is deployed, everything is marked to be deployed
- Form Type Level
- Navigation: Manage GT eForms 3.x > Form Setup > General tab
- If the form belongs to only one form family/search set, the family will default. If more than one, lookup will be used.
- Any form type add links that are not deployed will be marked to be deployed
- Form Task Level
- Navigation: Manage GT eForms 3.x > Form Setup > Pages tab
- Form Type, Condition, and Task will default
- If condition add link is not deployed, it is marked to be deployed
Label Conventions
This section describes the convention used for default labels. All labels can be modified.
Note: Family.DESCRSHORT will be used if it exists, otherwise Family.G3FORM_FAMILY will be used
Navigation Collection Label
[Family.DESCRSHORT] or [SearchSet.SEARCHSET]
Tile and Pagelet
[Family.DESCRSHORT] or [SearchSet.SEARCHSET] eForms
Links
Add a [condition
(if not Default)] [FormType.DESCRSHORT
] eForm
Update/Evaluate/View a [Family.DESCRSHORT
] eForm
or
Update/Evaluate/View a [SearchSet.SEARCHSET
] eForm
Functional Tips
Changing Form Style
When switching forms from classic to fluid or vice versa, follow these steps:
- First set the existing Navigation Collection Links to Remove and Save
- Navigate to the Form Setup page and change the form style
- Set all Navigation Collection Links to Deploy and Save
If any of the form tasks in the family/search set are fluid, the landing page will be fluid. If any of the family tasks (Evaluate, Update or View) are fluid, those links will point to fluid search pages.
Moving Form Families
When moving a Form Type to a new Form Family, follow these steps:
- In the old Form Family, first set the Form Type Navigation Collection Links to Remove and Save
- Navigate to the Form Setup page and change the Form Family
- Set the Form Type Navigation Collection Links to Deploy and Save
Links can also be removed manually via Structure and Content if the above steps are missed.
Limitations
The deploy tool only deploys to the current portal. To add navigation on other portals, users will have to manually change the content references in Structure and Content.