Process
This page provides generated reference documentation for the Process data model.
A project-wide process
Overview
| Property | Summary |
|---|---|
| title | Title (speaking name. may contain spaces and special characters.) |
| description | Description |
| documentation | Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different… |
| comment | Property to store a developer comment in form of |
| icon | Image. |
| iconProcess | Specifies the icon dynamically. If the icon has no effect, neither will the result of the process. |
| iconInactive | Inactive icon (inverse color to default icon for inactive display in frame tabs.) |
| variants | List of possible variants. Processes that have the property publishAsWebservice set, automatically get the variant webservices. If you want to start a… |
| process | The process itself, that is, the code to be executed when this process is called. |
| signature | — |
| restAcceptedMimeType | MIME types accepted by the rest webservice (comma separated). |
| restDeliveredMimeType | MIME type that the rest webservice returns. |
| soapOmitEmptyResult | Specifies whether the <return> element should be omitted in the SOAP response if no result value is present. |
| soapUseRawXmlResult | Specifies whether the result of the process is to be integrated directly as XML in the SOAP response. The result is not encapsulated in a <return> block, the… |
| alias | The database alias that is associated with this process and is used by database instructions by default. |
| publishAsWebservice | Publishes the process as a webservice. |
| style | Type for web services: REST or SOAP. |
| wsdl | If a process is configured to be provided as a SOAP Webservice, a specific WSDL for SOAP Webservice can be placed here. |
| loginTypeId | Allows anonymous authentication for Web services processes. |
| jditoWebserviceUser | The title of the user used for executing JDito when the webservice is called. If specified, it will overwrite the login user. If no value is provided and the… |
| restrictedRoles | For processes with Web services and login: Only users with the specified roles can run the WebService. If no roles are specified here, all of them are allowed… |
| enableNestedRequests | Determines whether nested resource requests are enabled or disabled for REST webservices. It controls whether the RESTful web service application for this… |
| webserviceEnabled | Activates the process as a webservice. |
| anonymousUsageWebservice | Allows anonymous access to the webservices when a process is specified as a webservice process. |
| serviceTaskParameterProcess | Process to define the available parameters of the workflow service task. |
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title (speaking name. may contain spaces and special characters.)
This has different effects depending on the entity:
System, Application, Template, Language and Alias: no effect
Frame, NeonFrame: Caption of the frame in the client
Process: Name of the process in system administration
Report: Labeling of the report in the client
Role: Name of the role as it appears in the client
description
Type: String
Description
documentation
Type: String
Contains the documentation of the data model in the popular AsciiDoc format (.adoc).
The documentation should be set by the developer to explain different aspects
(like purpose, concept, etc.) of the data model that he designed.
You may want to add the plugin "AsciidoctorJ" to your ADITO Designer in order
to modify AsciiDoc files.
comment
Type: String
Property to store a developer comment in form of
/**
*
*/
In the past this was used in customizing for frame controls additional settings, such as the activation of rights, histories, or attributes.
This should not be done anymore in the comment-property, because therefor a metadata-property exists.
icon
Type: String
Image.
Depending on the datamodel, this has different effects:\
- Entity: used as symbol in the designer. Do not confuse this property with the iconId property\
- Context: used as symbol in the designer. If the contexts entity has an icon set, the entities icon is used\
- System, Language, Role, Application: icon that appears only in the designer.\
- Template: Same effect as on the respective component\
- Alias, User: no effect\
- Frame, Process, Report, NeonFrame: icon that appears in the designer and in the client for the frame.
iconProcess
Type: String
Specifies the icon dynamically. If the icon has no effect, neither will the result of the process.
Depending on the datamodel, the result of the process has to be different:
When you can specify an icon-avatar-text (e.g. "VAADIN:USERS):
You've to return the icon-avatar.text with result.string(...)
When you can specify an image in the icon:
This is returned as a string with the ID of the image in the ASYS_BINARIES via result.string().
Error messages from this process do not arrive at the client, they are only visible in the server log.
iconInactive
Type: String
Inactive icon (inverse color to default icon for inactive display in frame tabs.)
variants
Type: IVariant.Variants
List of possible variants. Processes that have the property publishAsWebservice set, automatically get the variant webservices. If you want to start a process in the manager or with the process JDito module, you need to assign the variant executables to it. Webservices or Workflow-Processes don't need the variant executables. Some internally used processes automatically get the variant internal, which can't be assigned manually. Processes that are used in imports of other processes have to be assigned the variant libraries.
process
Type: String
The process itself, that is, the code to be executed when this process is called.
All JDito methods are available here to help you implement the desired process.
Global functions can also be defined at this point (see e.g. lib_keyword).
Errors in this process are displayed on the client if they were run at the client, otherwise they will not.
signature
Type: String
restAcceptedMimeType
Type: String
Requires: style property group
MIME types accepted by the rest webservice (comma separated).
restDeliveredMimeType
Type: String
Requires: style property group
MIME type that the rest webservice returns.
soapOmitEmptyResult
Type: Boolean
Requires: style property group
Specifies whether the <return> element should be omitted in the SOAP response if no result value is present.
soapUseRawXmlResult
Type: Boolean
Requires: style property group
Specifies whether the result of the process is to be integrated directly as XML in the SOAP response. The result is not encapsulated in a <return> block, the returned string is written directly into the response as XML.
NOTE: The process of the web service is responsible for returning a valid string containing the XML as a result. If no valid XML can be generated for the response with the result, an error response is delivered when the method is called.
alias
Type: String
The database alias that is associated with this process and is used by database instructions by default.
publishAsWebservice
Type: Boolean
Default: false
Constraints: Verification: EVerifier.NAMESPACE
Requires: style property group
Publishes the process as a webservice.
style
Type: EWebserviceStyle
Type for web services: REST or SOAP.
wsdl
Type: String
Requires: style property group
If a process is configured to be provided as a SOAP Webservice, a specific WSDL for SOAP Webservice can be placed here.
loginTypeId
Type: String[]
Requires: style property group
Allows anonymous authentication for Web services processes.
This is where a login type is specified, which is specified in the instance config under Client->Login in the loginList.
jditoWebserviceUser
Type: String
Requires: style property group
The title of the user used for executing JDito when the webservice is called. If specified, it will overwrite the login user. If no value is provided and the webservice is accessed anonymously, no user will be available to the process.
restrictedRoles
Type: String[]
Requires: style property group
For processes with Web services and login: Only users with the specified roles can run the WebService. If no roles are specified here, all of them are allowed to access this process.
enableNestedRequests
Type: Boolean
Requires: style property group
Determines whether nested resource requests are enabled or disabled for REST webservices. It controls whether the RESTful web service application for this process allows nested resource requests.
-
If this property is set to
true, nested resource requests will be accepted. In practice, this means URLs in the following formats would be valid:
/my_process_ws/this/and/that/42/entries/my_process_ws/orgs/reviewed//my_process_ws/
The request URL is provided within the executing process. -
If this property is set to
false, nested resource requests will not be allowed, and a HTTP 404 error will be returned whenever nested resources are requested through this webservice.
Regardless of this property's setting, non-nested requests are always possible. For example:
/my_process_ws?param=value/my_process_ws
webserviceEnabled
Type: Boolean
Default: false
Activates the process as a webservice.
anonymousUsageWebservice
Type: Boolean
Default: false
Allows anonymous access to the webservices when a process is specified as a webservice process.
serviceTaskParameterProcess
Type: String
Process to define the available parameters of the workflow service task.