Workflow.Worker.Parameter

Providing you have sufficient access control permissions, the Workflow.Worker.Parameter provider enables you to write a Luminesce SQL query that retrieves input parameters for workers from the Workflow Service.

See also: Workflow.Worker, Workflow.Worker.ResultField

Basic usage

select * from Workflow.Worker.Parameter where <filter-expression>

Data fields

By default, Workflow.Worker.Parameter returns a table of data populated with particular fields (columns). You can return a subset of these fields.

To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a suitable tool:

select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Workflow.Worker.Parameter' and FieldType = 'Column';

Note: Fields marked 'main' are returned by queries that select a caret character, for example select ^ from Workflow.Worker.Parameter.

Examples

Note: For more example Luminesce SQL queries, visit our Github repo.

Example 1: Retrieve all input parameters for a worker

select * from Workflow.Worker.Parameter where Scope = 'Finbourne-Examples' and Code = 'UpsertPortfolio';

Example 2: Retrieve the default value of a particular input parameter

select DefaultValue from Workflow.Worker.Parameter where Name = 'CreatedDate' and Scope = 'Finbourne-Examples' and Code = 'UpsertPortfolio';

Example 3: See if an input parameter requires a value, and of which data type

select Name, Required, Type from Workflow.Worker.Parameter where Name = 'EntityScope' and Scope = 'Finbourne-Examples' and Code = 'UpsertPortfolio';