Create Forms Links
- Last UpdatedOct 10, 2024
- 5 minute read
Create a form link to add a form to the menu, and to set a form as the home page.
To create a form link and add the form to the menu
-
In the Enterprise Console, click
menu icon, and then click Forms. The Forms page appears.
-
Click the <User> icon, and then click Repository Settings. The Repository Settings page appears.
-
Click the Advanced settings tab, and then click Manage Navigation List. The Navigation List page appears.
-
Click New, and then click Form Link. The New Form Link dialog box appears.
-
In the Title box, type a name for the form link, and in the Description box, type a description for the form link.
-
In the Select a Form list, select a form.
-
If there are parameters for the form, then the parameters appear. In such cases, type values for the parameters, if required.
-
In the Image Name box, type the name of an image for the form link.
-
Under Window Mode, do one of the following:
Task
Action
-
Make the form appear over the window.
-
Click Pop-up.
-
Make the form appear in the window.
-
Click Inline.
-
-
Under Show in Navigation List, select as follows:
Task
Action
-
Show form link in the navigation menu of the Enterprise Console.
-
Select Web.
-
Show form link in the navigation menu of the AVEVA Work Tasks Pro app.
-
Select Mobile.
Note:
- The Show in Navigation List property is applicable only when the Window Mode property is set to Inline.
- By default, the Show in Navigation List is set to Web.
- To improve usability of the navigation menu in the AVEVA Work Tasks Pro app, we recommend limiting the number of links. -
-
In the Menu Order box, type a number to position the link in the Enterprise Console menu.
Note:
- By default, the Menu Order number will be one more than the highest Menu Order number entered for the links in the Navigation List.
- You can enter either a positive or a negative integer. Negative Menu Order numbers take precedence over positive Menu Order numbers.
- If you clear the Menu Order number, then the system will set the Menu Order to 0.
- The link with the lowest Menu Order number appears first in the menu followed by other links in the ascending order of their Menu Order number.
- In case of links with the same Menu Order number, the last saved link takes precedence and appears before the other links with the same Menu Order number.
- When you upgrade the product, the Menu Order number for the user created links will be set to null.
- You must log out and log on to the Enterprise Console to see changes in the order of the menu items. -
Click Save. The form link is saved and an information message appears.
-
Click OK (or click the Close button). The information message and the New Form Link dialog box are closed.
To set a form link as the home page
-
In the Enterprise Console, click
menu icon, and then click Forms. The Forms page appears.
-
Click the <User> icon, and then click Repository Settings. The Repository Settings page appears.
-
Click the Advanced settings tab, and then click Manage Security Groups. The Security Group page appears.
-
Right-click on a security group, and then click Edit (or click on a security group, and then on the action bar, click Edit). The Modify a Security Group dialog box appears.
-
In the Default Home Page list, select a form link.
-
Click Save. The security group settings are saved, the Modify a Security Group dialog box is closed, and the Synchronization dialog box appears.
-
Under Do you want to Synchronize it?, click Yes, and then click Submit. The synchronization settings are saved and an information message appears.
-
Click OK (or click the Close button). The information message and the Synchronization dialog box are closed.
Note:
-
To set a form as home page:
-
You must create a form link.
-
The Window Mode for the form link must be set to Inline.
-
The Default Home page item will not be available in the Navigation menu. Login and logout of the Enterprise Console to view the newly created item in the Dashboard.
-
To set the Default Home page for Limited Access Security Group in the Work Tasks Pro App, disable the permission for Show Only Owned Item.
-
-
It is recommended not to use Form link with Window Mode as Inline, which uses a form associated to a synchronous workflow with an Invoke Form activity having Redirect URL and Custom Document View URL properties.
-
Enter the values for forms parameters as follows:
|
Forms Parameters |
Value |
|---|---|
|
Array |
Comma separated Example: 1,2,3,4 OR a,b,c,d |
|
Date |
mm/dd/yyyy 00:00:00 Example: 12/31/2099 00:00:00 |
|
Date-Time |
mm/dd/yyyy HH:mm:ss in UTC format Example: 12/31/2099 23:59:59 |
|
Object |
JSON string Example: {"firstname":"Allen","lastname":"Brewer","telephone":["123-456-7890","098-765-4321"]} |
-
The values for forms parameters are not validated when saving forms links. However, at run time, when the parameter values of type number, array, and object are converted, a messaged is logged if the conversion fails.
-
When you edit a forms link, you can refresh the parameters of the form by clicking on Reload Parameters.
-
Forms links created show the name of the forms link instead of the name of the form in the Enterprise Console menu.
-
When you upgrade the product, you can change the name shown on the menu from forms name to forms link name in one of the following ways:
-
Opening and saving the forms link.
-
Appending the forms links title in SKENavigationDetails in the database. For example, if the forms link name is Billing Address then append FormLink=Billing Address as follows:
-
InstanceForm.aspx?ListItemId=67f364af-96e4-4d9e-9295-2a70ba3d30d5&ItemType=2&WM=1&FormLink=Billing Address