User Guide for Buttons and Navigation in the User Interface

This guide explains how to create and modify buttons in the user interface, as well as the steps needed to define actions when clicking those buttons to navigate between views.

Defining a Button

An administrator can define buttons within an entity and determine the buttons available to the end user by following these steps:

Defining a Button within an Entity

To define a button within an entity, follow these steps:

1. Navigate to the Entities page. There are two ways to do this:
   • Go to Administration > Applications > Units > Find the relevant unit > Entities tab > Find the relevant entity.
   • Go to Administration > Applications > Entities > Find the relevant entity.
2. Click on the desired entity.
3. Click on the Buttons tab within the desired entity.
4. Click on "Add New Button."
5. A dialog box will appear asking for the following information:
   • Button Name: A required text field that can be translated.
   • Button Icon: An optional field.
   • Button Description: An optional long text field that can be translated.
   • Action: A dropdown list with action options.
     • Custom Event: Displays all defined custom events in the entity.
     • UI Event: Contains navigation options after executing the button.
   • Scope: Contains two options:
     • Single Entry: Adds the button when viewing the details of a single entry and executes it on the scope of that entry.
     • Multiple Entries: Adds the button to multiple entries simultaneously and executes it on the scope of the entries.
6. Click on the save button.
7. The button settings will be saved.
8. Return to the Buttons tab.
9. Click on the Publish button.
10. A confirmation message will appear.
11. Click on the OK button.

Defining a Button that Triggers a Custom Event

To define a button within the entity that triggers a custom event, follow these steps:

1. Follow the steps for adding a new button.
2. Choose the action "Custom Event."
3. All custom events defined in the entity will be displayed.
4. Options for customizing navigation on a single entry will be displayed:
   • Navigate on success.
   • Navigate on failure.
5. When choosing the type of navigation, a dropdown list with the following options will be displayed:
   • Relationship.
   • Current view.
   • Custom link.

Custom Event with Navigation Customization - Selecting the Current View

Success Execution

To use the option to enable navigation on the successful execution of a custom event interaction within the current view:

• Select the navigation type "Current View."
• Choose the default navigation action from the available options:
  • Display Entries List: To display the list of entries in the current view.
  • Create Entry: To create a new entry in the current view.
  • Display Entry Details: To display the details of a specific entry in the current view.
  • Update Entry: To update a specific entry in the current view.

Failure Execution

To use the option to enable navigation on the failure of a custom event interaction within the current view:

• Select the navigation type "Current View."
• Choose the default navigation action from the available options:
  • Display Entries List: To display the list of entries in the current view.
  • Create Entry: To create a new entry in the current view.
  • Display Entry Details: To display the details of a specific entry in the current view.
  • Update Entry: To update a specific entry in the current view.

Custom Event with Navigation Customization - Selecting Relationship

Success Execution

To use the option to enable navigation on the successful execution of a custom event interaction within the current view:

• Select the navigation type "Relationship."
• The system will display all the views linked to the selected relationship, with the activated navigation options:
  • Display Entries List: To display the list of entries in the current view.
  • Create Entry: To create a new entry in the current view.
  • Display Entry Details: To display the details of a specific entry in the current view.
  • Update Entry: To update a specific entry in the current view.
• Choose one of these views.

Failure Execution

To use the option to enable navigation on the failure of a custom event interaction within the current view:

• Select the navigation type "Relationship."
• The system will display the defined inbound and outbound relationships in the entity. Choose the "relationship."
• The system will display all the views linked to the selected relationship, with the activated navigation options:
  • Display Entries List: To display the list of entries in the current view.
  • Create Entry: To create a new entry in the current view.
  • Display Entry Details: To display the details of a specific entry in the current view.
  • Update Entry: To update a specific entry in the current view.
• Choose one of these views.

Custom Event with Navigation Customization - Selecting Custom Link

Success Execution

1. Choose the navigation type "Custom Link."
2. Enter the desired link.

Failure Execution

1. Choose the navigation type "Custom Link."
2. Enter the desired link.

Defining a Button that Triggers a UI Event (Navigation)

To define a button within the entity that triggers a UI event, follow these steps:

1. Follow the steps for adding a new button.
2. Choose the action "Navigation," which is a UI event.
3. When choosing the type of navigation, a dropdown list with the following options will be displayed:
   • Relationship.
   • Current view.
   • Custom link.

Navigation within the Current View

3. Choose the navigation type "Current View."
4. Choose the navigation action from the following options:
   • Display Entries: To display the list of entries in the current view.
   • Create Entry: To create a new entry in the current view.
   • Display Entry Details: To display the details of a specific entry in the current view.
   • Update Entry: To update a specific entry in the current view.

Navigation within a Linked View (Relationship)

1. Choose the navigation type "Relationship."
2. The defined inbound and outbound relationships in the entity will be displayed. Choose the "relationship."
3. After selecting the relationship, choose the navigation action from the following options:
   • Display Entries: To display the list of entries in the related view.
   • Create Entry: To create a new entry in the related view.
   • Display Entry Details: To display the details of a specific entry in the related view.
   • Update Entry: To update a specific entry in the related view.

Navigation to Custom Link

1. Choose the navigation type "Custom Link."
2. Enter the desired link.

Steps to Execute a Button that Triggers a UI Event

Executing a Button within the Current View:

Configure the Button from the View

1. Navigate to the "View" tab.
2. Create a new view or edit an existing view.
3. From the "Activate Buttons" section, activate the desired button.

Execute the Button by the End User

1. Log in to the platform as an end user.
2. Navigate to the view you have access to, which has the activated button.
3. Click the button from the list of entries or from the entry details page.
4. The system will navigate to the specified page according to the selected option, based on view permissions.

Scenarios:

Page	Navigation Action
Entry creation page in the related view	Create Entry
Entry details page in the related view	Display Entry Details
Entry update page in the related view	Update Entry
List of entries in the related view	Display Entries

Executing a Button for Navigation to a Specific Location in the View Based on Relationship:

Configure the Button from the View

1. Navigate to the "View" tab.
2. Create a new view or edit an existing view.
3. From the "Activate Buttons" section, activate the desired button. All available views in the related entity will be displayed.
4. Choose the desired view.

Execute the Button by the End User

1. Log in to the platform as an end user.
2. Navigate to the view you have access to, which has the activated button.
3. Click the button from the list of entries or from the entry details page.
4. The system will navigate to the specified page according to the selected option, based on the permissions of the chosen view.

Scenarios:

Page	Navigation Action
Entry creation page in the related view	Create Entry
Entry details page in the related view	Display Entry Details
Entry update page in the related view	Update Entry
List of entries in the related view	Display Entries

Executing a Button for Navigation to a Custom Link:

Configure the Button from the View

1. Navigate to the "View" tab.
2. Create a new view or edit an existing view.
3. From the "Activate Buttons" section, activate the desired button. All available views in the related entity will be displayed.
4. Choose the desired view.

Execute the Button by the End User

1. Log in to the platform as an end user.
2. Navigate to the view you have access to, which has the activated button.
3. Click the button from the list of entries or from the entry details page.
4. The system will navigate to the specified custom link entered in the button settings.

Executing a Button with

a Custom Event Linked to an Interaction:

Executing a Button that Triggers a Custom Event - Navigation Type "Current View":

1. Log in to the platform as an end user.

2. Navigate to the view you have access to.

3. Click the button that contains the linked interaction.

4. Upon successful or failed execution of the interaction, the system will navigate to the current view based on the selected option.

   Scenarios:

Default Navigation Action	Page
Create Entry	Entry creation page in the related view
Display Entry Details	Entry details page in the related view
Update Entry	Entry update page in the related view
Display Entries	List of entries in the related view

Executing a Button that Triggers a Custom Event - Navigation Type "Relationship":

1. Log in to the platform as an end user.

2. Navigate to the view you have access to.

3. Click the button that contains the linked interaction.

4. Upon successful or failed execution of the interaction, the system will navigate to the related view based on the selected option.

   Scenarios:

Default Navigation Action	Page
Create Entry	Entry creation page in the related view
Display Entry Details	Entry details page in the related view
Update Entry	Entry update page in the related view
Display Entries	List of entries in the related view

Executing a Button that Triggers a Custom Event - Navigation Type "Custom Link":

1. Log in to the platform as an end user.
2. Navigate to the view you have access to.
3. Click the button that contains the linked interaction.
4. Upon successful or failed execution of the interaction, the system will navigate to the specified custom link entered in the button settings.