ProcessMaker API Documentation
Script Central

Page Navigation Control Settings

Add a Page Navigation control from which the Request participant can go to another page in a multi-page ProcessMaker Screen.

Control Description

The Page Navigation control adds a button from which the Request participant can go to another page in a multi-page ProcessMaker Screen.

This control is only available for Display-type ProcessMaker Screens. See Screen Types.

Add the Control to a ProcessMaker Screen

Your ProcessMaker user account or group membership must have the following permissions to add a control to a ProcessMaker Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the ProcessMaker Screens permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to add this control to the ProcessMaker Screen:

  1. Create a new ProcessMaker Screen or click the Edit iconto edit the selected Screen. The ProcessMaker Screen is in Design mode.

  2. View the ProcessMaker Screen page to which to add the control.

  3. Locate the Page Navigation iconin the panel to the left of the Screen Builder canvas.

  4. Drag the Page Navigation icon into the Screen Builder canvas. Existing controls on the Screens Builder canvas adjust positioning based on where you drag the control.

  5. Place into the Screen Builder canvas where you want the control to display on the ProcessMaker Screen.

  6. Configure the Page Navigation control. See Settings.

  7. Validate that the control is configured correctly. See Validate Your Screen.

Below is a Page Navigation control in Preview mode.

Page Navigation control in Preview mode using the "Secondary" Variant option

Move the Control on the Page

Your ProcessMaker user account or group membership must have the following permissions to move a control in a ProcessMaker Screen page unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the ProcessMaker Screens permissions or ask your ProcessMaker Administrator for assistance.

After adding a control to a ProcessMaker Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another ProcessMaker Screen page.

Follow these steps to move a control to another location on that ProcessMaker Screen page:

  1. Place your cursor anywhere on the control not displaying the Duplicate Controlor Delete Controlbuttons.

  2. Hold your cursor, then drag the control above or below other controls on that ProcessMaker Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, theicon displays in the preview.

  3. Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

Copy the Control with its Settings

Your ProcessMaker user account or group membership must have the following permissions to copy a control in a ProcessMaker Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the ProcessMaker Screens permissions or ask your ProcessMaker Administrator for assistance.

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that ProcessMaker Screen page.

Follow these steps to copy a control:

  1. Select the control to be copied.

  2. Click the Duplicate Control button. The control copies with its current settings, and then displays below other controls placed on that page.

Delete the Control from a ProcessMaker Screen

Your ProcessMaker user account or group membership must have the following permissions to delete a control from a ProcessMaker Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the ProcessMaker Screens permissions or ask your ProcessMaker Administrator for assistance.

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.

Follow these steps to delete a control from a ProcessMaker Screen page:

  1. Select the control to be deleted.

  2. Click the Delete button. The control deletes. Other controls on that ProcessMaker Screen page adjust their locations automatically.

Settings

Permissions Required

Your user account or group membership must have the following permissions to edit a ProcessMaker Screen control:

  • Screens: Edit Screens

  • Screens: View Screens

See the ProcessMaker Screens permissions or ask your ProcessMaker Administrator for assistance.

The Page Navigation control has the following panels that contain settings:

Variable Panel Settings

Click the control while in Design mode, and then click the Variable panel that is on the right-side of the Screen Builder canvas.

Below is the setting for the Page Navigation control in the Variable panel:

Button Label

Enter the text label that displays for this control. Page Navigation is the default value.

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.

Below is the setting for the Page Navigation control in the Configuration panel:

Destination Screen

Select the destination page to which to navigate in a multi-page ProcessMaker Screen.

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas.

Below is the setting for the Page Navigation control in the Design panel:

Button Variant Style

Select the style for the Page Navigation control. The style changes the control's appearance but otherwise has no functional difference. Select from the following options:

  • Primary: Blue-colored background with white-colored Button Label text. This is the default option.

  • Secondary: Gray-colored background with white-colored Button Label text.

  • Success: Green-colored background with white-colored Button Label text.

  • Danger: Red-colored background with white-colored Button Label text.

  • Warning: Yellow-colored background with black-colored Button Label text.

  • Info: Teal-colored background with white-colored Button Label text.

  • Light: White-colored background with black-colored Button Label text.

  • Dark: Black-colored background with white-colored Button Label text.

  • Link: White-colored background with blue-colored Button Label text.

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Page Navigation control in the Advanced panel:

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components for "Visibility Rule" Control Settings. If this setting does not have an expression, then this control displays by default.

To make this control hidden until another control contains a value, enter the Variable Name setting value of that control to this control's Visibility Rule setting.

CSS Selector Name

Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.

Related Topics