Custom Confirmation Messages
Image Removed
Custom confirmation messages are useful for displaying extra information that may help the user make a decision to proceed or go back. Bespoke messages can be added to confirmation screens using dynamic text components to display information, such as, names or totals.
Panel |
---|
borderColor | grey |
---|
borderWidth | 2 |
---|
borderStyle | dashed |
---|
|
The below text is taken from 1.13 Confirmation Message Configuration.
Insert excerpt |
---|
1.13 Confirmation Message Configuration | 1.13 Confirmation Message Configuration | name | CreateConfirmScreen |
---|
nopanel | true |
---|
Configuring Custom Messages
On your confirmation screen, add dynamic text and static text components, as required, to create your message- Image Removed
- In this example, a number of static and dynamic text components have been used to create a message where the two company names can be dynamically mapped onto the screen
Open the Actionflow containing the Confirmation Insert excerpt |
---|
_action_phase | _action_phase | nopanel | true |
Within the Confirmation Insert excerpt |
---|
_action_phase | _action_phase | nopanel | true |
, map the attributes from the initiator screen onto the dynamic text components, e.g. company nameCreate counts by configuring lookups to additional data, then using countElements within an Output Attribute on a Insert excerpt |
---|
_action_calculate | _action_calculate | nopanel | true |
action- See below worked example for full details on how to do this
On your confirmation screen, additional buttons can be added and configured with an Action Method of Other and an Action Type of Confirmation on their What are Exclusion Groups?
Exclusion Groups are used to group Actionflows and limit their ability to run at the same time.
Where multiple Actionflows have the same exclusion group, only one Actionflow will be able to run at any one time. Attempting to run a second Actionflow, with the same exclusion group, will return a warning message and the Actionflow will not run. This applies whether the Actionflow is run manually or automatically using a schedule.
Image Added
Exclusion groups are evaluated before any Actionflows are started. When an Actionflow with an exclusion group is triggered, if no other Actionflow with the same exclusion group is already running then the Actionflow will continue. The action will be considered to be using this exclusion group from this point until the Actionflow has completed.
Setting Exclusion Groups
- Open an Actionflow and open its
Insert excerpt |
---|
| _property_tabssettings |
---|
| _property_tabssettings |
---|
name | action |
---|
nopanel | true |
---|
|
On the Actionflow for the action, e.g. delete, ensure a Confirmation Phase is added before the Processing Phase, and that the Confirmation Phase contains an Insert excerpt |
---|
_action_screen | _action_screen | nopanel | true |
action for the confirmation screenRight-click on the Insert excerpt |
---|
_action_screen | _action_screen | nopanel | true |
node and choose Insert excerpt |
---|
_mappings_configure | _mappings_configure | name | button |
---|
nopanel | true |
---|
- Create mappings for each confirmation button and click Confirm Mappings
- Hover over the
Insert excerpt |
---|
_action_screen | _action_screen | nopanel | true |
node to see the additional output connectionsImage RemovedUnder Basic Settings, populate the Exclusion Group field with any text to indicate the group- This field is case insensitive and can take any free text
- Repeat this with other Actionflows to add them to the same Exclusion Group
Image Added
Worked Example
Here's a worked example using the Company Data (available from the Learning Centre).
In this example, we are using:
- A Company Management screen containing a grid of the Companies data and a card container of their associated Employees - this screen was created using the Multi-Tile template
- A Company Merger Pop up screen containing:
- two manual drop down fields of the company name's of the companies to be merged
- two string fields showing the company ID's of the companies to be merged
- a button to initiate the Actionflow - this screen was created using the Tile no Buttons template
- A Company Merger Confirmation screen containing a multiple static and dynamic text components, and buttons - this screen was created using the Confirmation template
- A Company Order Form screen containing form fields for the Orders A Company Orders screen containing two grids of the Orders and OrderLines data - this screen was created using the Edit Form Multi-tile template
Tip |
---|
If you are completing this chapter as part of the Actionflow course and using a training instance, the data and screens have already been pre-loaded into the Actionflow Advanced Application. For this example, we'll be working on the Company Merger ConfirmationOrders screen. |
Prerequisites
For In this example, we'll add a custom confirmation message to a company merger Actionflow. If you have not completed 3.03 Bulk Update Action Configuration, expand the section below and follow the steps to create the company merger Actionflow.
Expand |
---|
Insert excerpt |
---|
3.03 Bulk Update Action Configuration | 3.03 Bulk Update Action Configuration | name | BulkUpdateExample |
---|
nopanel | true |
---|
Example 1: Custom Merger Message
In this example, a company acquisition screen requires a custom confirmation message to show the company names, and the quantities of employees and orders that will be affected by the merge.
Lookup Setup
Open the Company Merger Confirmation screen and familiarise yourself with the components availableOpen the Actionflow on the Run Acquisition button on the Company Merger Pop up screencreate an Actionflow to import the AdditionalCompanies_Processed data and add the Status of New to each company on that table before adding it to the Companies table. We'll add this Actionflow to an Exclusion Group with other Actionflows on the same screen so that other processes cannot be triggered while the import is taking place.
Image Added
Actionflow Setup
Hover over the - Open the Company Approval Review screen
- Create an Actionflow on the Import button to import the AdditionalCompanies_Processed data
- Name:
ImportCompanies
- If you have completed the Actionflow Intermediate Course, chapter Analysis Action Configuration, this Actionflow setup is similar
- Configure an input of On Click
- Add a phasephase before the Processing Phase action to the canvasSetup a
- Name:
Confirmation
- Select the CompanyMerger datasource as the Input
- Map into the Actionflow the four attributes from the screen:
- CompanyIDBeingAcquired
- CompanyIDDoingAcquiring
- CompanyNameBeingAcquired
- CompanyNameDoingAcquiring
Add Details
- Connect the action_calculateaction_calculate action node to the Calculate action
- On the Calculate action, add the following Output Attribute that will be used to process the lookup data
- Configure lookups to retrieve the Employees and Orders for the company that is being acquired
Expand |
---|
title | How to Configure the Employees Lookup |
---|
|
- update the Status of all imported companies:
- Name:
Status
- Type:
String
- Expression:
"New"
- On the Calculate action, add another Output Attribute that will be used to add a 20 second delay into the Actionflow, this will simulate a large data import and allow time to trigger the Actionflow twice:
- Name:
Delay
- Type:
Integer
- Expression:
sleep(20)
- This will add a delay into the Actionflow for demonstration purposes. See sleep
- Add a
calculate
calculate- action
and choose Add LookupGive the lookup a suitable name
Click onto the canvas, then enter a suitable name for - to the canvas
- On its Properties, in the Tables section, click the
action_view_action_viewtables | | _tables |
---|
name | icon |
---|
nopanel | true |
---|
|
and choose the Employees Primary TableSelect an Output Attribute of EmployeeID, then select Next
For the Incoming Mappings, choose CompanyIDBeingAcquired, then select Next
For the Outgoing Mappings, map across EmployeeID to the Calculate action, then select Confirm and create filter
For the filter, match the CompanyID in the data to the Incoming Mapping- icon
- Drag across the AdditionalCompanies_Processed table from the Repository to the Analysis action properties
Connect the Calculate action to the Analysis action and map across the Status attribute
Image RemovedImage Added |
Expand |
---|
title | How to Configure the Orders Lookup |
---|
|
This is configured in exactly the same way as the Employees lookup, with the following changes:
For the Table Attributes Setup
- On the Analysis Model, Actionflow Advanced Data, click on the table, AdditionalCompanies_Processed
- Double-click on the attribute, Status, and change the Expression to
_context.Status
- This is then referring to the attribute setup on the Calculate action
- See Analysis Action Configuration and Internal Variables for more information on the internal variable _context
- Save the Analysis Model
Combine Data & Display
- On the Actionflow, create a
Insert excerpt |
---|
| _action_view |
---|
| _action_view |
---|
nopanel | true |
---|
|
choose - action with the
Employees- Primary Table
Select an Output Attribute of Order_ID
For the Outgoing Mappings, map across Order_ID to the Calculate action
For the filter, match the Customer_ID in the data to the Incoming Mapping
Expand |
---|
|
Image Removed |
Count and Open Screen Setup
- Create two Output Attributes on the Calculate action that count the records being retrieved from the lookups
Expand |
---|
|
- Create an Output Attribute:
- Name: NumberEmployees
- Type: Integer
- Expression: countElements(emp)
- emp is the name of the lookup connector
- Create an Output Attribute:
- Name: NumberOrders
- Type: Integer
- Expression: countElements(ord)
|
Create an output connector from the Caqlcxulate action, then clikc on the canvas to create an , AdditionalCompanies_Processed, and connect the Analysis action to the View action- In the Properties for the View, in the Data Retrieval Options section, set the Data Range to Latest
- This will ensure that this data isn't continuously added if the Actionflow is run repeatedly
- For the Output Attributes section, click the
action
screen
action
screen
action for the Company Merger Confirmation screenHover over the Company Merger Confirmation - icon and drag across all attributes
- Save the properties
- Create a screenscreen action and click Confirm, then select anywhere on the canvas to connect to the Processing Phase
Expand |
---|
|
Image Removed |
Testing
- Return to the Company Merger Pop up screen
- Select two companies from the drop downs and click Run Acquisition
- The Company Merger Confirmation screen should appear with the details of the selected companies mapped to the screen
- Choose Cancel or Confirm
In this example, we'll configure a confirmation screen for a save company action that has two confirmation buttons - one button will just confirm the save and one button will confirm the save and create a new order for the company.
Lookup Setup
- Open the Actionflow on the Save button on the Company Form
- Rename the Processing Phase to Save Only Phase
- Add a new phase after, Name: Save and Add Phase
- Add a new phase before the Save Only phase, Name: Confirmation
- Image Removed
Confirmation Phase Setup
- On the Confirmation Phase, configure an input of On Click
- Create an to save the data to the Companies table
- In its Properties, in the Basic Settings section, set the Type to Insert and
action
screen
action
screen
action to open the Company Form Confirmation screenRight-click on the Insert excerpt |
---|
_action_screen | _action_screen | nopanel | true |
action and choose Insert excerpt |
---|
_mappings_configure | _mappings_configure | name | button |
---|
nopanel | true |
---|
- Create an additional mapping for the ConfirmAndAdd button
- Hover over the
- toggle on Auto Save Attributes
- Connect the View to the Save action and map across all attributes
Image Added
- Note: Map the attribute, Status from the View action (not the Calculate action) and map the attribute Name to CompanyName
Expand |
---|
|
Image Added |
Setting the Exclusion Group
- Open the Actionflow actionscreenactionscreen action to see the two output connections, then connect Confirm to the Save Only Phase, and ConfirmAndAdd to the Save And Add Phase
- Under Basic Settings, populate the Exclusion Group field with any text, e.g.
Import
- Image Added
Add the same Actionflow to the Import button the Company Management screen
- On the Save And Add Phase, configure an input of the CompanyForm datasource
- Map the CompanyID and CompanyName attributes into the Actionflow
- Set up a
Expand |
---|
|
Image Removed |
Save and Add Phase Setup
|
- On the ImportCompanies Actionflow, open the
|
actionsaveactionsave action to save data to the Companies table, ensuring Auto Save Attributes is toggled on- Map the CompanyID attribute to the Save action
- Create an
- using the toolbar option and
|
action_screenaction_screen action to open the Company Order Form screenOn the Mappings between the Save and Open Screen actions: - Map the CompanyName attribute from the input to the CompanyName attribute on the screen
Map the CompanyID attribute from the table (not the input) to the Customer_ID attribute on the screenThe CompanyID attribute is mapped from the table and not the input because for a new company an ID is not created until the record is saved to the table. If the CompanyID attribute was mapped from the input, it would be populated when saving an existing company but blank when creating a new company
Expand |
---|
|
Image Removed |
Testing
- Open the Company Management screen
- Select either Add or Edit to open the Company Form
- Enter/change details for a company and press Save
- The confirmation screen will open, choose Yes + Create Order
- This will save the company and open the Company Order Form populated with the company name and ID of the company just created/edited
- the Actionflow tab
- Open the Company Management screen and drag the Actionflow icon from the pinned tab onto the Import button
- Image Added
- This will create another instance of the same Actionflow
- Configure the Input of On Click
|
Testing
- Open the Company Approval Review and Company Management screens
- Ensure both screens are ed
- Click Import on one screen then press Import on the other screen
- A warning message should appear
Image Added
Image Modified