A page action is an action button that appears at the top of a page, such as an Add, Update or Delete button, or a link button to another location. A page can have more than one-page action.
Each page action has a number of properties that define its style and behavior. Each page action also has its own independent access control, so you can define policies on a page action level. For example, you may allow both employees and managers to see a particular page but show an Approve button only visible to managers.
Page actions will not be visible if the page's title is hidden. See Page titles for more information on showing or hiding a page title.
Page action properties
Page actions have the following properties:
| Property | Description |
|---|---|
| Title | A title for the action. This is used as the button label for that action. |
| Object | The object of the page action. This object must use keys that are available from the page. See page action access control. |
| Operation | The operation that will be used when the action is performed. This is required. Choose between LINK, PUT, POST, or DELETE. Use LINK to link to an existing in-app page or another URL. Use PUT, POST, or DELETE to call a REST API. |
| Page Id | The Id of the page to link to when using LINK and an in-app page. This is the first part of the page's hyperlink (see Pages). |
| Object Id |
The object Id to pass when the operation is LINK. This is the second part of the item's hyperlink (see Pages). The {INSTANCE_PK1_VALUE} to {INSTANCE_PK5_VALUE} tokens can be used here to pass the value from the object's primary keys. |
| Show in modal | When selected, the in-app page will be opened inside a modal window. |
| External URL | The URL to link to when using LINK and an external URL. |
| REST endpoint | The REST API end-point to call when using PUT, POST, or DELETE. |
| Icon | Optional icon to show in the page action |
| Weight | Choose between light or normal. In general, use light for less-used secondary actions (such as Delete) and use normally for primary actions regularly performed. |
| Color | Set the color of the block action. Typically:
The exact color of the buttons will vary according to your color theme. |
| Confirmation | An optional confirmation message to show when pressing the action. This is useful when the action is being performed and has significant consequences. Use this sparingly to avoid user frustration. |
Page action access control
Access control for pages actions follows similar principles to Block access control and Block action access control. The object on a page action, if specified, must specify keys that are available to its page – just as a block must. Please see object Ids for more information.
You can specify access policies on individual page actions. For example, you could define an Add and an Edit page action but only allow a subset of grantees to see the Edit button.
Create a page action
To create a page action:
- First, find the page on which you wish to create the page action. See Viewing a page.
- Then go to Page actions: Add
A page action will not be visible until it has at least one access policy.
Update a page action
To update a page action:
- First, find the page where you wish to edit the page action. See Updating a page.
- Then go to the Page actions section and select the page action you wish to edit
From here you can edit the page action's settings and manage its access policy grants.
Delete a page action
To delete a page action:
- First, find the page where you wish to delete the page action. See Updating a page.
- Then go to the Page actions section and select the page action you wish to delete
- Hit the Delete button