Skip to main content

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.

SECURITY

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.

Screenshot Deployment Tool Family/Search Set

FieldValue/Use
Family/Search SetUse the prompt to lookup an existing Form Family or Search Set.
Where do you want to deploy?Choose either Homepage or Workcenter

This section displays for both Homepage and Workcenter deployments.

Screenshot Navigation Collection

FieldValue/Use
Current StateShows 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 TakeSelect either Deploy, Update or Remove.
If form has not been deployed, the update and remove options will not show.
Nav Collection LabelThe Navigation Collection Label
FieldValue/Use
Set All Actions ToShortcut to set all actions. Options may include Deploy, Update, Remove
Clear All ActionsShortcut to clear all actions
Current StateShows 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 TakeSelect either Deploy, Update or Remove.
If form has not been deployed, the update and remove options will not show.
Form TypeRead-only display of the form types within the selected Form Family/Search Set.
Form TaskRead-only display of the Form Task.
ADD = Add Task
UPD = Update Task
EVL = Evaluate Task
VWS = View Task
LP – Landing Page
Form ConditionRead-only display of the Form Condition. All forms start with one “Default” condition.
Portal LabelEnter a label to be displayed on the Homepage/WorkCenter
Sequence NumberUsed to change the sequence order of the links.
Additional Settings Image Additional Settings IconShows after deployment. If clicked, will open the Advanced Parameters window.

Additional Settings

Screenshot Advanced Parameters

FieldValue/Use
FromEnter a date as a start date for when the WorkCenter or Homepage link should be available for users.
ToEnter a date as an end date for when the WorkCenter or Homepage link should end for users.
Additional ParametersAdditional parameters for advanced use

Additional Settings (Landing Page)

Screenshot Additional Settings Landing Page

FieldValue/Use
FromEnter a date as a start date for when the WorkCenter or Homepage link should be available for users.
ToEnter a date as an end date for when the WorkCenter or Homepage link should end for users.
Landing Page InstructionsRich Text editor for editing Landing Page text.

Sections When Deploying to Homepages

This section will show only when Homepage is selected.

Screenshot Homepages option

Tile

FieldValue/Use
Current StateShows the current status. If item has never been deployed, the current status will show as blank. If previously deployed, will state deployed.
Action to TakeSelect either Deploy, Update or Remove. If item has not been deployed, the update and remove options will not show.
Tile LabelThe label to display to users on the tile

Homepages

FieldValue/Use
Current StateShows 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 TakeSelect either Deploy, Update or Remove. If form has not been deployed, the update and remove options will not show.
Homepage NameUse the prompt lookup to select the Homepage the form links should be launched on.
LabelDisplay only, label associated with selected Homepage
Add GT HomepageShortcut to add GT Homepage. Tile will be deployed to the homepage(s) selected
Add HomepageAdd additional rows to the grid

Sections When Deploying to WorkCenter

This section will show only when WorkCenter is selected.

WorkCenter Pagelets

Screenshot WorkCenter Pagelets

FieldValue/Use
Current StateWill indicate Deployed or not
Action to TakeDisplays available options which may include Deploy, Update, and Remove
Pagelet LabelEnter a label to be displayed on the Homepage
Manage Pagelet SequenceWhen clicked, opens the Manage Pagelet Sequence window.

Manage Pagelet Sequence

Screenshot Pagelet Sequence

FieldValue/Use
Pagelet NameFull name of the pagelet, Read-only
Portal LabelDescription of the pagelet, Read-only
Sequence NumberSequence number determines display order
Save Sequence NumbersApplies changes
ReturnCloses the modal window

This section displays for both Homepage and Workcenter deployments.

Screenshot Deploy/Save Icon

FieldValue/Use
Deploy/Save ChangesSave/Apply changes
Show Content Reference NamesToggles 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.

Screenshot example of the sections of the Deployment Tool when “Show Content Reference Names” toggled on.

Screenshot Tile section

Screenshot Workcenter Pagelet section

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.

  1. Deployment Tool page
    1. Navigation: Manage GT eForms 3.x > Deployment Tool
    2. If nothing is deployed, everything is marked to be deployed
  2. Form Family Table
    1. Navigation: Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Form Family Table
    2. If nothing is deployed, everything is marked to be deployed
  3. Search Set Page
    1. Navigation: Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Search Sets
    2. If nothing is deployed, everything is marked to be deployed
  4. Form Type Level
    1. Navigation: Manage GT eForms 3.x > Form Setup > General tab
    2. If the form belongs to only one form family/search set, the family will default. If more than one, lookup will be used.
    3. Any form type add links that are not deployed will be marked to be deployed
  5. Form Task Level
    1. Navigation: Manage GT eForms 3.x > Form Setup > Pages tab
    2. Form Type, Condition, and Task will default
    3. 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

[Family.DESCRSHORT] or [SearchSet.SEARCHSET]

Tile and Pagelet

[Family.DESCRSHORT] or [SearchSet.SEARCHSET] eForms

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:

  1. First set the existing Navigation Collection Links to Remove and Save
  2. Navigate to the Form Setup page and change the form style
  3. 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:

  1. In the old Form Family, first set the Form Type Navigation Collection Links to Remove and Save
  2. Navigate to the Form Setup page and change the Form Family
  3. 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.