Load Entities (SQL)

Audience: Citizen Developer
Skill Prerequisites: Using Form Builder

This action creates an entity in the current context from the result of the provided SQL Query. You can find the number of loaded entities in the [<EntityName>:Count] token.

note

This creates an entity that can be used ONLY in the current context. This does not create a Plant an App Entity.

Typical Use Cases

  • Load values from a SQL Query that returns a list of contacts and then send individual emails to that list.
  • Load values from a SQL Query into an entity and then serialize that entity into CSV or Excel to provide the results in a file to the end-user.

Don't use it to

  • Run a SQL query for any other reason than selecting records to create a contextual entity. For other SQL query scenarios, use the Run SQL Query action instead.

Related Actions

Action NameDescription
Execute Actions on Entity ListExecute a list of actions on each item in the specified context entity. Use this to process the items loaded in the Entity created.
Extend EntityExtends an entity with new properties.
Serialize to CSVSerializes a list of entities from the context into CSV (Comma Separated Values) format.
Serialize to Excel from entity list XSLXSerializes a list of entities from the context into Excel format.

Input Parameter Reference

The parameters unique to this action are listed below. Review the common parameters for all actions here.

ParameterDescriptionSupports TokensDefaultRequired
Other Connection StringThe connection string to the database. If left empty, the query will be executed on the main application database. You can connect to any database which supports the ODBC standard. For example, if you want to connect to an Oracle DB, you would specify
Data Source=MyOracleDB;User Id=myUsername; Password=myPassword;Integrated Security=no;
in the field. You can find out more about connection strings here.
YesApplication databaseNo
SQL QueryThe SQL query you want to execute on the database. While the query does accept tokens, we recommend using the Bind Tokens parameter to avoid any potential SQL injection exploits.YesUnsetYes
Bind TokensThis parameter allows you to use tokens as variables in the SQL Query field to avoid SQL injection. For example, if you want to use the token [UserId] in your query, you would put the token in the Parameter Value field and give it a name in the Parameter Name field such as ID. After that, you can reference this variable as @ID inside the SQL Query Field.YesUnsetNo
Entity NameProvide a name for the entity being created. This name can be used in the Execute Actions on Entity List action to reference the items in the entity using [EntityName:PropertyName] token syntax.Yesempty stringYes
PropertiesMap columns returned by the SQL to properties of the entity. If the list is empty, all columns retrieved from the SQL query will be added as entity properties.YesNone SpecifiedNo
On ErrorSpecify a list of actions to run on error. Otherwise, an error message is returned which will contain the underlying error if debug mode is on.YesNone SpecifiedNo
Last updated on by Patrick Anderson