You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Learn more about specifying new types in globals like: container type and service type.
Globals
Blueriq Encore delivers by default libraries with functions that a business engineer uses in his models. Sometimes this functionality is not sufficient. A business engineer and a developer together can add new functionality to a library. If the library is added to a project the new functionality will be provided in Blueriq Encore. A business engineer can define new types within Blueriq Encore in the Globals menu, for example a new Container type or a new Service type. The business engineer can add parameters to a new type to specify how the new type should behave in Blueriq Encore. A developer must add coding to actually add behavior to the new component. Check the Add custom plugins page for more information.
Container type
Containers are used to display content on a page. Each container has a container type which defines its properties. You can specify parameters for your container type, so that business engineers can adjust the behavior of the container to fit their needs. You can also specify whether the business engineer is allowed to place content in this type of container or that content is fully rendered.
A container type is composed by 3 parts:
- General
- Events
- Parameters
General tab in the properties panel
Enter a clear description of your container type.
| Property | Description |
|---|---|
| Default content style | If you want to connect a specific content style to the container select a default content style. |
| Dynamic | If the container executes a technical implementation (not to display containment only), check dynamic container |
| Has containment | If you want to allow business engineers to select containment (e.g. containers, attributes, etc.) in your in your container, check Has containment. |
Events tab in the properties panel
If an action in the container should trigger an event, create an event type here. The Business engineer should map the event when implementing.
When checking the 'Throws default event' parameter, a container will get a default exit that can be triggered by that container. The main difference is that it is a nameless event, and cannot be mapped to a flow event. This is a parameter that preferable should not be checked in new containers. As it is possible to have multiple containers on the same page, a Business Engineer can not be sure what container triggered this default event and what behavior should be modeled following a default event. It is also possible to model a named event on the container type. If the business engineer chooses not to map it, a default event is placed on the flow, therefore making this parameter obsolete.
Parameters
When you create a dynamic container you can add parameters in the canvas.
Service type
A service is used to perform an action. A service type specifies a service and its parameters. Typical use of a service is connecting to an external system to provide or retrieve data. Where the service type dictates the interpretation of the service and its behavior.
A service type is composed by 3 parts:
- General
- Events
- Parameters
General tab in the properties panel
Enter a clear description of your service type. This description is shown whenever the service type in the service call editor is selected.
Event tab in the properties panel
- When checking the 'Throws default event' parameter, a service will get a default exit that can be triggered by that service. The main difference is that it is a nameless event, and cannot be mapped to a flow event. This is a parameter that preferable should not be checked in new services. It is possible to model a named event on the service type. If the business engineer chooses not to map it, a default event is placed on the flow, therefore making this parameter obsolete.
- If an action in the container should trigger an event create an event type here. The Business engineer should map the event when implementing the service call in the application.
Parameters
When you create a service type you can add parameters by taking the following steps:
- Use the + Add parameter button to add a parameter.
Select the parameter type that you wish to add in the drop-down menu. (for more information see table with parameter types).
- Give each parameter a clear and unique name.
- Specify the parameter (for detailed descriptions see below)
Check the reference guide for help on the predefined Blueriq service types.
Container and service call parameters description
This section will describe in detail all the possible container and service call type parameter types and their purposes. For both the container type and the service call type the list of parameter types is the same.
Parameter Overview
| Type | When used |
|---|---|
| GlobalElement | When the business engineer must be able to select items from a list with elements from the globals, for instance: a list with Roles. |
| Domain | When the business engineer must be able to choose between a limited set of values, for instance: ascending and descending. |
| Expression | When the business engineer needs an expression box to enter the value for a parameter. |
| Module element | When the business engineer must be able to select items from a list with elements from a module. For instance when an attribute must be selected. |
| Primitive | When a plain value must be entered. When a business engineer must be able to select a Boolean answer. |
GlobalElement
When the business engineer must be able to select items from a list with elements from the globals, for instance: a list with Roles.
| Option | Description |
|---|---|
| Description | In the parameter description you can describe to the users of your container how to use the parameter. |
| Required | If the parameter is required, check the Required box. |
| Multivalued | When multivalued is used, multiple items of the global element parameter can be selected by the business engineer. |
| Global element type | This is a list of all element types that a Business Engineer is able to model as a globel element. |
| Key-value pair | When a parameter is multivalued, it is possible to mark it as key-value pair. When creating a container or service, this parameter results in an extra input field for every entry in which a Business Engineer can specify a name. |
| Direction | The Direction field is merely used as additional information for the user. it has no runtime implementation. |
Domain parameter
When the business engineer must be able to choose between a limited set of values, for instance: ascending and descending
| Option | Description |
|---|---|
| Description | In the parameter description you can describe to the users of your container how to use the parameter. |
| Required | If the parameter is required, check the Required box. |
| Domain value(s) | It is possible to define a list of options here. When creating a service or container, a choice has to be made between these values. |
| Multivalued | When multivalued is used, multiple items of the domain parameter can be selected by the business engineer. |
| Key-value pair | When a parameter is multivalued, it is possible to mark it as key-value pair. When creating a container or service, this parameter results in an extra input field for every entry in which a Business Engineer can specify a name. |
| Direction | The Direction field is merely used as additional information for the user. it has no runtime implementation. |
Expression parameter
When the business engineer needs an expression box to enter the value for a parameter.
| Option | Description |
|---|---|
| Description | In the parameter description you can describe to the users of your container how to use the parameter. |
| Required | If the parameter is required, check the Required box. |
| Expected data type | It is possible to set the expected result type. When this type is set, Encore and runtime check whether the result of the entered expression matches the expected type. |
| Multivalued | When multivalued is used, multiple items of the expression parameter can be selected by the business engineer. |
| Multivalued results | This parameter indicated if the expression is allowed to return a multivalued result. |
| Key-value pair | When a parameter is multivalued, it is possible to mark it as key-value pair. When creating a container or service, this parameter results in an extra input field for every entry in which a Business Engineer can specify a na |
| Direction | The Direction field is merely used as additional information for the user. it has no runtime implementation. |
Module element parameter
When the business engineer must be able to select items from a list with elements from a module. For instance when an attribute must be selected.
| Option | Description |
|---|---|
| Description | In the parameter description you can describe to the users of your container how to use the parameter. |
| Required | If the parameter is required, check the Required box. |
| Module type | Select the type of module in which you want to select an element. When selecting an interaction module, only the elements in the own interaction module can be selected. |
| Module element type | This is a list of all elements that can be modeled in the selected module type. |
| Multivalued | When multivalued is used, multiple items of the module parameter can be selected by the business engineer. |
| Key-value pair | When a parameter is multivalued, it is possible to mark it as key-value pair. When creating a container or service, this parameter results in an extra input field for every entry in which a Business Engineer can specify a name. |
| Direction | The Direction field is merely used as additional information for the user. it has no runtime implementation. |
| Select module | When this checkbox is selected, in the service definition the module element selector will have an extra filed where the module can be selected. |
Primitive parameter
When a plain value must be entered. For example when a business engineer must be able to select a Boolean answer or a String value.
| Option | Description |
|---|---|
| Description | In the parameter description you can describe to the users of your container how to use the parameter. |
| Required | If the parameter is required, check the Required box. |
| Datatype | This is a list of all data types known in Encore. |
| Multivalued | When multivalued is used, multiple items of the primitive parameter can be selected by the business engineer. |
| Key-value pair | When a parameter is multivalued, it is possible to mark it as key-value pair. When creating a container or service, this parameter results in an extra input field for every entry in which a Business Engineer can specify a name. |
| Direction | The Direction field is merely used as additional information for the user. it has no runtime implementation. |
Overview
Content Tools