All Classes and Interfaces
Class
Description
Abstract base class for implementations of
AutoDeploymentStrategy.Abstract base class for implementations of
AutoDeploymentStrategy.Abstract base class for implementations of
AutoDeploymentStrategy.An abstract base implementation for a tag evaluation context.
Abstract base class for implementations of
AutoDeploymentStrategy.A backend representation of the data that is used by the datatable component in Flowable.
An abstract base class for desk and ticket related commands.
Provides an abstract base class for data structures that conform to a specific data dictionary type.
An abstract based class for DMN based permission helpers where the evaluation of permissions is based on the execution of DMN models.
Abstract base class for implementations of
AutoDeploymentStrategy.Abstract base class for implementations of
AutoDeploymentStrategy.Abstract base class for implementations of
AutoDeploymentStrategy.Abstract base class for implementations of
AutoDeploymentStrategy.Abstract base class for implementations of
AutoDeploymentStrategy.An abstract service invoker supporting general methods around parameter handling for service invokers.
Abstract base class for implementations of
AutoDeploymentStrategy.An abstract bot implementation to start a process or case instance and supporting some functions around it.
An abstract tag provider supporting some common functionality for conversation tag providers.
Abstract base class for implementations of
AutoDeploymentStrategy.An abstract base class for ticket based commands.
This interface is an enumeration of the default channel types available for actions, however, you can also add additional, custom ones.
An action definition is used as the model and meta information in order to create a new Action based on such
a definition.
Annotation that can be used to trigger a deployment of action definitions for the provided test.
An action definition model contains all information around an action definition, its necessary permissions and mapped types and many things more to have
pluggable actions on scoped objects like conversations, users, etc.
A collection of common tags representing additional state information which can then be used within the tag list of
ActionDefinition.Represents a deployment that is already present in the action definition repository.
Builder for creating new deployments, similar to the action deployment builder.
Allows programmatic querying of
ActionDeployments.JUnit Jupiter extension for the Flowable Platform action engine and services initialization.
An object structure representing an action instance.
Helper for starting new Action instance.
An object structure representing an execution of an action instance.
Allows programmatic querying of
ActionInstances.Contains the possible properties that can be used in a
ActionInstanceQuery.The action template service supports the handling of message generation in the scope of the Action engine.
The default implementation for a confirmation template service using the template engine to render template based confirmation messages and titles.
Adds user as a participant to the parent
CaseInstance/ProcessInstanceA specialization of the
JsonObjectKeyValueExtractorQueryResultMapper that will look in the 'aggregations' field by default.Returns a 401 error code (Unauthorized) to the client, when Ajax authentication fails.
Spring Security success handler, specialized for Ajax requests.
Annotation indicating that the bean annotated with it is available in strict mode.
Annotation indicating that the method or methods in a class can be executed in strict mode.
Filter to combine the
LargeVariableValueIndexingFilter and the DefaultVariableIndexingFilter.An annotation that can be used on test classes or as a meta annotation to use a custom configuration resource for the
FlowableAppExtension.An annotation that can be used on test methods, lifecycle method to inject the id of the deployment deployed via
AppDeployment.Provides access to all services that expose App management operations.
A
TemplateProcessor using the Aspose Document.A
TemplateProcessor using the Aspose ReportingEngine.Assigns a conversation to a group.
Assigns a conversation to a user.
Wrapper for the async history job data, to avoid messing with maps and lists.
A listener for command context lifecycle close events that generates JSON
(using Jackson) and corresponding
HistoryJobEntity when the
CommandContext closes and adds them to the list of entities that will
be inserted to the database.The audit definition contains the necessary meta information and description of its related
AuditInstance which also
includes the optional list of necessary parameters available within the payload of the instance.The audit engine configuration API.
The runtime instance of an audit entry, typically created through the
AuditService.A builder to create new objects of type
AuditInstance.A query builder to query for
AuditInstance.Contains the possible properties that can be used in a
AuditInstanceQuery.The main service to create and retrieve
AuditInstance.A Log4J 2 converter that can be used to output the currently authenticated user.
A Logback converter that can be used to output the currently authenticated user.
An authorized action represents an action which can be checked for permissions by using a permission helper.
This enumeration contains a list of actions which are authorized as part of the permission check when executing
actions in a conversation.
This enumeration contains a list of actions which are authorized as part of the permission check when executing actions for a user.
A simple representation of tokens which can be used as bearer tokens
to authenticate against 3rd party services.
A base implementation for
BotActionResult.Base class that can be used by different external system provider
to provide an implementation for the sending of the outbound message.
A base implementation of
ScopedObjectActionFilter which performs checks based on the
ActionDefinitionModel.getMappedStates(), ActionDefinitionModel.getMappedSubStates(),
ActionDefinitionModel.getMappedTypes() and ActionDefinitionModel.getMappedSubTypes().Abstract base implementation for updating different aspects of a conversation.
A base implementation of
PlatformGroup that can be used
when implementing a custom PlatformIdentityServiceA base implementation of
PlatformIdentityInfo that can be used
when implementing a custom PlatformIdentityServiceA base implementation of
PlatformUser that can be used
when implementing a custom PlatformIdentityServiceThe result when invoking a bot action.
Holds context information for a bot action invocation.
Implement this bot service interface to provide an execution for action definitions based on this bot.
Ensures script error traces of the configured engine are extended with cmmn / bpmn scope information
An action bot starting a new process instance and passing in the provided payload.
An interceptor that will be called before and/or after the execution of a
BulkRequest in the BulkIndexingSession.This is a custom class to do bulk requests to ES.
Special
ResourceAccessor which can be used to load the Liquibase XML changelog from a byte array.Updates caches and artifacts for a deployment and its forms
The result mapper interface converting case search hits into case search representation objects.
The interface you can implement when you want to enhance case based search hit data.
The enumeration of message categories.
Changes the owner of the conversation.
Checks the permission to edit a message within a conversation using a DMN permission table.
TODO: this should be moved to external (but probably needs a new module)
TODO: this should be moved to external (but probably needs a new module)
Filter clients without advisor
A
TypeHandler that uses ResultSet.getCharacterStream(String) and ResultSet.getCharacterStream(int)
to convert a Clob into a string.An action bot starting a new case instance and passing in the provided payload.
A bot that handles actions originating from CMMN manual activates plan item instances.
A bot that handles actions originating from CMMN user event listeners.
A read-only variable container, which iterates a collection of given variable containers to resolve a variable,
in the order of iteration.
A configurable date / date and time formatter utility.
A builder for creating
ConfigurationPropertyThis default implementation simply returns a configured, fixed tenant id regardless of the content of the inbound message.
An annotation that can be used on test classes or as a meta annotation to use a custom configuration resource for the
FlowableContentExtension.Contains the possible properties that can be used in a ContentItemQuery.
The interface you can implement when you want to enhance content item based search hit data.
Wrapper class for handling content item and metadata in forms
An interface with constants about the supported content types used in
Message.getMainContentType().The context object aware variant of BotService.
The conversation is a container where messaging and events between humans and even bots happen.
A builder interface building
Conversation objects.A tag evaluation context based on a conversation builder in order to be able to modify the tags through it.
Annotation that can be used to trigger a deployment of conversation definitions for the provided test.
Builder for bulk registration of Conversation Definitions.
A tag evaluation context based on an existing conversation represented by its conversation entity so it can be
modified.
A user has a list of filters that can be applied when retrieving conversations.
Exposes methods to retrieve conversation filters and use those filters to find conversations.
The conversation holder might be used to hold a conversation and additional information like if it was a newly
created one or an existing one.
A service bot supporting basic conversation management functionality like joining or dropping participants, archiving, etc.
An events listener that is responsible for sending messages to a conversation when an event occurs.
Notification service for the Conversations which is responsible for sending messages to conversation.
This builder supports various ways to add or drop participants within a conversation with smart options like letting them see previous messages or even
all past messages and similar options.
Default implementation for the participant builder API.
The permission helper must be used to check permissions on actions to be executed in the context of a conversation
like adding or removing participants or posting a voice message, etc.
The default implementation of the permission helper checking permissions for certain conversation related actions
with the help of a two-step DMN decision model approach.
Allows for programmatic querying of conversations.
An entry of a conversation participant registry.
Allows for programmatic querying of conversation registry entries.
The implementation of the
ConversationRegistryEntryQuery interface used to query for conversation registry entries.The interface you can implement when you want to enhance conversation based search hit data.
The conversation service is the main API for the conversation and messaging functionality.
The default conversation service implementation using commands to provide the necessary functionality.
This interface supports strategy methods around the starting and initialization of a conversation like initializing
data like types of a new conversation as well as searching for reusable, existing conversations when trying to start
a new one.
Interface containing the known states of a conversation.
This represents the information for the last read message for a certain user in a certain conversation
The tag evaluation context might be used within a
ConversationTagProvider to request additional information
in order to evaluate tags for conversations.A conversation tag provider is invoked during the initialization of a new
Conversation as well as if relevant
data of a conversation is changed later on, which includes:
Conversation.getType()
Conversation.getSubType()
Conversation.getOwnerId()
Conversation.getAssigneeId()
Permissions.getAssignedGroupId()
Conversation.getCandidateUserIds()
Conversation.getCandidateGroupIds()
There might be a chain of tag providers each one of it providing tags to be added to the list of tags of the
conversation.The conversation type specifies the conversation in more detail.
A participant query object can be obtained through
ConversationService.createConversationUserQuery() and can be used to query for participant
information within a conversation.The implementation of the
ConversationUserQuery interface used to query for users involved in a conversation.Hook points for enhancing the response of REST endpoints and services.
Marker interface to mark the base package for the Flowable Core Services
Number of conversations which received new messages within a given time frame.
A custom indexing configuration based on a list of types to be indexed within this index.
Hook point that can be used to override the update user handling
A dashboard component definition defines how a component gets its data and what options are available.
Contains the possible properties that can be used in a
DatabaseContentObjectQuery.Represents a data dictionary typed array data container abstraction, ensuring adherence to a specific data dictionary type.
Provides a fluent builder interface for creating typed instances of a data dictionary.
A data dictionary typed structure that is backed by json data.
A data dictionary typed structure that is backed by a map.
Represents a data dictionary typed data container abstraction, ensuring adherence to a specific data dictionary type.
This interface defines a builder for validating data against a specified data dictionary type.
The data-dictionary-variable xml element definition
with additional runtime information added (data dictionary)
The Data Dictionary Variable Definitions is a collection of
DataDictionaryVariableDefinition (type information) for a given scopeSession to deal with and cache data dictionary related aspects of Service Registry Models.
A delegate data object model, which is used to hold enriched field mappings derived from the data dictionary information.
A data source is responsible to handle external data objects, like lookup, query, create, update and delete.
Defines the data object data source ids
The definition describing a data object.
Annotation that can be used to trigger a deployment of data object definitions for the provided test.
A query object used to query for data object definitions.
The basic data object deletion builder which might be extended with a strongly typed support by the underlying
DataObjectDataSource implementation.Represents a deployment that is already present in the data object definition repository.
Builder for creating new deployments, similar to the data object deployment builder.
Allows programmatic querying of
DataObjectDeployments.JUnit Jupiter extension for the Flowable Platform data object engine and services initialization.
The data object context is used during data object creation and modification operations and is used to provide additional context information like the
form model where the operation is based on or additional payload data.
The query interface to create a query to search for data object instances.
A data object instance variable container.
The basic data object instance builder which might be extended with a strongly typed support by the underlying
DataObjectDataSource implementation.The data object model contains all meta information around a data object like source, fields behaviour and further information.
The basic data object modification builder which might be extended with a strongly typed support by the underlying
DataObjectDataSource implementation.The main service interface for the master data management.
The data object runtime service supports lookup of data object instances based on
DataObjectDefinitions as well as some more data object and its
definition based features.A query object used to query for data object schema definitions.
A list of available data object source types as being used by the
DataObjectDefinition.Defines the data object type of the data object definition
Data Object variable.
This variable type is used to store a referenced data object as a variable, but only holding its lookup id and definition id.
Default Implementation of
AutoDeploymentStrategy that performs a separate deployment for each resource by name.Default implementation of
AutoDeploymentStrategy
that groups all Resources into a single deployment.A backend representation of the data that is used by the datatable component in Flowable.
The default form provider will simply use the form repository to fetch the latest form definition by form key.
Default implementation of
SubmittedVariablesExtractor just copies variable names from the submission into
BE variables.The default template processing result, holding the processed content as well as the template definition and variation used to process the result.
Default implementation of VariableIndexingFilter, allowing to define a list of variable names to include or exclude.
Whether to filter by inclusion of matched patterns or exclusion of matched patterns.
Resolves the definition of a case instance or process instance
Contains the possible properties that can be used in a
FormDeploymentQuery.A listener handling message send and conversation creation events for desk and ticket conversations.
A service bot managing desk and ticket conversations.
An interface containing message codes (constants) used within desk and ticket conversations.
This utility helps creating template based messages used within desk and ticket conversations.
The desk and ticket management service interface is used to control and manage desk and ticket conversations.
The default desk and ticket service implementation.
This variable type is used to store a detached data object as a variable/
It holds its lookup id and definition id, and it will also store the values of the data object.
An interface that can be implemented to provide the distinguished names based on a collection
of user ids and / group ids / keys.
Default implementation of
DistinguishedNameProvider that uses the Spring LdapTemplate to query for the information.Represents a deployment that is already present in the document definition repository.
Builder for creating new deployments, similar to the document deployment builder.
An annotation that can be used on test methods, lifecycle method to inject the id of the deployment deployed via a DocumentDeployment.
Allows programmatic querying of
DocumentDeployments.Edoras VIS i18n property.
Utils for working with Flowable and edoras vis.
This is a custom class to do bulk requests to ES.
Low-level operations for Elasticsearch.
The result mapper is used to map a hit returned by an Elasticsearch query into a response object.
Checks whether non enabled form field submitted variable value differs from the initial variable value
JUnit Jupiter extension for the Flowable Platform engage engine and services initialization.
A job handler handling Engage SLA based escalation steps for tasks.
Maintains a list of all the entities in order of dependency.
Maintains a list of all the entities in order of dependency.
Maintains a list of all the entities in order of dependency.
Maintains a list of all the entities in order of dependency.
Maintains a list of all the entities in order of dependency.
Maintains a list of all the entities in order of dependency.
Maintains a list of all the entities in order of dependency.
Utility class to deal with entity links.
Helper class that wraps a
HistoricEntityLink such that the methods don't need to distinguish.Initializes the avatar url or id depending on some previously evaluated tags (e.g.
This command evaluates conversation tags by using a set of configured tag providers and updates the conversation
accordingly.
An inbound message account service creating internal system events from inbound messages not having a mapped account or an inactive account or user so any
listeners (like a case or process instance) might picking it up and processing it.
Helper for executing and Action instance.
Interface that needs to be implemented by an external conversation system provider.
Holder for the publicly accessible URLs for the media sent to LINE.
Builder that can be used for sending external messages
A content provider that is responsible for fetching the actual content
from the external system.
Service that is responsible for fetching content from the external systems.
This interface contains some available external system ids.
ContentObject, backed by a file.Allows to define nested groups of filter clauses which are transformed to SQL WHERE clauses.
NOTE: THIS IS NOT A FULL FLEDGED QUERY BUILDER (yet).
Resolves the participants of a conversation with options whether to only include directly assigned users or
users assigned over member groups (like candidate groups or assigned group).
Finds conversations which received new messages within a given time frame.
Function for getting a user by id.
Event fired when participants have been added to a conversation.
A function delegate to add objects to an
ArrayNode.JUnit Jupiter extension for the Flowable AppEngine and services initialization.
Convenience for AppEngine and services initialization in the form of a JUnit rule.
A Helper for the Flowable
FlowableAppExtension that can be used within the JUnit Jupiter context store
and users can use it in the tests for easy modifying of the AppEngine time and easy access for waiting on the job executor.Util class for creating different
Collector(s) that are not part of the Java Collectors utils.JUnit Jupiter extension for the Flowable ContentEngine and services initialization.
Convenience for ContentEngine and services initialization in the form of a JUnit rule.
An extension that uses
SpringExtension to get the ContentEngine from the ApplicationContext
and make it available for the FlowableContentExtension.A Helper for the Flowable
FlowableContentExtension that can be used within the JUnit Jupiter context store
and users can use it in the tests for easy modifying of the ContentEngine time and easy access for waiting on the job executor.Event fired when tags have been added to a conversation.
Event thrown if the reference of a conversation was set or updated.
Simple implementation for the reference update event of a conversation.
Event fired when tags have been removed from a conversation.
Enumeration containing all DataObjectEvents
FlowableEventType(s).Enumeration containing all possible types of
FlowableEngageEvents for the Engage engine.Expression Bean Name: flwAuthTokenUtils
Expression Bean Name: flw.base64
Provides utilities to work with base64.
Expression Bean Name: flwCollectionUtils
Offers utilities to work with
Collections (Lists, Sets etc.) as well as Maps.Deprecated.
Expression Bean Name: flw.format
Offers a number of formatting utils, mostly related to numbers, currencies and strings.
Expression Bean Name: flw.io
Provides utilities to work with I/O.
Expression Bean Name: flwJsonUtils
Offers utilities to work with JSON objects and arrays.
Expression Bean Name: flw.locale
Provides utilities to work with locales, countries and languages.
Expression Bean Name: flw.math
Provides a number of mathematical operations.
Expression Bean Name: flw.string
Provides utilities to work with strings.
Expression Bean Name: flw.time
Provides a number of date and time utilities which can be used in expressions.
JUnit Jupiter extension for the Flowable FormEngine and services initialization.
Convenience for FormEngine and services initialization in the form of a JUnit rule.
An extension that uses
SpringExtension to get the FormEngine from the ApplicationContext
and make it available for the FlowableFormExtension.A Helper for the Flowable
FlowableFormExtension that can be used within the JUnit Jupiter context store
and users can use it in the tests for easy modifying of the FormEngine time and easy access for waiting on the job executor.An exception indicating that a validation of a form field value resulted in an error.
Base class for all FlowableIdmEntityEvent implementations, related to entities.
Builder class used to create
FlowableEvent implementations.Base class for all FlowableIdmEvent implementations.
Event fired when a
PlatformIdentityInfo is set explicitly via.Implementation of
FlowableIdmMembershipEvent.The Spring Security default implementation prefixes the authorities with
SCOPE_ and uses the scopes from OAuth2 in the authorities.Deprecated.
use
FlowableLdapAuthenticationProviderFactory to expose an AuthenticatioProvider insteadExposes an LDAP
AuthenticationProvider bean
using the Flowable LdapConfigurationApi.Function delegate that allows creating a list of items.
The Spring Security default implementation prefixes the authorities with
SCOPE_ and uses the scopes from OAuth2 in the authorities.Implementation of the
DefaultObjectWrapper for Flowable supported types.Custom implementation of Spring Security's RememberMeServices.
Base class for all
FlowablePlatformIdmEventType implementations.Enumeration containing all Platform IDM
FlowableEventType(s).Updates allowed properties for process instance, case instance and task entities
Class that exposes the Flowable Platform version.
Event fired when participants have been removed from a conversation.
A Spring Security configurer used for configuring the Flowable Token Request Parameter authentication.
Event fired when the presence information of a user has been changed.
Resolves the definition of a case instance or process instance
An annotation that can be used on test classes or as a meta annotation to use a custom configuration resource for the
FlowableFormExtension.Methods for working with deployments.
Specific parsing of one form json file.
Annotation for a test method to create and delete a deployment around a test method.
An annotation that can be used on test methods, lifecycle method to inject the id of the deployment deployed via
FormDeploymentAnnotation.Contains the possible properties that can be used in a
FormInstanceQuery.A flowable internal API used for easier access to form definitions for different scopes.
Contains the possible properties that can be used in a FormDefinitionQuery.
A utility class that hides the complexity of
FormDefinitionEntity and FlowableFormModel lookup.A FreeMarker engine based template processor.
A generic indexing transformer that just gets the data and sends it to ES as is.
Gives access to a deployed form model, e.g., a Form JSON file, through a stream of bytes.
This permission helper implementation is the default one in the IDM module and is granting all permissions to all users for user management.
Handle new inbound message within an unassigned ticket.
Represents an entity that is associated with a specific type of a data dictionary.
Resolves base from the hierarchy
An object structure representing a historic action instance.
Allows programmatic querying of
HistoricActionInstances.Contains the possible properties that can be used in a
HistoricActionInstanceQuery.A common interface for historic root process and case instances.
Query used for querying historic root process and case instances.
A voter which checks whether a user is allowed to impersonate another user or not.
Handler for inbound errors from an external adapter.
Service for handling inbound messages for a particular account
Builder for sending inbound messages (messages from external adapters) to the engage platform.
Message handler for inbound messages (messages from external adapters).
A routing service for inbound messages from the external adapters.
A service provider interface hooking in the business logic to extract or resolve the tenant id out of a new inbound message not yet been mapped to a user
account object.
Service responsible for providing the handlers for the different inbound handlers
for different external adapters.
Handler for inbound statuses from the external adapters
A type filter used to filter work objects with for custom indexing types.
A configuration for a single indexed field, contained within an
CustomIndexConfiguration.Implements the
IndexingHistoryJobProducer to create a new
HistoryJobEntity which is a copy of the one that is normally created.Indexing Filter related methods.
Variable type that can be used for storing variables within the index
Interface describing a container for all available
IndexVariableType(s).Initializes a newly created ticket conversation as a child of a desk conversation.
An in memory user subscription service.
Function for checking if a user is member of all groups.
Function for checking if a user is member in any group.
Function for checking if a user is not a member of any group.
A
TypeHandler that uses ObjectMapper to map the values into a String.Represents the joining type of a
Conversation which defines on how new participants can join a running
conversation.A data object holding the information about one or more participants to join a conversation at a specific time.
A
ModelFactory that supports the use of JsonNode in Freemarker templates.VariableIndexingFilter that only allows Variables without ByteArrayRefs
Configuration for the LDAP identity service.
LDAP properties for different group operations.
Some properties are allowed to be a
Collection, this means that this particular property
would come from one of those attributes.A provider for a tenant id for a group based on LDAP group
Attributes.A provider for a user definition key based on LDAP user
Attributes.A provider for the groups of a user.
LDAP properties for different user operations.
Some properties are allowed to be a
Collection, this means that this particular property
would come from one of those attributes.A provider for a tenant id for a user based on LDAP user
Attributes.An internal endpoint providing special type of accessing content send from Engage to LINE.
An API that can be implemented to provide the publicly accessible URLs for the media content that needs to be sent to LINE.
Adapts the wrapped
Iterable to be used in a Linq context.Exposes low-level indexing operations.
Used in conjunction with #addToCurrentBulkRequestAsFullIndexWithExternalVersion to define the logic for
creating the data for a new history job when a version conflict happens.
A low-level enhancer that gets called for each query result that is executed through the
SearchService.Type handler that maps
Map<String, Object> into a Clob as JSON.Master data entries might be cacheable, if sourced from an external system for performance or any other reason.
This interface defines the identity link types used for
MasterDataModels to define the capabilities / allowed features for the management of
master data.The master data parameter represents a parameter used to filter master data instances if they are depending on other values.
A single master data instance usually fetched through the
DataObjectRuntimeService and based on a DataObjectDefinition.Helper for creating a new Master data instance.
An Import Builder which allows importing master data instances in bulk from master data documents.
The query interface to create a query to search for master data instances.
Helper for updating a Master data instance.
The master data model contains all meta information for a single master data definition (type).
A master data source is used to fetch master data entries for one or more
DataObjectDefinitions.A list of predefined master data states like active and archived.
A filter which is going to remove the
matchingRequestParameter created by the
HttpSessionRequestCache.Filter to combine the
DefaultVariableIndexingFilter of models with the LargeVariableValueIndexingFilter
The LargeVariableValueIndexingFilter is only applied for DefaultVariableIndexingFilter with the DefaultVariableIndexingFilter.FilterType.EXCLUDE_MATCHING.The message object that holds all relevant data describing the
event, message, action, etc
The message builder API to create messages to be sent to a conversation using the
MessageBuilder.send(String) method within the builder.The interface you can implement when you want to enhance message compliance based search hit data.
The default message implementation.
The interface you can implement when you want to enhance message based search hit data.
A list of supported tags for messages.
Generic variable class that can be reused for V6 and V5 engine.
This interface might be implemented on an enumeration or instance based type to get a name from a type.
An abstract superclass for
Command implementations that want to verify the provided app is always active (ie.ELResolver creates new variables in the base VariableContainerELResolver which do not allows read/write access to unknown properties.Annotation indicating that a method should not be executed in strict mode.
A notification schema provider is calculating the set of notifications for each recipient of a data object within a
conversation depending on various input like conversation type, sub-type, tags, etc to determine whether to send
desk and / or mobile notifications and how to handle the badge count for unread messages.
Holder for the information required for sending a notification to the user.
Implementation of the
AuthTokenProvider that uses the OAuth2AuthorizedClientService to fetch an access
token for a clientRegistrationId.The DTO for outbound messages (messages send by the engage platform to the different external system implementations).
Handler that is invoked for specific user actions like creation, update, activation or deactivation and overrides the
default user persistence logic.
Provides an order pair of two values, also called a 2-tuple.
Checks whether the
VariableContainer is a ParentAwareVariableContainer
and uses this variable container to call the given enhancers.An intermediate representation of a DeploymentEntity which keeps track of all of the entity's and resources.
Holds the information for a single participant within a conversation or a recipient of a message.
A tag provider looking for participants being a member of certain groups and add tags accordingly.
Once you start joining a new participant to an existing conversation, there are a lot of options which can be set additionally using this builder API
which is returned with one of the join methods in the
ConversationParticipantBuilder API.Default implementation of the joining builder to define the exact time of when to join a set of participants.
A builder creates list of participants.
This enumeration contains the different types of participants within a conversation.
Groups all conversion methods together, as they are not consistent in Aspose.
Experimental
This interface contains the available permission (authorization) error codes available as templates within the template engine.
This utility helps creating template based permission (authorization) error messages.
This class holds the result of a permission evaluation based on a DMN model.
An enumeration containing the various outcomes of the default, DMN based conversation permissions.
This interface must be implemented by data objects supporting permissions.
A global service that can be used to invoke
PermissionService of different
scope type.Interface to be implemented by any object that wishes
to have access to the
PermissionServiceRegistry.Represents the type used for handling permissions within a
Conversation.A
PlanItemInstanceLifecycleListener implementation that creates an ActionInstance
when any plan item instance becomes enabled.A
PlanItemInstanceLifecycleListener implementation that removes an action instance when an enabled
PlanItemInstance in the ENABLED state is left.Represents a deployment that is already present in the query definition repository.
Annotation that can be used to trigger a deployment of query definitions for the provided test.
Builder for creating new deployments, similar to the action deployment builder.
Allows programmatic querying of
PlatformDeployments.JUnit Jupiter extension for the Flowable Platform engine and services initialization.
Deprecated.
use
insteadDeprecated.
JUnit Jupiter extension for the Flowable Platform idm engine and services initialization.
Implements callback methods to enhance the data before it gets indexed.
Marker interface to mark the base package for the Flowable Platform Services
A builder for the Platform user that can be used to set predefined properties or add some custom properties.
The interface you can implement when you want to enhance user based search hit data.
Annotation that can be used to trigger a deployment of policy definitions for the provided test.
Represents a deployment that is already present in the policy definition repository.
Builder for creating new deployments, similar to the policy deployment builder.
Allows programmatic querying of
PolicyDeployments.JUnit Jupiter extension for the Flowable Platform policy engine and services initialization.
Known presence states for the user.
The interface you can implement when you want to enhance process based search hit data.
This utility helps creating template based messages used within processes.
An abstract super class for
ContactFilter implementations that create a query programmatically.Contains a predefined set of available query sub types.
Contains a predefined set of available query types.
A
PlanItemInstanceLifecycleListener implementation that removes the ActionInstance
associated with reactivate event listener when the event listener is completed.A base Read Only implementation of the
PlatformIdentityService
that can be used for custom read only implementations.Manager that can be used to do a full reindex of an index.
Removes the assigned group from a conversation.
Removes the assigned user from a conversation.
Allows removing case assignee
Allows removing case owner
Contains the possible properties that can be used in a ContentItemQuery.
A tag provider which is adding the
ReplyOnAbsentTagProvider.TAG_REPLY_ON_ABSENT tag for DM conversations with client participation.Implementation of
AutoDeploymentStrategy
that performs a separate deployment for each set of Resources that share the same parent folder.
Encapsulates the logic for transparently working with
ActionResourceEntity .
Encapsulates the logic for transparently working with
DataObjectResourceEntity .
Encapsulates the logic for transparently working with ByteArrayEntity.
Encapsulates the logic for transparently working with
PolicyResourceEntity .
Encapsulates the logic for transparently working with
TemplateResourceEntity .MyBatis TypeHandler for
ResourceRef.Helper class for working with
ResponseEntity.Inbound Channel model for incoming REST requests.
Low-level enhancer for REST service invocations.
A global intern service that can be used to retrieve the form info for different scope types.
Resolves the scope token to either some ProcessInstance or CaseInstance
Known scopes for Flowable
Simple value object holding relevant information for script evaluation.
Special
EngineConfigurator for ScriptingEngineAwareEngineConfiguration configurations
which allows to get access to the ScriptingEngines instance after initialization (only if available).The script invoker is a service invoker based on either a groovy or juel script.
A script service invocation based response object holding the map of output parameters collected during script execution.
The Elasticsearch API's have a way of supporting paging for infinite scrolling tables
using the "search_after" parameter: https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after
This implementation will pass the searchAfter parameter, which needs to be provided on subsequent queries.
Groups utility methods related to permissions for searching.
Higher-level search client (vs the lower-level
ElasticsearchClient, that knows about index aliases and will apply them.Security scope that can be used for passing the needed security scope accessibility to the Java API.
Interface responsible for providing the security for a given principal.
This is the sequence generator used which uses the Sequence Definitions to configure itself and perform the formatting for the generated sequence.
An interface that is used for generating the next value for a sequence.
Annotation that can be used to trigger a deployment of service definitions for the provided test.
Builder for creating new deployments, similar to the service deployment builder.
Allows programmatic querying of
ServiceDeployments.The interface of a service output parameter used in a service definition.
JUnit Jupiter extension for the Flowable Platform service registry engine and services initialization.
A resolver used within the scripting engine context to resolve various services and variables within a scripting context.
The variable resolver factory being used in a script-based service invoker within the service registry, resolving various beans and services.
Sets or updates the referenced work item of a conversation using its id, type and optional definition id.
Function for setting a user info for a user.
Function for setting the state and sub state of a user
Usage:
Function for setting the state of a user
Usage:
Function for setting the sub state of a user
Usage:
(Very) simple implementation of the
ContentStorage that relies on the passed metadata to store content.Implementation of
AutoDeploymentStrategy
that performs a separate deployment for each resource by name.Helper for creating a new SLA audit instance.
A job handler handling SLA based due dates for tasks.
A job handler handling SLA based escalation steps for tasks.
MyBatis
LocalDate converter that uses the JDBC SQL Date, instead of getObject.A "standard Flowable query" in this context is a query that queries a certain index
with typical 'standard' Flowable concepts and related 'standard' data such as process/cases definitions, variables, etc.
A java representation of the configuration of a 'standard data query' model.
Contains an overview of all types of data supported in the filter of a standard data query.
The set of default parameters when working with a standard data query.
Wrapper classes to work more easily with the json values passed around for the standard data query.
This interfaces exists so that the logic of the AbstractPlatformSecurityService
can be injected into classes from the flowable-platrform-indexing module.
Standard built-in types of the data dictionary, like string, integer, double, etc.
This interface contains some standard message codes to be used for rendering template messages using
TemplateMessageUtil.Starts a new ticket conversation as part of a desk conversation.
A
ContextMapper that maps to the Full Distinguished nameType handler that maps
List<String> into a Clob as JSON.Type handler that maps
Set<String> into a Clob as JSON.Extracts BE expressions from the submitted variable names
Extract variable name, value pairs from the submitted values
Removes the current assignee of a ticket conversation and assigns it back to the desk team.
Switches the assignee of a ticket converrsation to a member of the desk team.
Similar to
UserDetailsService
with the difference that this passes the current authentication of the user performing the impersonation.This
HistoryManager will create HistoryJob's
that will only contain the id and type.A transformer that handles scopes: process instances, case instances and tasks.
A simple synchronization result object holding information about a master data entry synchronization action.
The common interface for all taggable objects like com.flowable.engage.conversation.api.Conversation
and com.flowable.engage.message.api.Message
Some utility functions around the tagging for conversations and messages.
The interface you can implement when you want to enhance task based search hit data.
This service handles the runtime change of a template or template definition with an optional change / approval process to be triggered.
The implementation of the the template change service able to change and deploy a change to a template or template variation at runtime with an optional
change process being triggered first.
A template definition can be used for any sort of template (e.g.
Annotation that can be used to trigger a deployment of action definitions for the provided test.
This exception is thrown, if a
TemplateDefinition could not be found.Represents a deployment that is already present in the template definition repository.
Builder for creating new deployments, similar to the action deployment builder.
Allows programmatic querying of
TemplateDeployments.The template engine configuration where you can access the different services.
JUnit Jupiter extension for the Flowable Platform template engine and services initialization.
A template holder is referencing (holding) all necessary information around a single template and variation with all necessary data.
The basic implementation for a template holder.
This utility helps creating template based standard messages.
A template definition can be used for any sort of template (e.g.
A single parameter definition used to describe the necessary payload when rendering a
TemplateVariationDefinition.A template processing result represents the result from a processed
TemplateVariationDefinition through a
TemplateProcessor.A template processor is used to process a
TemplateVariationDefinition and is typically registered / looked up
based on the type of a template returned by TemplateDefinition.getType().The template service is used to create and render content based on a
TemplateDefinition.The template service implements methods supporting the creation and rendering of
TemplateVariationModel.Contains a predefined set of available template types.
This template variation definition holds one single variation of a
TemplateDefinition for one combination of variants like language, country, etc.A freemarker based template loader loading template content based on a
TemplateVariationModel which
is loaded through the TemplateRepositoryService by its id which is passed in as the template name.A holder with a
TemplateVariationDefinition and
TemplateVariationModel.This template variation definition holds one single variation of a
TemplateDefinition for one combination of variants like language, country, etc.The request object for a template variation query supporting a search text.
A temporary message that is a copy of
Message
that is used when some messages should be handled separately.A handler of a
TemporaryMessage after all
TemporaryMessageProcessor(s) have run.A processor of a
TemporaryMessage which is invoked
during the async handling of the messages.Result for a processing of a temporary message.
A Log4J 2 converter that can be used to output the current tenant.
A Logback converter that can be used to output the currently authenticated user.
this class is only meant for internal ELResolver.
A utility class that can be used when writing tests.
An implementation of
ReindexRunnable that uses a threadpool to fetch pages of data from the database.Deprecated.
use
AccessTokenBuilder insteadDeprecated.
Query for querying translations.
A reference to another dictionary type.
Represents a reference to a specific type defined within a data dictionary.
Event listener which is responsible for updating the message counts for a conversation.
A generic indexing transformer that allows to do an update by query.
Helper for creating a new SLA audit instance.
The DTO used to update a template variation content.
A builder for the user account that can be used to update or create an UserAccount
Annotation that can be used to trigger a deployment of user account definitions for the provided test.
Builder for bulk registration of User Account Definitions.
An interface that can be used to provide base information for a given user.
A custom provider of
GrantedAuthority based on an id from a user definition.Annotation that can be used to trigger a deployment of user definitions for the provided test.
Builder for bulk registration of User Definitions.
Information that can be used in the REST API to ignore non defined variables
A
PlanItemInstanceLifecycleListener implementation that
creates an ActionInstance when a user event listener becomes active.A
PlanItemInstanceLifecycleListener implementation that removes the ActionInstance
associated with the user event listener when the user event listeners is completed.Handler that is invoked for specific user actions like creation, update, activation or deactivation.
Implements a bot managing user based action definitions.
The permission service that can used to check permissions on actions to be executed in the context of a user like deactivation, reactivation, etc.
The default permission service implementing permission checks in the context of a user.
This interface contains the available states for a
PlatformUser object.The user subscription service that can be used to query and update user subscriptions.
This interface contains some commonly used sub states for platform users as a more specialized state information.
Known platform user types.
Some utility function to parse values out of generic object values with null checking support mainly used within generic builders.
Filter allowing to decide whether a variable should be indexed or not.
Matches variable names against a list of patterns, either by exact match or with wildcards
supporting prefix and suffix matching.
Predefined set of content types for the variations.
A variation describes a single variation used for a
TemplateDefinition having multiple variations (e.g.ExternalSystemContentProvider that uses WebClient to fetch the external content.JMS listener that is used to receive inbound get access token message.
JMS listener that is used to receive inbound messages from a WeChat adapter over JMS.
Listeners that makes sure that the process for notifying conversations
JMS listener that is used to receive inbound get access token message.
An action bot handling the action definition to send a WeChat template message based on a template handled by the template engine.
Deprecated, for removal: This API element is subject to removal in a future version.
without an alternative, as the WhatsApp Cloud API does not support this and the On-Premise API is being sunset by Meta.
Deprecated.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated.
In order to understand this API better you need to be familiar with the WhatsApp
Sending Interactive Messages.
Builder for finishing building the Button message details and sending the message.
Builder for finishing building the List message details and sending the message.
Builder for building a list message section.
Builder for building a row in a section for list interactive messages.
A common interface for process and case definitions.
A common interface for runtime root process and case instances.
A common interface for root process and case instances.
Query used for querying process and case instances.
Query used for querying runtime process and case instances.
The interface you can implement when you want to enhance work based search hit data.
FlowableExpressionTimeUtilsinstead