Skip to main content

Reference

 

OutSystems

System Actions

Summary

Server Actions
AbortTransaction Issues a database ROLLBACK command that undoes all changes performed on the database since the last commit.
ActivityClose Explicitly closes a Human Activity or a Wait Activity ending the execution.
The the id of the next Human Activity in sequence is returned, if determined.
ActivityGetUrl Returns the URL of the web screen where an activity will be carried out, once opened.
ActivityOpen Explicitly forces a Human Activity instance to be opened in an end-user's Taskbox.
ActivityReset Releases the Human Activity leaving it to be opened and carried out by another end-user.
ActivitySchedule Schedules a date for the Human Activity to be available in the Taskbox.
ActivitySetGroup Limit a Human Activity visibility and handling to end-users who belong to a specific group.
ActivitySkip Explicitly skips the execution of a Human Activity or a Wait Activity.
The the id of the next Human Activity in sequence is returned, if determined.
ActivityStart Explicitly starts the execution of a ConditionalStart Activity.
ClientCertificateGetDetails Gets the relevant information for the current request client certificate from the .NET framework.
ClientCertificateValue Gets the value of a specific property of the client certificate in the .NET framework.
CommitTransaction Issues a database COMMIT command that makes effective all changes done on the database since the last commit.
EspaceInvalidateCache Invalidates eSpace’s specific caches across all Front-end servers and consumer eSpaces. Limit the invalidation to a single tenant by setting the tenant identifier.
GenerateGuid Generates and returns a new GUID.
InboundSmsGetDetails Returns information about the inbound SMS that is currently being processed.
IntegratedSecurityCheckRole Verifies whether the current Windows user has access to a specific role.
IntegratedSecurityGetDetails Gets information about the current Windows user that made the request.
ListAll Determines if all the elements in the list satisfy the given condition.
ListAny Determines if any of the elements in the list satisfies the given condition.
ListAppend Adds an element to the end of a list.
ListAppendAll Adds the elements of the source list to the end of the destination list.
ListClear Removes all elements from a list.
ListDuplicate Duplicates the elements of a list into another list.
ListFilter Produces a new list with the elements of the source list that satisfy the given condition.
ListIndexOf Returns the position of the first element that satisfies the given condition, or -1 if no element was found.
ListInsert Inserts an element in a specific position of a list.
ListRemove Removes an element from a specific position of a list.
ListSort Sorts the elements in the list by the given criteria.
Login Logs a specified user in the application.
In case of success, 'UserId' and 'Username' session variables are filled with the user data.
LoginPassword Logs a specified user in the application using a password.
In case of success, 'UserId' and 'Username' session variables are filled with the user data.
LogMessage Registers information that can be presented in Service Center in the module general log.
Logout Logs out a specific user from the application.
The 'UserId' and 'Username' session variables are cleared.
Notify The way a web block has to notify a screen or web block using it. They handle the notification through the action set in their On Notify property. To retrieve a message sent with the notification, use the NotifyGetMessage function.
NotifyGetMessage Returns the notification message sent by the Notify action.
NotifyWidget_Deprecated The way a web block has to notify a screen or web block using it. They handle the notification through the action set in their On Notify property. To retrieve a message sent with the notification, use the NotifyGetMessage function.
ProcessTerminate Explicitly forces a Process to terminate its execution.
SetCurrentLocale Sets the language locale of the user session to change the application presentation language.
TenantCreate Creates a new tenant and associates it with the provisioning site.
TenantInvalidateCache Invalidates tenant’s specific caches across all Front-end servers and eSpaces. This action is now available for compatibility purposes only. Please use the EspaceInvalidateCache action instead and invalidate tenant’s specific caches by eSpace to narrow the invalidation scope
TenantSwitch Change the context to the given tenant identifier. When switching tenant, the session is cleared (equivalent to an implicit logout, before changing the tenant), the OnSessionStart actions are executed, and the current transaction is commited.
Client Actions
ListAll Determines if all the elements in the list satisfy the given condition.
ListAny Determines if any of the elements in the list satisfies the given condition.
ListAppend Adds an element to the end of a list.
ListAppendAll Adds the elements of the source list to the end of the destination list.
ListClear Removes all elements from a list.
ListDuplicate Duplicates the elements of a list into another list.
ListFilter Produces a new list with the elements of the source list that satisfy the given condition.
ListIndexOf Returns the position of the first element that satisfies the given condition, or -1 if no element was found.
ListInsert Inserts an element in a specific position of a list.
ListRemove Removes an element from a specific position of a list.
ListSort Sorts the elements in the list by the given criteria.
LogMessage Registers information that can be presented in Service Center in the module general log.
RequireScript Add a Javascript to the html header. Multiple calls for the same Javascript will only add it once. Action flow will proceed after the Javascript has been successfully loaded.
ScreenReachedFromHistory Determines if the current screen has been reached from the history (e.g. using "Back" navigation).

Server Actions

AbortTransaction

Issues a database ROLLBACK command that undoes all changes performed on the database since the last commit.

ActivityClose

Explicitly closes a Human Activity or a Wait Activity ending the execution.
The the id of the next Human Activity in sequence is returned, if determined.

Inputs

ActivityId
Type: mandatory, Activity Identifier.

Outputs

NextHumanActivityId
Type: Activity Identifier.

ActivityGetUrl

Returns the URL of the web screen where an activity will be carried out, once opened.

Inputs

ActivityId
Type: mandatory, Activity Identifier.

Outputs

HandlingUrl
Type: Text.

ActivityOpen

Explicitly forces a Human Activity instance to be opened in an end-user's Taskbox.

Inputs

ActivityId
Type: mandatory, Activity Identifier.

Outputs

HandlingUrl
Type: Text.

ActivityReset

Releases the Human Activity leaving it to be opened and carried out by another end-user.

Inputs

ActivityId
Type: mandatory, Activity Identifier.
ResetActivityUser
Type: mandatory, Boolean.

ActivitySchedule

Schedules a date for the Human Activity to be available in the Taskbox.

Inputs

ActivityId
Type: mandatory, Activity Identifier.
StartDate
Type: mandatory, Date Time.

ActivitySetGroup

Limit a Human Activity visibility and handling to end-users who belong to a specific group.

Inputs

ActivityId
Type: mandatory, Activity Identifier.
GroupId
Type: mandatory, Group Identifier.

ActivitySkip

Explicitly skips the execution of a Human Activity or a Wait Activity.
The the id of the next Human Activity in sequence is returned, if determined.

Inputs

ActivityId
Type: mandatory, Activity Identifier.

Outputs

NextHumanActivityId
Type: Activity Identifier.

ActivityStart

Explicitly starts the execution of a ConditionalStart Activity.

Inputs

ActivityId
Type: mandatory, Activity Identifier.

Outputs

NextHumanActivityId
Type: Activity Identifier.

ClientCertificateGetDetails

Gets the relevant information for the current request client certificate from the .NET framework.

Outputs

cookie
Type: Text.
Gets the unique Id for the client certificate, if provided.
flags
Type: Integer.
A set of flags that provide additional client certificate information. Bit0 is set to 1 if the client certificate is present. Bit1 is set to 1 if the Certificate Authority (CA) of the client certificate is not in the list of recognized CAs on the server.
isPresent
Type: Boolean.
Gets a value that indicates whether the client certificate is present.
issuer
Type: Text.
A string that contains a list of subfield values containing information about the certificate issuer.
isValid
Type: Boolean.
Gets a value that indicates whether the client certificate is valid.
serialNumber
Type: Text.
Provides the certificate serial number as an ASCII representation of hexadecimal bytes separated by hyphens. For example, 04-67-F3-02.
serverIssuer
Type: Text.
Gets the issuer field of the server certificate.
serverSubject
Type: Text.
Gets the subject field of the server certificate.
subject
Type: Text.
Gets the subject field of the client certificate.
validFrom
Type: Date Time.
Gets the date when the certificate becomes valid. The date varies with international settings.
validUntil
Type: Date Time.
Gets the certificate expiration date

ClientCertificateValue

Gets the value of a specific property of the client certificate in the .NET framework.

Inputs

key
Type: mandatory, Text.

Outputs

value
Type: Text.

CommitTransaction

Issues a database COMMIT command that makes effective all changes done on the database since the last commit.

EspaceInvalidateCache

Invalidates eSpace’s specific caches across all Front-end servers and consumer eSpaces. Limit the invalidation to a single tenant by setting the tenant identifier.

Inputs

EspaceId
Type: optional, Espace Identifier.
Identifier of the eSpace to invalidate. If not specificed, the identifier of caller eSpace is used.
TenantId
Type: optional, Tenant Identifier.
Optional tenant identifier to limit the cache invalidation to a specific tenant.

GenerateGuid

Generates and returns a new GUID.

Outputs

Guid
Type: Text.

InboundSmsGetDetails

Returns information about the inbound SMS that is currently being processed.

Outputs

MSISDN
Type: Phone Number.
LargeAccount
Type: Phone Number.
Message
Type: Text.
BinaryMessage
Type: Text.
UDH
Type: Text.
MessageId
Type: Text.
Priority
Type: Integer.
Encoding
Type: Text.
Connection
Type: Text.
OperatorCode
Type: Text.
Sent
Type: Date Time.
Custom1
Type: Text.
Custom2
Type: Text.
Custom3
Type: Text.

IntegratedSecurityCheckRole

Verifies whether the current Windows user has access to a specific role.

Inputs

RoleName
Type: mandatory, Text.

Outputs

Belongs
Type: Boolean.

IntegratedSecurityGetDetails

Gets information about the current Windows user that made the request.

Outputs

Username
Type: Text.
isGuest
Type: Boolean.
isSystem
Type: Boolean.
isAnonymous
Type: Boolean.
isAuthenticated
Type: Boolean.

ListAll

Determines if all the elements in the list satisfy the given condition.

Inputs

List
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

Result
Type: Boolean.

ListAny

Determines if any of the elements in the list satisfies the given condition.

Inputs

List
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

Result
Type: Boolean.

ListAppend

Adds an element to the end of a list.

Inputs

List
Type: mandatory, Generic Record List.
The list to add the element to.
Element
Type: mandatory, Generic Record.
The element to be added to the end of the list.

ListAppendAll

Adds the elements of the source list to the end of the destination list.

Inputs

List
Type: mandatory, Generic Record List.
The destination List.
SourceList
Type: mandatory, Generic Record List.
The list whose elements will be added.

ListClear

Removes all elements from a list.

Inputs

List
Type: mandatory, Generic Record List.
The list to remove the elements from.

ListDuplicate

Duplicates the elements of a list into another list.

Inputs

SourceList
Type: mandatory, Generic Record List.
The list to duplicate.

Outputs

List
Type: Generic Record List.
The duplicate list.

ListFilter

Produces a new list with the elements of the source list that satisfy the given condition.

Inputs

SourceList
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

List
Type: Generic Record List.
The filtered list.

ListIndexOf

Returns the position of the first element that satisfies the given condition, or -1 if no element was found.

Inputs

List
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

Position
Type: Integer.

ListInsert

Inserts an element in a specific position of a list.

Inputs

List
Type: mandatory, Generic Record List.
The list to add the element to.
Element
Type: mandatory, Generic Record.
The element to insert in the list.
Position
Type: mandatory, Integer.
The position where the element is inserted.

ListRemove

Removes an element from a specific position of a list.

Inputs

List
Type: mandatory, Generic Record List.
The list that the element is removed from.
Position
Type: mandatory, Integer.
Position of the element to be removed.

ListSort

Sorts the elements in the list by the given criteria.

Inputs

List
Type: mandatory, Generic Record List.
The list to sort
By
Type: mandatory, Generic Type (2).
The criteria by which to order the list
Ascending
Type: optional, Boolean.
Defines if the list is sorted in ascending (True) or descending (False) order. Default is ascending order.

Login

Logs a specified user in the application.
In case of success, 'UserId' and 'Username' session variables are filled with the user data.

Inputs

UserId
Type: mandatory, User Identifier.
Persistent
Type: mandatory, Boolean.
If true, the login will be persistent for 15 days

LoginPassword

Logs a specified user in the application using a password.
In case of success, 'UserId' and 'Username' session variables are filled with the user data.

Inputs

UserId
Type: mandatory, User Identifier.
Password
Type: mandatory, Text.
Persistent
Type: mandatory, Boolean.
If true, the login will be persistent for 15 days

LogMessage

Registers information that can be presented in Service Center in the module general log.

Inputs

Message
Type: mandatory, Text.
The message to add to the module general log.
ModuleName
Type: mandatory, Text.
The name of the module to be associated with the log message.

Logout

Logs out a specific user from the application.
The 'UserId' and 'Username' session variables are cleared.

Notify

The way a web block has to notify a screen or web block using it. They handle the notification through the action set in their On Notify property. To retrieve a message sent with the notification, use the NotifyGetMessage function.

Inputs

Message
Type: optional, Text.

NotifyGetMessage

Returns the notification message sent by the Notify action.

Outputs

Message
Type: Text.

NotifyWidget_Deprecated

The way a web block has to notify a screen or web block using it. They handle the notification through the action set in their On Notify property. To retrieve a message sent with the notification, use the NotifyGetMessage function.

Inputs

Message
Type: optional, Text.

ProcessTerminate

Explicitly forces a Process to terminate its execution.

Inputs

ProcessId
Type: mandatory, Process Identifier.

SetCurrentLocale

Sets the language locale of the user session to change the application presentation language.

Inputs

Locale
Type: mandatory, Text.

TenantCreate

Creates a new tenant and associates it with the provisioning site.

Inputs

eSpaceName
Type: mandatory, Text.
TenantName
Type: mandatory, Text.

Outputs

TenantId
Type: Tenant Identifier.

TenantInvalidateCache

Invalidates tenant’s specific caches across all Front-end servers and eSpaces. This action is now available for compatibility purposes only. Please use the EspaceInvalidateCache action instead and invalidate tenant’s specific caches by eSpace to narrow the invalidation scope

Inputs

TenantId
Type: mandatory, Tenant Identifier.
Identifier of the tenant which will have all of its specific caches invalidated.

TenantSwitch

Change the context to the given tenant identifier. When switching tenant, the session is cleared (equivalent to an implicit logout, before changing the tenant), the OnSessionStart actions are executed, and the current transaction is commited.

Inputs

TenantId
Type: mandatory, Tenant Identifier.

Client Actions

ListAll

Determines if all the elements in the list satisfy the given condition.

Inputs

List
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

Result
Type: Boolean.

ListAny

Determines if any of the elements in the list satisfies the given condition.

Inputs

List
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

Result
Type: Boolean.

ListAppend

Adds an element to the end of a list.

Inputs

List
Type: mandatory, Generic Record List.
The list to add the element to.
Element
Type: mandatory, Generic Record.
The element to be added to the end of the list.

ListAppendAll

Adds the elements of the source list to the end of the destination list.

Inputs

List
Type: mandatory, Generic Record List.
The list to add the element to.
SourceList
Type: mandatory, Generic Record List.
The list whose elements will be added.

ListClear

Removes all elements from a list.

Inputs

List
Type: mandatory, Generic Record List.
The list to remove the elements from.

ListDuplicate

Duplicates the elements of a list into another list.

Inputs

SourceList
Type: mandatory, Generic Record List.
The list to duplicate.

Outputs

List
Type: Generic Record List.
The duplicate list.

ListFilter

Produces a new list with the elements of the source list that satisfy the given condition.

Inputs

SourceList
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

List
Type: Generic Record List.
The filtered list.

ListIndexOf

Returns the position of the first element that satisfies the given condition, or -1 if no element was found.

Inputs

List
Type: mandatory, Generic Record List.
Condition
Type: mandatory, Boolean.

Outputs

Position
Type: Integer.

ListInsert

Inserts an element in a specific position of a list.

Inputs

List
Type: mandatory, Generic Record List.
The list to add the element to.
Element
Type: mandatory, Generic Record.
The element to insert in the list.
Position
Type: mandatory, Integer.
The position where the element is inserted.

ListRemove

Removes an element from a specific position of a list.

Inputs

List
Type: mandatory, Generic Record List.
The list that the element is removed from.
Position
Type: mandatory, Integer.
Position of the element to be removed.

ListSort

Sorts the elements in the list by the given criteria.

Inputs

List
Type: mandatory, Generic Record List.
The list to sort
By
Type: mandatory, Generic Type (2).
The criteria by which to order the list
Ascending
Type: optional, Boolean.
Defines if the list is sorted in ascending (True) or descending (False) order. Default is ascending order.

LogMessage

Registers information that can be presented in Service Center in the module general log.

Inputs

Message
Type: mandatory, Text.
The message to add to the module general log.
ModuleName
Type: mandatory, Text.
The name of the module to be associated with the log message.

RequireScript

Add a Javascript to the html header. Multiple calls for the same Javascript will only add it once. Action flow will proceed after the Javascript has been successfully loaded.

Inputs

Url
Type: mandatory, Text.
The Url of the Javascript to add to the header

ScreenReachedFromHistory

Determines if the current screen has been reached from the history (e.g. using "Back" navigation).

Outputs

ReachedFromHistory
Type: Boolean.
  • Was this article helpful?