Action Event Reference


Actions are visual workflows which require a sequence of events to execute. These events are determining the action's roadmap. The road of events an action has. Example events are condition (true or false), create, update, import, Http request, etc. 

Default action event options

Sample

When the action is created and saved, the action roadmap appears. This shows the road of events an action travels. If you click the plus, you can add a new event to your action. The action event screen opens with a few options. The options appearing are specified by the kind of event you want to add to the action. Below we describe all default event options that appear:

Kind
Allows you to choose an event to your action, such as loop, create or assign. All action events are explained below this reference article.
Success message
Allows you to create a message which will be shown to the user when the action has been successfully completed.
Error message
Allows you to create a message which will be shown to the user when the action has encountered an error.
Help text
Allows you to give the event a short help text for other developers, so they can read the help text and immediately knows what de action exactly does
Log message
Allows you to create a message which will be displayed in the logs whenever the action is executed.
Variables
The action can be used to create a totally new variable with the corresponding options. The screen which opens when you choose to add a new variable is quite self-explanatory.

All action events

Sample

Below we have described all action events you can complete your actions with. All options that appear for each event, besides the default options, are described:



Action

With this event, you can select a previous created action to execute.

Action
Select which action to execute.
Assign
Select which properties to assign.



Assign

With this event, you can assign values from property fields to other property fields. 

Use this event in combination with the before-callbacks. For all other value changes, use an update event.

Object
Select an object from the variable browser.
Assign
Select which properties to assign.



Auto increment generate

This event generates the following value of an auto increment property field, WITHOUT saving the object directly. It only assigns the next value to the property selected.

Object
Select the object that contains the auto increment property.
Property
Select which auto increment property must be assigned. Notice that ‘set automatically’ checkbox is deselected in the property options.



Auto increment set

This event generates the following value of an auto increment property field AND the object concerned is saved directly.

Object
Select the object that contains the auto increment property.
Property
Select which auto increment property must be assigned. Notice that ‘set automatically’ is not selected in the property options.



Condition

With this event, you can set an expression to be checked and return a true or false value. This is used as an IF then ELSE in the action list.

Use filter
Select which object to filter and start creating condition rows.
Use expression
Create an expression to set the condition. Use our reference for creating expressions.



Create

With this event, you can create ‘new’ data (records) by assigning properties and adding properties.

Model
Select a model to create new data (records) into.
Assign
Select which properties to assign.
As
Give the new data (record) a variable name.
Skip actions
Select the actions with 'After create' callbacks which you would like to skip upon execution on the current action.
Skip validations
Use this checkbox to skip validations which were set on properties, like presence and uniqueness.



Create betty user

With this event, you can create new application users, based upon an existing model.

Email
Select the email address of the input-model to copy to the user-model.
Name
Select the user’s name to make your invitation more personal.
Role
Give your new user the correct application roles. 
As
Give your new user a variable name.
No invitation mail
Use this checkbox to determine whether you would like to send an invitation mail or not.
User invite link as
(visible when 'no invitation mail' is selected) Create a variable which contains the user's invitation link. 



Delete

With this event, you can delete a property value which is deleted on execution.

Object
Select an object property from the variable browser.



Export

With this event, you can export data when executed (noticing that export defintions are defined in back office views).

View Reference
Select the view reference in which the export is created.
Collection
Select a collection to export. Is not required!
Export definition
Select one of the existing export definitions.
As
Give the export a variable name.



Group

With this event, you can group your data when executed.

Collection
Set which set of data (collection) you want to group.
Group by
Set what to group.
Collection as
Give the grouped data a name.
Key as
Set the name of the item you are grouping by.
Accept nil values
Use this checkbox to accept empty property fields as input.



Http request

With this event, you can manipulate data by using the Http request methods.

Webservice
Select your predefined web service that is created under ‘Tools’. There you define the host, authentication type, content type and response type of the request.
Webservice endpoint
Select the endpoint that contains the Http method and describes the path of the request.
As
Give your request a variable name.
Response code as
Put the response code in a variable.
Timeout seconds
If the time-out expires, the response will automatically get a status code 408: Request Timeout. 
Connection test
(visible after the event is saved) Test the request you have made. See what kind of response, response headers and response body you are getting back with the conneciton.



Import

With this event, you can import data when executed (noticing that import definition are defined in back office views).

Object
Select an object in which you want to import data.
Import definition
Select one of the existing import definitions. This will also determine on which model you want to import the data, since importdefinitions are based upon 1 datamodel.
File property
Select the file property to save your import file into. It's a best practice to create an separate datamodel for your imports, to save the files in.
Background
Use this checkbox to execute this event in the background. By default, this value is selected.



Login web user

With this event, you can login web users into the web module of your application. For the use of self-service portals for example.

Username
Select the username property of the person who would like to login.
Password
Select the password property of the person who would like to login.



Loop

With this event, you can create a loop through a collection of data.

Times
The number of times the loop event should activate.
Through
Select through which collection the loop should go.
As
Give each object in the looped collection a variable name.
Index
Set a name for the variable which returns the loop index number.



Pdf generate

With this event, you can generate a Pdf file by using a template and variables.

Object
Select the object in which you would like to generate the Pdf file.
Property
Select the property you would like to generate the Pdf file to. Notice, that the property type must be ‘PDF File’.
Regenerate
It allows you to regenerate the same Pdf file multiple times.



Pdf merge

With this event, you can merge multiple Pdf files into one single Pdf file. For instance, multiple Pdf files from one customer that you would like to merge into one Pdf File.

Collection
Select which set of records you would like to merge.
Property
Select the certain Pdf file property in which every single Pdf file is stored.
Description
Give the merged Pdf files a description.
Filename
Give the merged Pdf files a filename for downloading.
Store as download
Use this checkbox to store the merged Pdf files as a download in you application.
As
Give the merged Pdf files a variable name.



Redirect web page

With this event, you can redirect a web page. For example, a customer is logging in. After the customer is successfully logged in, you can redirect he or she to another web page.

Response code
Select the response code needed. You can choose between 301(permanent) and 302(temporary) response.
Redirect url
Insert the redirect url. Apply the complete url between quotes, like “/login”.



Render web template

With this event, you render web templates, at a specific time in your action.

Template
Select a predefined template or create a template after the event is saved via the template-subview.
Response code
Set the response code of the rendered template.



Send Slack message

With this event, you can send messages to the communication tool Slack.

Connect
(visible after the event is saved) Press the button ‘Connect to Slack’ and a new tab opens. Sign in to Slack and define the settings.



Send mail

With this event, you can send e-mails. For instance, a confirmation e-mail when a web user successfully logged in.

Template
Select a predefined e-mail template that is created under ‘Tools’ or select -New- and create after the event is save a new template.
Subject
Insert a mail subject or use a variable property via the link icon on the right.
To email
Insert a e-mail address, or use a variable, where the mail needs to be sent to
To name
Insert a name or use a variable.
From email
Insert a e-mail address, or use a variable, where the mails needs to be sent from.
The domain of this email address has be activated for Mandrill
From name
Insert a name or use a variable.
Cc
Insert a e-mail address or use a variable.
Bcc
Insert a e-mail address or use a variable.
Template variables
Define variables which you want to use in your email. For example, use a variable for the name you are addressing this e-mail to.
Attachments
Add attachments to your e-mail event. For example, the order that you have confirmed in this e-mail.
Storage property
Select a mail message-property in which you want to save the sent email.



Sftp download

With this event, you can download data from your Sftp server directories.

Host
The url/ip of the hosting server.
Port
The port of the server
Remote path
The path to the file on the server
As
The name of the variable in which the file will temporarily be saved
After download
What the server should do with the file after the download
Timeout seconds
How long the request will wait before returning a timeout.
Configuration
Add a configuration to the request. (certificate, auth)



Sftp upload

With this event, you can upload data to your Sftp server directories.

File
The property that contains the file
Filename
The name the file should get on the server
Directory
The directory in which the file should be placed
Host
The url/ip of the server
Port
The port needed to connect
Create missing dirs
Use this checkbox to create missing directories on the server.
Overwrite existing
Use this checkbox to overwrite any file in the same directory with the same name.
Timeout seconds
How long the server waits before returning a timeout
Configuration
Add a configuration to the request. (certificate, auth)



Sign document

With this event, you can place a digital signature to your Pdf file, using Signhost. It is possible for multiple signatories to sign and it is legally valid.

Object
Select the record which contains the Pdf file you would like to sign.
Property
Select the certain Pdf file property to sign.
Email address
Insert the email address(es) of the signee(s). 
Require sms verification
 Use this checkbox if sms verification is required.  
Mobile
(visible when require sms is selected) Select the mobile number you would like to send the sms verification to.
Require scribble
Use this checkbox if a scribble is required.
Return url
The url (page) which the signee is returned to after the document is signed. 
Url as
Create a variable containing the link to the website where the document would be signed.



Update

With this event, you can update existing properties (data) by assigning them.

Object
Select the object you want to update.
Assign
Select which properties to assign.
Skip validations
Use this checkbox to skip validations which were set to properties, like presence and uniqueness.



Zip

With this event, you can zip and unzip files from and to (multi) file properties.

Operation
Zip or Unzip
File property
The property to which you want to zip

Read this article about using the zip event



logout web user

With this event, you can log the current web user out of the web module. This event does not need any additional settings to be executed. 


Didn’t find what you want?Ask your question on the forum!