Evoke Click Actions


Click Actions are part of Evoke's internal Component Library. They are accessed from Header actions, Navigation Click Actions, Page level Actions and other places through Evoke Apps. Each Click Action is a powerful functional component that performs one or more actions on data, the UI or other parts of Evoke. The following is a summary of the Click Actions available within Evoke and examples of the use of each of these may be found in the Evoke Example App design.
Click Action name
Action Description
Action Details/Definition
Data Type

AddCurrentValue
Add current segment DataSource value to another multi-entity datasource target
Target DataSource Path - use the builder to select the multi entity (list) you want to copy the currently selected entity (record) to.
Single Entity to Multi Entity
AddDatasourceValue
Add a DataSource value to another multi-entity datasource target
Source Datasource Path - use the build button to select the entity (record) you want to copy somewhere
Target DataSource Path - use the builder to selected the multi entity (list) you want to copy it to.
Single Entity to Multi Entity
AddDatasourceValue-
ifNotPresent
Add a DataSource value to another multi-entity datasource target if it does not already exist within the target list
Source Datasource Path - use the build button to select the entity (record) you want to copy somewhere
Target DataSource Path - use the builder to selected the multi entity (list) you want to copy it to.
Single Entity to Multi Entity
AssignCurrentPropertyValue
Assign the value of a property (field) of the current entity to another datasource property
Source Datasource Property Path - use the build button to select the Property (field) of an entity (record) you want to copy somewhere
Target DataSource Property Path - use the builder to select the Property in an Entity (record) you want to copy it to.
Single property to property
AssignCurrentValue
Assign current segment dataSource value to another DataSource Target
Target Property Path - use the builder to select the DataSource and individual Property you want to copy the current instance (entity/record) of the current DataSource to.
Single Entity
AssignDataSourcePropertyValue
Assign a DataSource Property value to another DataSource Property target
Source Property Path - use the build button to select the entity (record) Property you want to copy somewhere
Target Property Path - use the builder to select the dataSource and individual Property you want to copy it to.
Single Entity
AssignDataSourceValue
Assign a DataSource value to another DataSource target
Source Datasource Path - use the build button to select the entity (record) you want to copy somewhere
Target DataSource Path - use the builder to select the multi entity (list) you want to copy it to.
Single Entity
AssignStaticPropertyValue
Set the value of a property of any DataSource property to a specified value
Value - The static value (as typed in) or picked from system options that is to be assigned (placed in) the property/field. target Property Path - use the build button to select the DataSource Property you wish to put the static value in.
Single Entity
CancelDataSourceChanges
Cancel amendments to a specified DataSource
DataSource location - use the build button to select the DataSource you wish to cancel all changes for. Note: Although this will cancel the changes to the DataSource it will notremove the tick/cross (save/cancel) in case there are other changes to other DataSources in the Page Series that you do not want to cancel.
Multi Entity
CancelPageSeriesChanges
Cancel all unsaved amendments for the entire page series and save these changes automatically (removing the tick/cross (save/cancel) ).
No Action Details/Definition
Multi Entity
CreateNewEntity
Creates a new entity instance within a given DataSource location
DataSource location - use the build button to select the DataSource you wish to create a new entity/record in.
Force save/cancel icons - check to force the display of the commit and discard (Tick/Cross) save options.
Create an empty list - create a new list.
Multi Entity
CustomCode
Raise event for custom JavaScript to hook into
Custom Code Location: Choose an option from a) Page Series - The Routine is held within the custom.generalLogic object of the parent Page Series and b) App - The Routine is held in the App.cusom object (in App.js).
Custom Code Routine Name - the name of the custom code routine to be executed.
Please see the Click Action Custom Code description help page.
No DataSource
Delay
delay the execution of subsequent Click Actions by a specified number of milliseconds
Delay Period (Milliseconds) - the number of milliseconds to delay - 1000 = 1 second.
No DataSource
DeleteCurrentValue
Delete the currently selected DataSource value (record) from the multi-entity datasource (file/table/object)
No Action Details/Definition.
No DataSource
DeleteDataSourceValue
Delete a dataSource value which is an Entity/Record from a datasource (Object/file or Table). This will delete the actual record and will remove any associations this record has with other entities i.e. link table entries or embedded MV.
DataSource ID - use the build button to select the DataSource you wish to remove the Entity/Record from, this will usually be the current entity and will be the current record e.g. "Products.Current".
Note: this will trigger the save/cancel options for the user to decide to save the change if desired.
Multi Entity Table/DataGrid
Hide PageSegment
Hides the specified page segment within the page (if it is shown)
Page Segment Widget ID - the name of the Segment Widget ID as specified by you in the General Tab (UI Design) on the Page Design.
No DataSource
MessageDisplayBox
Displays a pop-up message that disables the UI of the current page series until the MessageBoxRemove click action is used
Message Text - Enter the text of the message that you wish to be displayed on the screen in a pop up message box.
No DataSource
MessageDisplayBoxRemove
Removes the pop-up message displayed using the MessageBoxDisplay action
No Action Details/Definition
No DataSource
MoveDatasourceValue
Move a the current instance of a DataSource value (an Entity/Record) from a specified DataSource to another multi-entity datasource target. Moves the Entity leaving an empty entity where it was.
Source Datasource Path - use the build button to select the entity (record) you want to move somewhere
Target DataSource Path - use the builder to selected the multi entity (list) you want to move it to.
Single Entity to Multi Entity
MoveSpecificDatasourceValue
Move a specified DataSource value (an Entity/Record) from a specified DataSource to another multi-entity datasource target. Moves the Entity leaving an empty entity where it was.
Source Datasource Path - use the build button to select the entity (record) you want to move somewhere
Target DataSource Path - use the builder to selected the multi entity (list) you want to move it to.
Specific entity Instance Path - use the builder to selected the multi entity (list) and individual entity (record) you want to move somewhere.
Single Entity to Multi Entity
NavigateToChild
Navigate to a child page
Destination Page - select, from the drop down list, the child page to navigate to
No DataSource
NavigateToGrandParent
Navigate to the grand parent page
No Action Details/Definition.
No DataSource
NavigateToInput
Navigate to a standalone input child page (do not display tick and cross for saving)
Destination Page - select, from the drop down list, the child page to navigate to
No DataSource
NavigateToInputIfNo Changes
Navigate to a standalone input child page (do not display tick and cross for saving) only if no unsaved changes exist on the current DataSource
Destination Page - select, from the drop down list, the child page to navigate to
No DataSource
NavigateToParent
Navigate to the parent page
No Action Details/Definition.
No DataSource
NavigateToSibling
Navigate to a sibling page
Destination Page - select, from the drop down list, the sibling page to navigate to. A Sibling Page is a Page at the same logical level as the page Navigated from not a child page but a sideways move.
No DataSource
OpenURL
Open a URL in a browser window.
URL address - the full URL path to the web page you would like to open in a new browser tab.
No DataSource
ReadUsingKey
Read a single record/item using a specified primary key value
DataSource ID - use the build button to select the DataSource you wish to read from.
Key Value - the value of the primary key of the record you with to read.
List/MultiEntity
RefreshRefinedDatasource
Reloads the content of a refined datasource from its root reapplying sort and filter options
DataSource ID - use the build button to select the Refined DataSource you wish to refresh from the root datasource.
Refined MultiEntity
RemoveCurrentValue
Remove the current segment's currently selected row which is an Entity/Record (without deleting the actual record e.g. it only removes the association between one entity (record) and another (its parent entity) i.e. deleting a link table entry in SQL or an embedded MV entry in MultiValue)
Note: this will not trigger the save/cancel options - if you want to save or give the option to save to the DB after this action use the click action TriggerSaveCancel.
No Action Details/Definition.
List/Multi Entity
RemoveDatasourceValue
Remove the current segment's currently selected row which is an Entity/Record (without deleting the actual record e.g. it only removes the association between one entity (record) and another (as specified in the click action) i.e. deleting a link table entry in SQL or an embedded MV entry in MultiValue)
Note: this will trigger the save/cancel options for the user to decide to save the change if desired.
DataSource ID - use the build button to select the DataSource you wish to remove the Entity/Record from.
List/Multi Entity
RetrieveRelatedData
Retrieve data (entities, etc) related to the current entity/row or in Click Actions if immediately after a Selection then related to the datasource of that selection.
Entity Properties to Load - use the add button to select the related entities, related to the DataSource (i.e. current row/entity or entity using in latest selection) - multiple related entities may be selected seperated by a space.
OR
Explicit Entity (DataSource) path - If you want to retrieve related entities from an entity (Datasource) that is not the current row/entity or entity using in latest selection then use this action detail build button to select the entity you wish to load.
As in Entity
RunSelection
Run a Selection against a specified DataSource including any filter arguments
DataSource ID - use the build button to select the DataSource you wish to select from (the Datasource bound to the segment will be populated with data from the selection).
Select ID - use the drop down list to choose the Selection (from the ones you created in Entities and defined further in DataMappings) that you want to use.
Selection Arguments - the Filter arguments (parameters) for the selection - the contents of a datasource property are passed if { } are put around the property.
As defined
SaveDatasourceChanges
Save Amendments to a specified DataSource
DataSource ID - use the build button to select the DataSource you wish to save
List/Multi Entity
SaveDatasourceChanges
NavigateToParent
Save Amendments to a specified DataSource and then navigate to the parent page
DataSource ID - use the build button to select the DataSource you wish to save
List/Multi Entity
SavePageSeriesChanges
Save all outstanding amendments for the entire current page series
No Action Details/Definition
List/Multi Entity
SaveDatasourceChanges
NavigateToParent
Save all outstanding amendments for the entire current page series and then navigate to the parent page
No Action Details/Definition
List/Multi Entity
SetCurrentAsSelectedRow
Set the row associated with the grid row action as the selected row (current instance of the entity)
No Action Details/Definition.
List/Multi Entity
SetCurrentAsSelectedRow
WithActions
Set the row associated with the grid row action as the selected row (current instance of the entity) and triggers row click/tap actions. The Click Action SetCurrentAsSelectedRow, when associated with an Action ID, will NOT run any row tap/click actions in the list, this action however, will run any click actions that have been set up to run when a row is selected by clicking on it.
No Action Details/Definition.
List/Multi Entity
SetDataSourceFilter
Allows the filter setting for a refined DataSource to be set/cleared
DataSource ID - use the build button to select the Refined DataSource you wish to reset the filter clause on
New Filter Clause - the new filter clause that is to be applied to the specified DataSource.
No DataSource
ShowPageSegment
Shows the specified page segment within the page (if it has been previously hidden)
Page Segment Widget ID - the name of the Segment Widget ID as specified by you in the General Tab (UI Design) on the Page Design.
No DataSource
TriggerSaveCancel
Forces the appearence of page series save/cancel (tick/cross) buttons
No Action Details/Definition.
No DataSource
UI Disable
Disable/Block all user interface interaction for the current page series
No Action Details/Definition
No DataSource
UI Enable
Re-enable all user interface interaction for the current page series.
No Action Details/Definition. Note - The Click Action: savedatasourcechangesandnavigatetoparent also enables UI
No DataSource
ValidateDatasource
Validates all properties/data contained within a specified datasource, based on Entity settings i.e. is the property 'mandatory' and is the data the right type (Alpha, integer, etc), without attempting to save it.
DataSource ID - use the build button to select the DataSource you wish to validate.
Single Entity