Package org.cibseven.webapp.providers

Interface BpmProvider

public interface BpmProvider

Method Summary

Modifier and Type	Method	Description
default void	addGroupToTenant(String tenantId, String groupId, CIBUser user)
default void	addMemberToGroup(String groupId, String userId, CIBUser user)	Add user to a group.
default void	addMemberToTenant(String tenantId, String userId, CIBUser user)
default void	changeDueDate(String id, Map<String,Object> data, CIBUser user)
default Collection<Message>	correlateMessage(Map<String,Object> data, CIBUser user)	Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
default Long	countDeployments(CIBUser user, String nameLike)	Retrieves number of all deployments with provided query.
default Long	countHistoricIncident(Map<String,Object> params, CIBUser user)
default Long	countIncident(Map<String,Object> params, CIBUser user)
default Long	countProcessesInstancesHistory(Map<String,Object> filters, CIBUser user)
default Long	countProcessesInstancesRuntime(Map<String,Object> filters, CIBUser user)
default long	countUsers(Map<String,Object> filters, CIBUser user)	Get the count of users in the system with optional filters.
default org.springframework.http.ResponseEntity<Authorization>	createAuthorization(Authorization authorization, CIBUser user)	Create an authorization.
default Deployment	createDeployment(org.springframework.util.MultiValueMap<String,Object> data, org.springframework.web.multipart.MultipartFile[] files, CIBUser user)	Creates a new deployment using the Camunda REST API.
default Filter	createFilter(Filter filter, CIBUser user)	Create filter.
default void	createGroup(UserGroup group, CIBUser user)	Create a group.
default void	createIdentityLink(String taskId, Map<String,Object> data, CIBUser user)	Create identity links, e.g., to set the candidates user or groups of a task.
default void	createSetupUser(NewUser user, String engine)	Creates a new initial user assigned to the also created admin group.
default void	createTenant(Tenant tenant, CIBUser user)
default void	createUser(NewUser user, CIBUser flowUser)	Create a new user.
default void	deleteAuthorization(String authorizationId, CIBUser user)	Deletes an authorization by id.
default void	deleteBatch(String id, Map<String,Object> params, CIBUser user)
default void	deleteDeployment(String deploymentId, Boolean cascade, CIBUser user)	Delete deployment by an Id.
default void	deleteFilter(String filterId, CIBUser user)	Delete filter.
default void	deleteGroup(String groupId, CIBUser user)	Deletes a group by id.
default void	deleteGroupFromTenant(String tenantId, String groupId, CIBUser user)
default void	deleteHistoricBatch(String id, CIBUser user)
default Object	deleteHistoricDecisionInstances(Map<String,Object> data, CIBUser user)
default void	deleteIdentityLink(String taskId, Map<String,Object> data, CIBUser user)	Delete identity links, e.g., to remove the candidates user or groups of a task.
default void	deleteJob(String id, CIBUser user)
default void	deleteMemberFromGroup(String groupId, String userId, CIBUser user)	Delete user from a group.
default void	deleteMemberFromTenant(String tenantId, String userId, CIBUser user)
default void	deleteProcessDefinition(String id, Optional<Boolean> cascade, CIBUser user)
default void	deleteProcessInstance(String processInstanceId, CIBUser user)	Delete process instance by ID.
default void	deleteProcessInstanceFromHistory(String id, CIBUser user)
default void	deleteTenant(String tenantId, CIBUser user)
default void	deleteUser(String userId, CIBUser user)	Deletes a user by id.
default void	deleteVariable(String taskId, String variableName, CIBUser user)
default void	deleteVariableByExecutionId(String executionId, String variableName, CIBUser user)
default void	deleteVariableHistoryInstance(String id, CIBUser user)
default Deployment	deployBpmn(org.springframework.util.MultiValueMap<String,Object> data, org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> file, CIBUser user)	Deploy process-bpmn.
default Data	downloadBpmn(String processDefinitionId, String fileName, CIBUser user)	Download bpmn from a process definition id.
default Object	evaluateDecisionDefinitionById(String id, Map<String,Object> data, CIBUser user)
default Object	evaluateDecisionDefinitionByKey(Map<String,Object> data, String key, CIBUser user)
default Object	evaluateDecisionDefinitionByKeyAndTenant(Map<String,Object> data, String key, String tenant, CIBUser user)
default Collection<VariableHistory>	fetchActivityVariables(String activityInstanceId, CIBUser user)	Fetch variables from a specific activity.
default Collection<VariableHistory>	fetchActivityVariablesHistory(String activityInstanceId, CIBUser user)	Fetch variables from a specific activity.
default Data	fetchDataFromDeploymentResource(jakarta.servlet.http.HttpServletRequest rq, String deploymentId, String resourceId, String fileName, CIBUser user)	Retrieves the binary content of a deployment resource for the given deployment by id.
default ProcessDiagram	fetchDiagram(String processDefinitionId, CIBUser user)	Fetch process diagram, a xml that contains the specification to render the diagram.
default Map<String,Variable>	fetchFormVariables(String taskId, boolean deserializeValues, CIBUser user)
default Map<String,Variable>	fetchFormVariables(List<String> variableListName, String taskId, boolean deserializeValues, CIBUser user)
default Object	fetchHistoricActivityStatistics(String id, Map<String,Object> params, CIBUser user)	Fetch historic activity statistics for a given process definition ID.
default org.springframework.http.ResponseEntity<byte[]>	fetchHistoryVariableDataById(String id, CIBUser user)	Fetch a variable data in from the process history.
default Collection<Incident>	fetchIncidents(String processDefinitionKey, CIBUser user)	Fetch incidents for an specific process.
default Collection<Incident>	fetchIncidentsByInstanceAndActivityId(String processDefinitionKey, String activityId, CIBUser user)
default Map<String,Variable>	fetchProcessFormVariables(String key, boolean deserializeValues, CIBUser user)
default Map<String,Variable>	fetchProcessFormVariables(List<String> variableListName, String processDefinitionId, boolean deserializeValues, CIBUser user)
default Map<String,Variable>	fetchProcessFormVariablesById(String id, CIBUser user)
default Variable	fetchProcessInstanceVariable(String processInstanceId, String variableName, boolean deserializeValue, CIBUser user)	Required by OFDKA Retrieves a variable of a given process instance by id.
default org.springframework.http.ResponseEntity<byte[]>	fetchProcessInstanceVariableData(String processInstanceId, String variableName, CIBUser user)
default Collection<Variable>	fetchProcessInstanceVariables(String processInstanceId, Map<String,Object> data, CIBUser user)	Fetch a variables from a process instance.
default Collection<VariableHistory>	fetchProcessInstanceVariablesHistory(String processInstanceId, Map<String,Object> data, CIBUser user)	Fetch variables from a specific process instance.
default StartForm	fetchStartForm(String processDefinitionId, CIBUser user)	Fetch start-form to start a process
default Tenant	fetchTenant(String tenantId, CIBUser user)
default Collection<Tenant>	fetchTenants(Map<String,Object> queryParams, CIBUser user)
default Collection<SevenUser>	fetchUsers(CIBUser user)
default Variable	fetchVariable(String taskId, String variableName, boolean deserializeValue, CIBUser user)
default Variable	fetchVariableByProcessInstanceId(String processInstanceId, String variableName, CIBUser user)
default org.springframework.http.ResponseEntity<byte[]>	fetchVariableDataByExecutionId(String executionId, String variableName, CIBUser user)	Fetch a variable data in the Process Instance.
default NamedByteArrayDataSource	fetchVariableFileData(String taskId, String variableName, CIBUser user)
default List<ActivityInstanceHistory>	findActivitiesInstancesHistory(String processInstanceId, CIBUser user)	Search activities instances that belong to a process instance.
default List<ActivityInstanceHistory>	findActivitiesInstancesHistory(Map<String,Object> queryParams, CIBUser user)	Queries for historic activity instances that fulfill the given parameters.
default Collection<ActivityInstanceHistory>	findActivitiesProcessDefinitionHistory(String processDefinitionId, Map<String,Object> params, CIBUser user)
default ActivityInstance	findActivityInstance(String processInstanceId, CIBUser user)	Search activity that belong to a process instance.
default List<ActivityInstanceHistory>	findActivityInstanceHistory(String processInstanceId, CIBUser user)
default ActivityInstance	findActivityInstances(String processInstanceId, CIBUser user)
default Collection<Authorization>	findAuthorization(Optional<String> id, Optional<String> type, Optional<String> userIdIn, Optional<String> groupIdIn, Optional<String> resourceType, Optional<String> resourceId, Optional<String> sortBy, Optional<String> sortOrder, Optional<String> firstResult, Optional<String> maxResults, CIBUser user)	Get Authorization by id, ....
default Collection<Process>	findCalledProcessDefinitions(String processDefinitionId, CIBUser user)
default Collection<ProcessInstance>	findCurrentProcessesInstances(Map<String,Object> data, CIBUser user)	Search processes instances by filter.
default Deployment	findDeployment(String deploymentId, CIBUser user)	Retrieves all deployment resources of a given deployment.
default Collection<DeploymentResource>	findDeploymentResources(String deploymentId, CIBUser user)	Search deployment with a specific Id.
default Collection<Deployment>	findDeployments(CIBUser user, String nameLike, int firstResult, int maxResults, String sortBy, String sortOrder)	Retrieves all deployments matched with provided query.
default String	findExternalTaskErrorDetails(String externalTaskId, CIBUser user)
default Collection<Filter>	findFilters(CIBUser user)	Search filters.
default Collection<UserGroup>	findGroups(Optional<String> id, Optional<String> name, Optional<String> nameLike, Optional<String> type, Optional<String> member, Optional<String> memberOfTenant, Optional<String> sortBy, Optional<String> sortOrder, Optional<String> firstResult, Optional<String> maxResults, CIBUser user)	Get groups by id, ....
default String	findHistoricExternalTaskErrorDetails(String externalTaskId, CIBUser user)
default Collection<Incident>	findHistoricIncidents(Map<String,Object> params, CIBUser user)
default String	findHistoricStacktraceByJobId(String jobId, CIBUser user)
default HistoryProcessInstance	findHistoryProcessInstanceHistory(String processInstanceId, CIBUser user)	Search process instance with a specific process instance id.
default Integer	findHistoryTasksCount(Map<String,Object> filters, CIBUser user)
default Collection<IdentityLink>	findIdentityLink(String taskId, Optional<String> type, CIBUser user)	Identity links, e.g.
default Collection<Incident>	findIncident(Map<String,Object> params, CIBUser user)
default List<Incident>	findIncidentByInstanceId(String processInstanceId, CIBUser user)
default JobDefinition	findJobDefinition(String id, CIBUser user)
default Collection<JobDefinition>	findJobDefinitions(String params, CIBUser user)
default Process	findProcessByDefinitionKey(String key, String tenantId, CIBUser user)	Search process with a specific Key.
default Process	findProcessById(String id, Optional<Boolean> extraInfo, CIBUser user)	Search process with a specific Id.
default Collection<Process>	findProcesses(CIBUser user)	Search processes.
default Collection<ProcessInstance>	findProcessesInstances(String key, CIBUser user)	Search processes instances with a specific process key.
default Collection<HistoryProcessInstance>	findProcessesInstancesHistory(String key, Optional<Boolean> active, Integer firstResult, Integer maxResults, CIBUser user)	Search processes instances with a specific process key (in the history).
default Collection<HistoryProcessInstance>	findProcessesInstancesHistory(Map<String,Object> filters, Optional<Integer> firstResult, Optional<Integer> maxResults, CIBUser user)	Queries for historic process instances that fulfill the given parameters.
default Collection<HistoryProcessInstance>	findProcessesInstancesHistoryById(String id, Optional<String> activityId, Optional<Boolean> active, Integer firstResult, Integer maxResults, String text, CIBUser user)	Queries for historic process instances that fulfill the given parameters.
default Collection<HistoryProcessInstance>	findProcessesInstancesRuntime(Map<String,Object> data, Optional<Integer> firstResult, Optional<Integer> maxResults, CIBUser user)
default Collection<Process>	findProcessesWithFilters(String filters, CIBUser user)	Search processes.
default Collection<Process>	findProcessesWithInfo(CIBUser user)	Search processes with number of process instances and incidents.
default ProcessInstance	findProcessInstance(String processInstanceId, CIBUser user)	Required by OFDKA Search process instance with a specific process instance id.
default Collection<ProcessStatistics>	findProcessStatistics(String processId, CIBUser user)	Search statistics from a process.
default Collection<Process>	findProcessVersionsByDefinitionKey(String key, String tenantId, Optional<Boolean> lazyLoad, CIBUser user)	Search processes (diferents versions) with a specific Key.
default String	findStacktrace(String jobId, CIBUser user)
default Task	findTaskById(String taskId, CIBUser user)	Search task with a specific Id.
default Collection<Task>	findTasks(String filter, CIBUser user)	Search tasks, which contains specified filter.
default Collection<TaskHistory>	findTasksByDefinitionKeyHistory(String taskDefinitionKey, String processInstanceId, CIBUser user)	Search tasks which belongs to a specific process instance and filtered by a definition key.
default Collection<Task>	findTasksByFilter(TaskFiltering filters, String filterId, CIBUser user, Integer firstResult, Integer maxResults)	FindTask by filter
default Collection<Task>	findTasksByProcessInstance(String processInstanceId, CIBUser user)	Search tasks which belongs to a specific process instance.
default Collection<Task>	findTasksByProcessInstanceAsignee(Optional<String> processInstanceId, Optional<String> createdAfter, CIBUser user)	Search tasks which belongs to a specific process instance and a user.
default Collection<TaskHistory>	findTasksByProcessInstanceHistory(String processInstanceId, CIBUser user)	Search tasks which belongs to a specific process instance.
default Collection<TaskHistory>	findTasksByTaskIdHistory(String taskId, CIBUser user)
default Integer	findTasksCount(Map<String,Object> filters, CIBUser user)
default Integer	findTasksCountByFilter(String filterId, CIBUser user, TaskFiltering filters)	Find Tasks count by filter
default Collection<Task>	findTasksPost(Map<String,Object> data, CIBUser user)	Required by OFDKA Queries for tasks that fulfill a given filter.
default Collection<User>	findUsers(Optional<String> id, Optional<String> firstName, Optional<String> firstNameLike, Optional<String> lastName, Optional<String> lastNameLike, Optional<String> email, Optional<String> emailLike, Optional<String> memberOfGroup, Optional<String> memberOfTenant, Optional<String> idIn, Optional<String> firstResult, Optional<String> maxResults, Optional<String> sortBy, Optional<String> sortOrder, Optional<Boolean> likePatternIgnoreCase, CIBUser user)	Get users by id, ....
default Object	form(String taskId, CIBUser user)	Retrieves the form configuration data associated with a specific task.
default Object	formReference(String taskId, CIBUser user)	Fetch form-reference variable from task.
IActivityProvider	getActivityProvider()
default Collection<Batch>	getBatches(Map<String,Object> params, CIBUser user)
IBatchProvider	getBatchProvider()
default Collection<Batch>	getBatchStatistics(Map<String,Object> params, CIBUser user)
default Object	getCleanableBatchReport(Map<String,Object> queryParams, CIBUser user)
default Object	getCleanableBatchReportCount(CIBUser user)
default Decision	getDecisionDefinitionById(String id, Optional<Boolean> extraInfo, CIBUser user)
default Decision	getDecisionDefinitionByKey(String key, CIBUser user)
default Decision	getDecisionDefinitionByKeyAndTenant(String key, String tenant, CIBUser user)
default Collection<Decision>	getDecisionDefinitionList(Map<String,Object> queryParams, CIBUser user)
default Long	getDecisionDefinitionListCount(Map<String,Object> queryParams, CIBUser user)
IDecisionProvider	getDecisionProvider()
default Collection<Decision>	getDecisionVersionsByKey(String key, Optional<Boolean> lazyLoad, CIBUser user)
default EngineConfiguration	getDefaultEngineConfiguration()	Returns the configuration for the default BPM engine.
default org.springframework.http.ResponseEntity<byte[]>	getDeployedForm(String taskId, CIBUser user)
default org.springframework.http.ResponseEntity<byte[]>	getDeployedStartForm(String processDefinitionId, CIBUser user)
IDeploymentProvider	getDeploymentProvider()
default Object	getDiagramById(String id, CIBUser user)
default Object	getDiagramByKey(String key, CIBUser user)
default Object	getDiagramByKeyAndTenant(String key, String tenant, CIBUser user)
default EngineConfiguration	getEngineConfiguration(String engineName)	Returns the configuration for the BPM engine with the given name.
IEngineProvider	getEngineProvider()
default Collection<EventSubscription>	getEventSubscriptions(Optional<String> processInstanceId, Optional<String> eventType, Optional<String> eventName, CIBUser user)	Required by OFDKA Queries for event subscriptions that fulfill given parameters.
IExternalTaskProvider	getExternalTaskProvider()
default Collection<ExternalTask>	getExternalTasks(Map<String,Object> queryParams, CIBUser user)	Get external tasks based on query parameters
IFilterProvider	getFilterProvider()
default HistoryBatch	getHistoricBatchById(String id, CIBUser user)
default Long	getHistoricBatchCount(Map<String,Object> queryParams, CIBUser user)
default Collection<HistoryBatch>	getHistoricBatches(Map<String,Object> params, CIBUser user)
default HistoricDecisionInstance	getHistoricDecisionInstanceById(String id, Map<String,Object> queryParams, CIBUser user)
default Long	getHistoricDecisionInstanceCount(Map<String,Object> queryParams, CIBUser user)
default Collection<HistoricDecisionInstance>	getHistoricDecisionInstances(Map<String,Object> queryParams, CIBUser user)
default VariableHistory	getHistoricVariableInstance(String id, boolean deserializeValue, CIBUser user)	Retrieves a historic variable instance by its ID.
IHistoricVariableInstanceProvider	getHistoricVariableInstanceProvider()
default Collection<Object>	getHistoryJobLog(Map<String,Object> params, CIBUser user)
default String	getHistoryJobLogStacktrace(String id, CIBUser user)
IIdentityProvider	getIdentityProvider()
IIncidentProvider	getIncidentProvider()
IJobDefinitionProvider	getJobDefinitionProvider()
IJobProvider	getJobProvider()
default Collection<Job>	getJobs(Map<String,Object> params, CIBUser user)
default Collection<Metric>	getMetrics(Map<String,Object> queryParams, CIBUser user)
default Collection<Engine>	getProcessEngineNames()	Get the names of all process engines available on the engine.
IProcessProvider	getProcessProvider()
default Collection<ProcessStatistics>	getProcessStatistics(Map<String,Object> queryParams, CIBUser user)	Search statistics for all processes.
default org.springframework.http.ResponseEntity<String>	getRenderedForm(String taskId, Map<String,Object> params, CIBUser user)
default org.springframework.http.ResponseEntity<String>	getRenderedStartForm(String processDefinitionId, Map<String,Object> params, CIBUser user)
default Long	getRuntimeBatchCount(Map<String,Object> queryParams, CIBUser user)
ISystemProvider	getSystemProvider()
default Collection<CandidateGroupTaskCount>	getTaskCountByCandidateGroup(CIBUser user)
ITaskProvider	getTaskProvider()
default com.fasterxml.jackson.databind.JsonNode	getTelemetryData(CIBUser user)
ITenantProvider	getTenantProvider()
default Authorizations	getUserAuthorization(String userId, CIBUser user)	Get authorizations, filtered by userId and groups in which user belongs.
default SevenUser	getUserProfile(String userId, CIBUser user)	Get user by id.
IUserProvider	getUserProvider()
IUtilsProvider	getUtilsProvider()
default VariableInstance	getVariableInstance(String id, boolean deserializeValue, CIBUser user)	Retrieves a variable instance by its ID.
IVariableInstanceProvider	getVariableInstanceProvider()
IVariableProvider	getVariableProvider()
default Object	getXmlById(String id, CIBUser user)
default Object	getXmlByKey(String key, CIBUser user)
default Object	getXmlByKeyAndTenant(String key, String tenant, CIBUser user)
default void	handleBpmnError(String taskId, Map<String,Object> data, CIBUser user)	Reports a business error in the context of a running task by id.
default void	modifyVariableByExecutionId(String executionId, Map<String,Object> data, CIBUser user)	Modify a variable in the Process Instance.
default void	modifyVariableDataByExecutionId(String executionId, String variableName, org.springframework.web.multipart.MultipartFile data, String valueType, CIBUser user)	Modify a variable data in the Process Instance.
default void	overrideJobDefinitionPriority(String jobDefinitionId, String params, CIBUser user)
default void	putLocalExecutionVariable(String executionId, String varName, Map<String,Object> data, CIBUser user)
default void	recalculateDueDate(String id, Map<String,Object> params, CIBUser user)
default Deployment	redeployDeployment(String id, Map<String,Object> data, CIBUser user)	Redeploy an existing deployment.
default Boolean	requiresSetup(String engine)	Determine whether an initial user needs to be created
default void	retryExternalTask(String externalTaskId, Map<String,Object> data, CIBUser user)
default void	retryJobById(String jobId, Map<String,Object> data, CIBUser user)
default void	retryJobDefinitionById(String id, Map<String,Object> params, CIBUser user)
default void	saveVariableInProcessInstanceId(String processInstanceId, List<Variable> variables, CIBUser user)
default void	setAssignee(String taskId, String assignee, CIBUser user)	Set assignee to an specific task.
default void	setBatchSuspensionState(String id, Map<String,Object> params, CIBUser user)
default Object	setHistoricDecisionInstanceRemovalTime(Map<String,Object> data, CIBUser user)
default void	setIncidentAnnotation(String incidentId, Map<String,Object> data, CIBUser user)
default Object	setRemovalTime(Map<String,Object> payload, CIBUser user)
default void	setSuspended(String id, Map<String,Object> params, CIBUser user)
default ProcessStart	startProcess(String processDefinitionKey, String tenantId, Map<String,Object> data, CIBUser user)	Start process.
default void	submit(String taskId, String formResult, CIBUser user)	Submits a task form to the process engine.
default void	submit(String taskId, CIBUser user)	Submit task without saving any variables, because that is done by the ui-element-template (in ours).
default void	submit(Task task, List<Variable> formResult, CIBUser user)	Submit task without saving any variables, because that is done by the ui-element-template (in ours).
default ProcessStart	submitForm(String processDefinitionKey, String tenantId, Map<String,Object> data, CIBUser user)	Submit form with variables.
default ProcessStart	submitForm(String processDefinitionId, String formResult, CIBUser user)	Submit a form to start a process with the given process definition id.
default ProcessStart	submitStartFormVariables(String processDefinitionId, List<Variable> formResult, CIBUser user)
default void	submitVariables(String processInstanceId, List<Variable> formResult, CIBUser user, String processDefinitionId)
default void	suspendJobDefinition(String jobDefinitionId, String params, CIBUser user)
default void	suspendProcessDefinition(String processDefinitionId, Boolean suspend, Boolean includeProcessInstances, String executionDate, CIBUser user)	Activate/Suspend process instance by ID.
default void	suspendProcessInstance(String processInstanceId, Boolean suspend, CIBUser user)	Activate/Suspend process instance by ID.
default void	update(Task task, CIBUser user)	Update task.
default void	updateAuthorization(String authorizationId, Map<String,Object> data, CIBUser user)	Update an authorization by id.
default void	updateFilter(Filter filter, CIBUser user)	Update filter.
default void	updateGroup(String groupId, UserGroup group, CIBUser user)	Updates a group.
default void	updateHistoryTimeToLive(String id, Map<String,Object> data, CIBUser user)
default void	updateHistoryTTLById(String id, Map<String,Object> data, CIBUser user)
default void	updateHistoryTTLByKey(Map<String,Object> data, String key, CIBUser user)
default void	updateHistoryTTLByKeyAndTenant(Map<String,Object> data, String key, String tenant, CIBUser user)
default void	updateTenant(Tenant tenant, CIBUser user)
default void	updateUserCredentials(String userId, Map<String,Object> data, CIBUser user)	Updates a user’s credentials (password).
default void	updateUserProfile(String userId, User user, CIBUser flowUser)	Updates a user’s profile.
default void	uploadProcessInstanceVariableFileData(String processInstanceId, String variableName, org.springframework.web.multipart.MultipartFile data, String valueType, CIBUser user)
default void	uploadVariableFileData(String taskId, String variableName, org.springframework.web.multipart.MultipartFile data, String valueType, CIBUser user)
default PasswordPolicyResponse	validatePasswordPolicy(PasswordPolicyRequest request)
default SevenVerifyUser	verifyUser(org.cibseven.webapp.auth.rest.StandardLogin login, CIBUser user)

Method Details

getDeploymentProvider

IDeploymentProvider getDeploymentProvider()

getVariableProvider

IVariableProvider getVariableProvider()

getVariableInstanceProvider

IVariableInstanceProvider getVariableInstanceProvider()

getHistoricVariableInstanceProvider

IHistoricVariableInstanceProvider getHistoricVariableInstanceProvider()

getTaskProvider

ITaskProvider getTaskProvider()

getProcessProvider

IProcessProvider getProcessProvider()

getActivityProvider

IActivityProvider getActivityProvider()

getFilterProvider

IFilterProvider getFilterProvider()

getUtilsProvider

IUtilsProvider getUtilsProvider()

getIncidentProvider

IIncidentProvider getIncidentProvider()

getJobDefinitionProvider

IJobDefinitionProvider getJobDefinitionProvider()

getUserProvider

IUserProvider getUserProvider()

getDecisionProvider

IDecisionProvider getDecisionProvider()

getJobProvider

IJobProvider getJobProvider()

getBatchProvider

IBatchProvider getBatchProvider()

getSystemProvider

ISystemProvider getSystemProvider()

getTenantProvider

ITenantProvider getTenantProvider()

getExternalTaskProvider

IExternalTaskProvider getExternalTaskProvider()

getEngineProvider

IEngineProvider getEngineProvider()

getIdentityProvider

IIdentityProvider getIdentityProvider()

findTasksCount

default Integer findTasksCount(Map<String,Object> filters,
 CIBUser user)
                        throws SystemException

Throws:

SystemException

findTasksByProcessInstance

default Collection<Task> findTasksByProcessInstance(String processInstanceId,
 CIBUser user)
                                             throws SystemException

Search tasks which belongs to a specific process instance.

Parameters:

processInstanceId - filter by process instance id.

user - the user performing the search

Returns:

Fetched tasks.

Throws:

SystemException - in case of an error.

findTasksByProcessInstanceAsignee

default Collection<Task> findTasksByProcessInstanceAsignee(Optional<String> processInstanceId,
 Optional<String> createdAfter,
 CIBUser user)
                                                    throws SystemException

Search tasks which belongs to a specific process instance and a user.

Parameters:

processInstanceId - filter by process instance id.

createdAfter - filter by creation date.

user - the user performing the search

Returns:

Fetched tasks.

Throws:

SystemException - in case of an error.

findTaskById

default Task findTaskById(String taskId,
 CIBUser user)
                   throws SystemException

Search task with a specific Id.

Parameters:

taskId - filter by task id.

user - the user performing the search

Returns:

Fetched task.

Throws:

NoObjectFoundException - when the task searched for could not be found.

SystemException - in case of any other error.

update

default void update(Task task,
 CIBUser user)
             throws SystemException

Update task.

Parameters:

task - to be updated with the desired values already modified.

user - the user performing the update

Throws:

SystemException - in case of an error.

setAssignee

default void setAssignee(String taskId,
 String assignee,
 CIBUser user)
                  throws SystemException

Set assignee to an specific task.

Parameters:

taskId - filter by task id.

assignee - to be set as assignee.

user - the user performing the update

Throws:

SystemException - in case of an error.

submit

default void submit(String taskId,
 CIBUser user)
             throws SystemException,
SubmitDeniedException

Submit task without saving any variables, because that is done by the ui-element-template (in ours).

Parameters:

taskId - the ID of the task to be submitted.

user - the user performing the submission.

Throws:

SubmitDeniedException - when trying to submit a non-existing task.

SystemException - in case of any other error.

submit

default void submit(Task task,
 List<Variable> formResult,
 CIBUser user)
             throws SystemException,
SubmitDeniedException

Submit task without saving any variables, because that is done by the ui-element-template (in ours).

Parameters:

taskId - the ID of the task to be submitted.

user - the user performing the submission.

Throws:

SubmitDeniedException - when trying to submit a non-existing task.

SystemException - in case of any other error.

submit

default void submit(String taskId,
 String formResult,
 CIBUser user)
             throws NoObjectFoundException,
SystemException

Submits a task form to the process engine.

Parameters:

taskId - the id of the task the form belongs to

formResult - serialized form payload (usually JSON) to be submitted

user - the user performing the operation

Throws:

SystemException - in case of an error

NoObjectFoundException

formReference

default Object formReference(String taskId,
 CIBUser user)
                      throws SystemException

Fetch form-reference variable from task.

Parameters:

taskId - filter by task id.

user - the user performing the search

Returns:

form-reference

Throws:

NoObjectFoundException - when the searched task could not be found.

SystemException - in case of any other error.

form

default Object form(String taskId,
 CIBUser user)
             throws SystemException

Retrieves the form configuration data associated with a specific task.

Parameters:

taskId - filter by task id.

user - the user performing the search

Returns:

TaskForm object containing key, camundaFormRef, and contextPath

Throws:

NoObjectFoundException - when the searched task could not be found.

SystemException - in case of any other error.

findTasksByFilter

default Collection<Task> findTasksByFilter(TaskFiltering filters,
 String filterId,
 CIBUser user,
 Integer firstResult,
 Integer maxResults)
                                    throws SystemException

FindTask by filter

Parameters:

filters - list of properties which will be use to filter tasks.

filterId - to filter task.

firstResult - index of the first result to return.

maxResults - maximum number of results to return.

user - since this call is secured we need the user to authenticate.

Returns:

Collection of Tasks fetched in the search.

Throws:

SystemException - in case of an error.

findTasksCountByFilter

default Integer findTasksCountByFilter(String filterId,
 CIBUser user,
 TaskFiltering filters)
                                throws SystemException

Find Tasks count by filter

Parameters:

filterId - to filter task.

filters - list of properties which will be use to filter tasks.

user - since this call is secured we need the user to authenticate.

Returns:

Collection of Tasks fetched in the search.

Throws:

SystemException - in case of an error.

findTasksByProcessInstanceHistory

default Collection<TaskHistory> findTasksByProcessInstanceHistory(String processInstanceId,
 CIBUser user)
                                                           throws SystemException

Search tasks which belongs to a specific process instance. The tasks found belongs to the history, they have other attributes and finished tasks are also fetched.

Parameters:

processInstanceId - filter by process instance id.

user - the user performing the search

Returns:

Fetched tasks.

Throws:

SystemException - in case of an error.

findTasksByDefinitionKeyHistory

default Collection<TaskHistory> findTasksByDefinitionKeyHistory(String taskDefinitionKey,
 String processInstanceId,
 CIBUser user)
                                                         throws SystemException

Search tasks which belongs to a specific process instance and filtered by a definition key. The tasks found belongs to the history, they have other attributes and finished tasks are also fetched.

Parameters:

processInstanceId - filter by process instance id.

taskDefinitionKey - restrict to tasks that have the given key.

user - the user performing the search

Returns:

Fetched tasks.

Throws:

SystemException - in case of an error.

findTasksPost

default Collection<Task> findTasksPost(Map<String,Object> data,
 CIBUser user)
                                throws SystemException

Required by OFDKA Queries for tasks that fulfill a given filter. This method is slightly more powerful than the Get Tasks method because it allows filtering by multiple process or task variables of types String, Number or Boolean.

Parameters:

data - variables to apply search.

user - the user performing the search.

Returns:

Collection tasks fetched in the search.

Throws:

SystemException - in case of an error.

findIdentityLink

default Collection<IdentityLink> findIdentityLink(String taskId,
 Optional<String> type,
 CIBUser user)

Identity links, e.g. to get the candidates user or groups of a task.

Parameters:

taskId - the ID of the task.

type - Filter by the type of links to include. e.g. "candidate".

user - the user performing the query.

Returns:

Collection of Identity Links.

createIdentityLink

default void createIdentityLink(String taskId,
 Map<String,Object> data,
 CIBUser user)
                         throws SystemException

Create identity links, e.g., to set the candidates user or groups of a task.

Parameters:

taskId - the ID of the task.

data - a map containing the type of the identity link and group or user ID.

user - the user performing the operation.

Throws:

SystemException - in case of any other error.

deleteIdentityLink

default void deleteIdentityLink(String taskId,
 Map<String,Object> data,
 CIBUser user)
                         throws SystemException

Delete identity links, e.g., to remove the candidates user or groups of a task.

Parameters:

taskId - the ID of the task.

type - a map containing the type of the identity link to be removed.

user - the user performing the operation.

Throws:

SystemException - in case of any other error.

handleBpmnError

default void handleBpmnError(String taskId,
 Map<String,Object> data,
 CIBUser user)
                      throws SystemException

Reports a business error in the context of a running task by id. The error code must be specified to identify the BPMN error handler.

Parameters:

taskId - filter by task id.

data - variables for the BPMN error reporting.

user - the user performing the operation.

Throws:

SystemException - in case of any other error.

findTasksByTaskIdHistory

default Collection<TaskHistory> findTasksByTaskIdHistory(String taskId,
 CIBUser user)
                                                  throws SystemException

Throws:

SystemException

getDeployedForm

default org.springframework.http.ResponseEntity<byte[]> getDeployedForm(String taskId,
 CIBUser user)
                                                                 throws SystemException

Throws:

SystemException

getRenderedForm

default org.springframework.http.ResponseEntity<String> getRenderedForm(String taskId,
 Map<String,Object> params,
 CIBUser user)

findHistoryTasksCount

default Integer findHistoryTasksCount(Map<String,Object> filters,
 CIBUser user)
                               throws SystemException

Throws:

SystemException

getTaskCountByCandidateGroup

default Collection<CandidateGroupTaskCount> getTaskCountByCandidateGroup(CIBUser user)

findTasks

default Collection<Task> findTasks(String filter,
 CIBUser user)
                            throws SystemException

Search tasks, which contains specified filter.

Parameters:

filter - applied in the search

user - the user performing the search

Returns:

Collection tasks fetched in the search.

Throws:

SystemException - in case of an error.

findFilters

default Collection<Filter> findFilters(CIBUser user)
                                throws SystemException

Search filters.

Parameters:

user - the user performing the query.

Returns:

Collection of Filters fetched in the search.

Throws:

SystemException - in case of an error.

createFilter

default Filter createFilter(Filter filter,
 CIBUser user)
                     throws SystemException

Create filter.

Parameters:

filter - to be created.

user - the user performing the creation.

Throws:

SystemException - in case of an error.

updateFilter

default void updateFilter(Filter filter,
 CIBUser user)
                   throws SystemException,
NoObjectFoundException

Update filter.

Parameters:

filter - to be updated.

user - the user performing the update.

Throws:

NoObjectFoundException - when the filter to be changed could not be found.

SystemException - in case of any other error.

deleteFilter

default void deleteFilter(String filterId,
 CIBUser user)
                   throws SystemException

Delete filter.

Parameters:

filterId - the ID of the filter to be deleted.

user - the user performing the deletion.

Throws:

SystemException - in case of an error.

deployBpmn

default Deployment deployBpmn(org.springframework.util.MultiValueMap<String,Object> data,
 org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> file,
 CIBUser user)
                       throws SystemException

Deploy process-bpmn.

Parameters:

data - metadata of the diagram to be deployed (deployment-name, deployment-source, deploy-changed-only).

file - of the diagram to be deployed.

user - the user performing the deployment.

Returns:

Deployment information.

Throws:

SystemException - in case of any other error.

countDeployments

default Long countDeployments(CIBUser user,
 String nameLike)
                       throws SystemException

Retrieves number of all deployments with provided query.

Parameters:

user - the user performing the search.

Returns:

Fetched deployments.

Throws:

SystemException - in case of any other error.

findDeployments

default Collection<Deployment> findDeployments(CIBUser user,
 String nameLike,
 int firstResult,
 int maxResults,
 String sortBy,
 String sortOrder)
                                        throws SystemException

Retrieves all deployments matched with provided query.

Parameters:

user - the user performing the search.

Returns:

Fetched deployments.

Throws:

SystemException - in case of any other error.

findDeployment

default Deployment findDeployment(String deploymentId,
 CIBUser user)
                           throws SystemException

Retrieves all deployment resources of a given deployment.

Parameters:

deploymentId - the ID of the deployment.

user - the user performing the query.

Returns:

Fetched deployment resources.

Throws:

SystemException - in case of any other error.

findDeploymentResources

default Collection<DeploymentResource> findDeploymentResources(String deploymentId,
 CIBUser user)
                                                        throws SystemException

Search deployment with a specific Id.

Parameters:

deploymentId - the ID of the deployment.

Returns:

Fetched deployment.

Throws:

SystemException - in case of any other error.

fetchDataFromDeploymentResource

default Data fetchDataFromDeploymentResource(jakarta.servlet.http.HttpServletRequest rq,
 String deploymentId,
 String resourceId,
 String fileName,
 CIBUser user)
                                      throws SystemException

Retrieves the binary content of a deployment resource for the given deployment by id.

Parameters:

rq - the HTTP request.

deploymentId - the ID of the deployment.

resourceId - the ID of the resource.

fileName - the name of the file.

user - the authenticated user.

Returns:

resource data.

Throws:

SystemException - in case of any other error.

deleteDeployment

default void deleteDeployment(String deploymentId,
 Boolean cascade,
 CIBUser user)
                       throws SystemException

Delete deployment by an Id.

Parameters:

deploymentId - the ID of the deployment.

cascade - whether to cascade the deletion.

user - the user performing the deletion.

Throws:

SystemException - in case of any other error.

createDeployment

default Deployment createDeployment(org.springframework.util.MultiValueMap<String,Object> data,
 org.springframework.web.multipart.MultipartFile[] files,
 CIBUser user)
                             throws SystemException

Creates a new deployment using the Camunda REST API.

Parameters:

data - the deployment parameters (deployment-name, deployment-source, tenant-id, etc.)

files - the files to deploy (DMN, BPMN, etc.)

user - the user creating the deployment

Returns:

the created deployment

Throws:

SystemException - in case of an error

redeployDeployment

default Deployment redeployDeployment(String id,
 Map<String,Object> data,
 CIBUser user)
                               throws SystemException

Redeploy an existing deployment. For every contained decision or process definition a new version will be created.

Parameters:

id - the ID of the deployment to redeploy

data - the redeployment parameters (tenantId, source, resourceIds, resourceNames)

user - the user performing the redeployment

Returns:

the newly created deployment

Throws:

SystemException - in case of an error

findActivityInstance

default ActivityInstance findActivityInstance(String processInstanceId,
 CIBUser user)
                                       throws SystemException,
NoObjectFoundException

Search activity that belong to a process instance.

Parameters:

processInstanceId - filter by process instance id.

user - the user performing the search

Returns:

Fetched activity.

Throws:

NoObjectFoundException - when the searched process instance could not be found.

SystemException - in case of any other error.

findActivitiesInstancesHistory

default List<ActivityInstanceHistory> findActivitiesInstancesHistory(Map<String,Object> queryParams,
 CIBUser user)
                                                              throws SystemException,
InvalidAttributeValueException

Queries for historic activity instances that fulfill the given parameters. The activities found belong to the history.

Parameters:

queryParams - a map of parameters to filter the query.

user - the user performing the query.

Returns:

Fetched Historic Activity Instances.

Throws:

InvalidAttributeValueException - when the tenant of a task could not be changed or when the delegation state of a task should be changed to an invalid value.

SystemException - in case of any other error.

findActivitiesInstancesHistory

default List<ActivityInstanceHistory> findActivitiesInstancesHistory(String processInstanceId,
 CIBUser user)
                                                              throws SystemException,
InvalidAttributeValueException

Search activities instances that belong to a process instance. The activities found belongs to the history, they have other attributes and activities from finished processes are also fetched.

Parameters:

processInstanceId - filter by process instance id.

user - the user performing the search

Returns:

Fetched Activity Instance.

Throws:

InvalidAttributeValueException - when the tenant of a task could not be changed or when the delegation state of a task should be changed to an invalid value.

SystemException - in case of any other error.

findActivityInstances

default ActivityInstance findActivityInstances(String processInstanceId,
 CIBUser user)
                                        throws SystemException

Throws:

SystemException

findActivityInstanceHistory

default List<ActivityInstanceHistory> findActivityInstanceHistory(String processInstanceId,
 CIBUser user)
                                                           throws SystemException

Throws:

SystemException

deleteVariableByExecutionId

default void deleteVariableByExecutionId(String executionId,
 String variableName,
 CIBUser user)

deleteVariableHistoryInstance

default void deleteVariableHistoryInstance(String id,
 CIBUser user)

findActivitiesProcessDefinitionHistory

default Collection<ActivityInstanceHistory> findActivitiesProcessDefinitionHistory(String processDefinitionId,
 Map<String,Object> params,
 CIBUser user)

getUserAuthorization

default Authorizations getUserAuthorization(String userId,
 CIBUser user)
                                     throws SystemException

Get authorizations, filtered by userId and groups in which user belongs.

Parameters:

userId - filter user identification (username).

user - the user performing the search

Returns:

Fetched bpmn

Throws:

SystemException - in case of an error.

fetchUsers

default Collection<SevenUser> fetchUsers(CIBUser user)
                                  throws SystemException

Throws:

SystemException

verifyUser

default SevenVerifyUser verifyUser(org.cibseven.webapp.auth.rest.StandardLogin login,
 CIBUser user)
                            throws SystemException

Parameters:

username - login user

password - login password

user - the calling user

Returns:

verification

Throws:

SystemException

findUsers

default Collection<User> findUsers(Optional<String> id,
 Optional<String> firstName,
 Optional<String> firstNameLike,
 Optional<String> lastName,
 Optional<String> lastNameLike,
 Optional<String> email,
 Optional<String> emailLike,
 Optional<String> memberOfGroup,
 Optional<String> memberOfTenant,
 Optional<String> idIn,
 Optional<String> firstResult,
 Optional<String> maxResults,
 Optional<String> sortBy,
 Optional<String> sortOrder,
 Optional<Boolean> likePatternIgnoreCase,
 CIBUser user)

Get users by id, ....

Parameters:

id - , // Filter by the id of the user.

firstName - , // Filter by the firstname of the user.

firstNameLike - , // Filter by the firstname that the parameter is a substring of.

lastName - , // Filter by the lastname of the user.

lastNameLike - , // Filter by the lastname that the parameter is a substring of.

email - , // Filter by the email of the user.

emailLike - , // Filter by the email that the parameter is a substring of.

memberOfGroup - , // Filter for users which are members of the given group.

memberOfTenant - , // Filter for users which are members of the given tenant.

user - CIBSevenUser

Returns:

Collection of Users.

countUsers

default long countUsers(Map<String,Object> filters,
 CIBUser user)

Get the count of users in the system with optional filters.

Parameters:

filters - the filters to apply (e.g., memberOfGroup). Can be null or empty for no filtering.

user - the user performing the operation.

Returns:

the count of users matching the filters.

createUser

default void createUser(NewUser user,
 CIBUser flowUser)
                 throws InvalidUserIdException

Create a new user.

Parameters:

user - the new user to be created.

flowUser - the user performing the creation.

Throws:

InvalidUserIdException - when the user ID is invalid.

updateUserProfile

default void updateUserProfile(String userId,
 User user,
 CIBUser flowUser)

Updates a user’s profile.

Parameters:

userId - the ID of the user to be updated.

user - the user to Update.

flowUser - the user performing the update.

updateUserCredentials

default void updateUserCredentials(String userId,
 Map<String,Object> data,
 CIBUser user)

Updates a user’s credentials (password).

Parameters:

userId - the ID of the user to be updated.

data - Request Body A JSON object with the following properties: Name Type Description password String The user's new password. authenticatedUserPassword String The password of the authenticated user who changes the password of the user (i.e., the user with passed id as path parameter).

user - the user performing the update.

findGroups

default Collection<UserGroup> findGroups(Optional<String> id,
 Optional<String> name,
 Optional<String> nameLike,
 Optional<String> type,
 Optional<String> member,
 Optional<String> memberOfTenant,
 Optional<String> sortBy,
 Optional<String> sortOrder,
 Optional<String> firstResult,
 Optional<String> maxResults,
 CIBUser user)

Get groups by id, ....

Parameters:

id - // Filter by the id of the group.

name - // Filter by the name of the group.

nameLike - // Filter by the name that the parameter is a substring of.

type - // Filter by the type of the group.

member - // Only retrieve groups which the given user id is a member of.

memberOfTenant - // Only retrieve groups which are members of the given tenant.

sortBy - // Sort the results lexicographically by a given criterion. Valid values are id, name and type. Must be used in conjunction with the sortOrder parameter.

sortOrder - // Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResult - // Pagination of results. Specifies the index of the first result to return.

maxResults - // Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

user - the user performing the search.

Returns:

Collection of User Groups.

createGroup

default void createGroup(UserGroup group,
 CIBUser user)

Create a group.

Parameters:

group - the group to be created.

user - the user performing the creation.

updateGroup

default void updateGroup(String groupId,
 UserGroup group,
 CIBUser user)

Updates a group.

Parameters:

groupId - the ID of the group to be updated.

group - the group to be updated.

user - the user performing the update.

deleteGroup

default void deleteGroup(String groupId,
 CIBUser user)

Deletes a group by id.

Parameters:

groupId - the ID of the group to be deleted.

user - the user performing the deletion.

findAuthorization

default Collection<Authorization> findAuthorization(Optional<String> id,
 Optional<String> type,
 Optional<String> userIdIn,
 Optional<String> groupIdIn,
 Optional<String> resourceType,
 Optional<String> resourceId,
 Optional<String> sortBy,
 Optional<String> sortOrder,
 Optional<String> firstResult,
 Optional<String> maxResults,
 CIBUser user)

Get Authorization by id, ....

Parameters:

id - // Filter by the id.

type - // Filter by authorization type. (0=global, 1=grant, 2=revoke). See the User Guide for more information about authorization types.

userIdIn - // Filter by a comma-separated list of userIds.

groupIdIn - // Filter by a comma-separated list of groupIds.

resourceType - // Filter by an integer representation of the resource type. See the User Guide for a list of integer representations of resource types.

resourceId - // Filter by resource id. * @param sortBy, // Sort the results lexicographically by a given criterion. Valid values are id, name and type. Must be used in conjunction with the sortOrder parameter.

sortBy - // Sort the results lexicographically by a given criterion. Valid values are id, name and type. Must be used in conjunction with the sortOrder parameter.

sortOrder - // Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResult - // Pagination of results. Specifies the index of the first result to return.

maxResults - // Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

user - the user performing the search.

Returns:

Collection of Authorizations.

createAuthorization

default org.springframework.http.ResponseEntity<Authorization> createAuthorization(Authorization authorization,
 CIBUser user)

Create an authorization.

Parameters:

authorization - the authorization to be created.

user - the user performing the creation.

Returns:

ResponseEntity containing the created authorization.

updateAuthorization

default void updateAuthorization(String authorizationId,
 Map<String,Object> data,
 CIBUser user)

Update an authorization by id.

Parameters:

authorizationId - the ID of the authorization to be updated.

data - the data to update.

user - the user performing the update.

deleteAuthorization

default void deleteAuthorization(String authorizationId,
 CIBUser user)

Deletes an authorization by id.

Parameters:

authorizationId - the ID of the authorization to be deleted.

user - the user performing the deletion.

modifyVariableByExecutionId

default void modifyVariableByExecutionId(String executionId,
 Map<String,Object> data,
 CIBUser user)
                                  throws SystemException

Modify a variable in the Process Instance.

Parameters:

executionId - Id of the execution.

data - to be updated.

user - User who is modifying the variable.

Throws:

SystemException - in case of any other error.

modifyVariableDataByExecutionId

default void modifyVariableDataByExecutionId(String executionId,
 String variableName,
 org.springframework.web.multipart.MultipartFile data,
 String valueType,
 CIBUser user)
                                      throws SystemException

Modify a variable data in the Process Instance.

Parameters:

executionId - the ID of the execution.

variableName - the name of the variable.

data - the file containing the data to be updated.

valueType - the type of the variable. Enum with the possible values: "File", "Bytes".

user - the user modifying the variable.

Throws:

SystemException - in case of any other error.

fetchProcessInstanceVariables

default Collection<Variable> fetchProcessInstanceVariables(String processInstanceId,
 Map<String,Object> data,
 CIBUser user)
                                                    throws NoObjectFoundException,
SystemException

Fetch a variables from a process instance.

Parameters:

processInstanceId - Id of the instance.

data - a map of parameters to filter the query.

user - User who is fetching the variables.

Returns:

Data.

Throws:

SystemException - in case of any other error.

NoObjectFoundException

fetchVariableDataByExecutionId

default org.springframework.http.ResponseEntity<byte[]> fetchVariableDataByExecutionId(String executionId,
 String variableName,
 CIBUser user)
                                                                                throws NoObjectFoundException,
SystemException

Fetch a variable data in the Process Instance.

Parameters:

executionId - Id of the execution.

variableName - Name of the variable.

user - User who is fetching the variable.

Returns:

Data.

Throws:

SystemException - in case of any other error.

NoObjectFoundException

fetchHistoryVariableDataById

default org.springframework.http.ResponseEntity<byte[]> fetchHistoryVariableDataById(String id,
 CIBUser user)
                                                                              throws NoObjectFoundException,
SystemException

Fetch a variable data in from the process history.

Parameters:

id - Id of the variable.

user - User who is modifying the variable.

Returns:

Data.

Throws:

SystemException - in case of any other error.

NoObjectFoundException

fetchProcessInstanceVariablesHistory

default Collection<VariableHistory> fetchProcessInstanceVariablesHistory(String processInstanceId,
 Map<String,Object> data,
 CIBUser user)
                                                                  throws SystemException

Fetch variables from a specific process instance. The variables found belong to the history, they have other attributes, and variables from finished process instances are also fetched.

Parameters:

processInstanceId - filter by process instance id.

data - a map of parameters to filter the query.

user - the user performing the search

Returns:

Fetched variables.

Throws:

SystemException - in case of an error.

fetchActivityVariablesHistory

default Collection<VariableHistory> fetchActivityVariablesHistory(String activityInstanceId,
 CIBUser user)
                                                           throws SystemException

Fetch variables from a specific activity. The variables found belongs to the history, they have other attributes and variables from finished activities are also fetched.

Parameters:

activityInstanceId - filter by activity instance id.

user - the user performing the search

Returns:

Fetched variables.

Throws:

SystemException - in case of an error.

fetchActivityVariables

default Collection<VariableHistory> fetchActivityVariables(String activityInstanceId,
 CIBUser user)
                                                    throws SystemException

Fetch variables from a specific activity.

Parameters:

activityInstanceId - filter by activity instance id.

user - the user performing the search

Returns:

Fetched variables.

Throws:

SystemException - in case of an error.

fetchVariable

default Variable fetchVariable(String taskId,
 String variableName,
 boolean deserializeValue,
 CIBUser user)
                        throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

deleteVariable

default void deleteVariable(String taskId,
 String variableName,
 CIBUser user)
                     throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

fetchFormVariables

default Map<String,Variable> fetchFormVariables(String taskId,
 boolean deserializeValues,
 CIBUser user)
                                         throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

fetchFormVariables

default Map<String,Variable> fetchFormVariables(List<String> variableListName,
 String taskId,
 boolean deserializeValues,
 CIBUser user)
                                         throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

fetchProcessFormVariables

default Map<String,Variable> fetchProcessFormVariables(String key,
 boolean deserializeValues,
 CIBUser user)
                                                throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

fetchProcessFormVariables

default Map<String,Variable> fetchProcessFormVariables(List<String> variableListName,
 String processDefinitionId,
 boolean deserializeValues,
 CIBUser user)
                                                throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

fetchVariableFileData

default NamedByteArrayDataSource fetchVariableFileData(String taskId,
 String variableName,
 CIBUser user)
                                                throws NoObjectFoundException,
UnexpectedTypeException,
SystemException

Throws:

NoObjectFoundException

UnexpectedTypeException

SystemException

uploadVariableFileData

default void uploadVariableFileData(String taskId,
 String variableName,
 org.springframework.web.multipart.MultipartFile data,
 String valueType,
 CIBUser user)
                             throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

fetchProcessInstanceVariableData

default org.springframework.http.ResponseEntity<byte[]> fetchProcessInstanceVariableData(String processInstanceId,
 String variableName,
 CIBUser user)
                                                                                  throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

uploadProcessInstanceVariableFileData

default void uploadProcessInstanceVariableFileData(String processInstanceId,
 String variableName,
 org.springframework.web.multipart.MultipartFile data,
 String valueType,
 CIBUser user)
                                            throws NoObjectFoundException,
SystemException

Throws:

NoObjectFoundException

SystemException

submitStartFormVariables

default ProcessStart submitStartFormVariables(String processDefinitionId,
 List<Variable> formResult,
 CIBUser user)
                                       throws SystemException

Throws:

SystemException

fetchVariableByProcessInstanceId

default Variable fetchVariableByProcessInstanceId(String processInstanceId,
 String variableName,
 CIBUser user)
                                           throws SystemException

Throws:

SystemException

saveVariableInProcessInstanceId

default void saveVariableInProcessInstanceId(String processInstanceId,
 List<Variable> variables,
 CIBUser user)
                                      throws SystemException

Throws:

SystemException

submitVariables

default void submitVariables(String processInstanceId,
 List<Variable> formResult,
 CIBUser user,
 String processDefinitionId)
                      throws SystemException

Throws:

SystemException

fetchProcessFormVariablesById

default Map<String,Variable> fetchProcessFormVariablesById(String id,
 CIBUser user)
                                                    throws SystemException

Throws:

SystemException

putLocalExecutionVariable

default void putLocalExecutionVariable(String executionId,
 String varName,
 Map<String,Object> data,
 CIBUser user)

getDecisionDefinitionList

default Collection<Decision> getDecisionDefinitionList(Map<String,Object> queryParams,
 CIBUser user)

getDecisionDefinitionListCount

default Long getDecisionDefinitionListCount(Map<String,Object> queryParams,
 CIBUser user)

getDecisionDefinitionByKey

default Decision getDecisionDefinitionByKey(String key,
 CIBUser user)

getDiagramByKey

default Object getDiagramByKey(String key,
 CIBUser user)

evaluateDecisionDefinitionByKey

default Object evaluateDecisionDefinitionByKey(Map<String,Object> data,
 String key,
 CIBUser user)

updateHistoryTTLByKey

default void updateHistoryTTLByKey(Map<String,Object> data,
 String key,
 CIBUser user)

getDiagramByKeyAndTenant

default Object getDiagramByKeyAndTenant(String key,
 String tenant,
 CIBUser user)

evaluateDecisionDefinitionByKeyAndTenant

default Object evaluateDecisionDefinitionByKeyAndTenant(Map<String,Object> data,
 String key,
 String tenant,
 CIBUser user)

updateHistoryTTLByKeyAndTenant

default void updateHistoryTTLByKeyAndTenant(Map<String,Object> data,
 String key,
 String tenant,
 CIBUser user)

getXmlByKey

default Object getXmlByKey(String key,
 CIBUser user)

getXmlByKeyAndTenant

default Object getXmlByKeyAndTenant(String key,
 String tenant,
 CIBUser user)

getDecisionDefinitionByKeyAndTenant

default Decision getDecisionDefinitionByKeyAndTenant(String key,
 String tenant,
 CIBUser user)

getDecisionDefinitionById

default Decision getDecisionDefinitionById(String id,
 Optional<Boolean> extraInfo,
 CIBUser user)

getDiagramById

default Object getDiagramById(String id,
 CIBUser user)

evaluateDecisionDefinitionById

default Object evaluateDecisionDefinitionById(String id,
 Map<String,Object> data,
 CIBUser user)

updateHistoryTTLById

default void updateHistoryTTLById(String id,
 Map<String,Object> data,
 CIBUser user)

getXmlById

default Object getXmlById(String id,
 CIBUser user)
                   throws SystemException

Throws:

SystemException

getDecisionVersionsByKey

default Collection<Decision> getDecisionVersionsByKey(String key,
 Optional<Boolean> lazyLoad,
 CIBUser user)

getHistoricDecisionInstances

default Collection<HistoricDecisionInstance> getHistoricDecisionInstances(Map<String,Object> queryParams,
 CIBUser user)

getHistoricDecisionInstanceCount

default Long getHistoricDecisionInstanceCount(Map<String,Object> queryParams,
 CIBUser user)

getHistoricDecisionInstanceById

default HistoricDecisionInstance getHistoricDecisionInstanceById(String id,
 Map<String,Object> queryParams,
 CIBUser user)

deleteHistoricDecisionInstances

default Object deleteHistoricDecisionInstances(Map<String,Object> data,
 CIBUser user)

setHistoricDecisionInstanceRemovalTime

default Object setHistoricDecisionInstanceRemovalTime(Map<String,Object> data,
 CIBUser user)

findJobDefinitions

default Collection<JobDefinition> findJobDefinitions(String params,
 CIBUser user)

suspendJobDefinition

default void suspendJobDefinition(String jobDefinitionId,
 String params,
 CIBUser user)

overrideJobDefinitionPriority

default void overrideJobDefinitionPriority(String jobDefinitionId,
 String params,
 CIBUser user)

retryJobDefinitionById

default void retryJobDefinitionById(String id,
 Map<String,Object> params,
 CIBUser user)

getJobs

default Collection<Job> getJobs(Map<String,Object> params,
 CIBUser user)

setSuspended

default void setSuspended(String id,
 Map<String,Object> params,
 CIBUser user)

deleteJob

default void deleteJob(String id,
 CIBUser user)

findJobDefinition

default JobDefinition findJobDefinition(String id,
 CIBUser user)

getHistoryJobLog

default Collection<Object> getHistoryJobLog(Map<String,Object> params,
 CIBUser user)

getHistoryJobLogStacktrace

default String getHistoryJobLogStacktrace(String id,
 CIBUser user)

changeDueDate

default void changeDueDate(String id,
 Map<String,Object> data,
 CIBUser user)

recalculateDueDate

default void recalculateDueDate(String id,
 Map<String,Object> params,
 CIBUser user)

getBatches

default Collection<Batch> getBatches(Map<String,Object> params,
 CIBUser user)

getBatchStatistics

default Collection<Batch> getBatchStatistics(Map<String,Object> params,
 CIBUser user)

deleteBatch

default void deleteBatch(String id,
 Map<String,Object> params,
 CIBUser user)

setBatchSuspensionState

default void setBatchSuspensionState(String id,
 Map<String,Object> params,
 CIBUser user)

getHistoricBatches

default Collection<HistoryBatch> getHistoricBatches(Map<String,Object> params,
 CIBUser user)

getRuntimeBatchCount

default Long getRuntimeBatchCount(Map<String,Object> queryParams,
 CIBUser user)

getHistoricBatchCount

default Long getHistoricBatchCount(Map<String,Object> queryParams,
 CIBUser user)

getHistoricBatchById

default HistoryBatch getHistoricBatchById(String id,
 CIBUser user)

deleteHistoricBatch

default void deleteHistoricBatch(String id,
 CIBUser user)

setRemovalTime

default Object setRemovalTime(Map<String,Object> payload,
 CIBUser user)

getCleanableBatchReport

default Object getCleanableBatchReport(Map<String,Object> queryParams,
 CIBUser user)

getCleanableBatchReportCount

default Object getCleanableBatchReportCount(CIBUser user)

getTelemetryData

default com.fasterxml.jackson.databind.JsonNode getTelemetryData(CIBUser user)

getMetrics

default Collection<Metric> getMetrics(Map<String,Object> queryParams,
 CIBUser user)

getVariableInstance

default VariableInstance getVariableInstance(String id,
 boolean deserializeValue,
 CIBUser user)
                                      throws SystemException,
NoObjectFoundException

Retrieves a variable instance by its ID.

Parameters:

id - The ID of the variable instance

deserializeValue - Whether to deserialize the variable value or not

user - the user performing the search

Returns:

Variable instance details

Throws:

SystemException - in case of an error

NoObjectFoundException - when the variable instance could not be found

getHistoricVariableInstance

default VariableHistory getHistoricVariableInstance(String id,
 boolean deserializeValue,
 CIBUser user)
                                             throws SystemException,
NoObjectFoundException

Retrieves a historic variable instance by its ID.

Parameters:

id - The ID of the historic variable instance

deserializeValue - Whether to deserialize the variable value or not

user - the user performing the search

Returns:

Historic variable instance details

Throws:

SystemException - in case of an error

NoObjectFoundException - when the historic variable instance could not be found

getExternalTasks

default Collection<ExternalTask> getExternalTasks(Map<String,Object> queryParams,
 CIBUser user)
                                           throws SystemException

Get external tasks based on query parameters

Parameters:

queryParams - Query parameters for filtering external tasks

user - the user performing the operation

Returns:

Collection of external tasks

Throws:

SystemException - in case of an error

findProcesses

default Collection<Process> findProcesses(CIBUser user)
                                   throws SystemException

Search processes.

Parameters:

user - the user performing the search

Returns:

Fetched processes.

Throws:

InvalidAttributeValueException - when searching for processes with at least one invalid parameter value.

SystemException - in case of any other error.

findProcessesWithInfo

default Collection<Process> findProcessesWithInfo(CIBUser user)
                                           throws SystemException

Search processes with number of process instances and incidents.

Parameters:

user - the user performing the search

Returns:

Fetched processes.

Throws:

InvalidAttributeValueException - when searching for processes with at least one invalid parameter value.

SystemException - in case of any other error.

findProcessesWithFilters

default Collection<Process> findProcessesWithFilters(String filters,
 CIBUser user)
                                              throws SystemException

Search processes.

Parameters:

filters - filters to be applied.

user - the user performing the search

Returns:

Fetched processes.

Throws:

InvalidAttributeValueException - when searching for processes with at least one invalid parameter value.

SystemException - in case of any other error.

findProcessByDefinitionKey

default Process findProcessByDefinitionKey(String key,
 String tenantId,
 CIBUser user)
                                    throws SystemException

Search process with a specific Key.

Parameters:

processKey - filter by process definition key.

tenantId -

user - since this call is secured we need the user to authenticate.

Returns:

Fetched process.

Throws:

SystemException - in case of an error.

findProcessVersionsByDefinitionKey

default Collection<Process> findProcessVersionsByDefinitionKey(String key,
 String tenantId,
 Optional<Boolean> lazyLoad,
 CIBUser user)
                                                        throws SystemException

Search processes (diferents versions) with a specific Key.

Parameters:

processKey - filter by process definition key.

tenantId -

lazyLoad - parameter to decide if load all the data or the minimum necessary.

user - since this call is secured we need the user to authenticate.

Returns:

Fetched process.

Throws:

SystemException - in case of an error.

findProcessById

default Process findProcessById(String id,
 Optional<Boolean> extraInfo,
 CIBUser user)
                         throws SystemException

Search process with a specific Id.

Parameters:

id - filter by process definition id.

extraInfo - parameter to specify if more data will be loaded.

user - the user performing the query.

Returns:

Fetched process.

Throws:

SystemException - in case of an error.

findProcessesInstances

default Collection<ProcessInstance> findProcessesInstances(String key,
 CIBUser user)
                                                    throws SystemException

Search processes instances with a specific process key.

Parameters:

key - the process key to filter by.

user - the user performing the search

Returns:

Fetched processes instances.

Throws:

SystemException - in case of an error.

fetchDiagram

default ProcessDiagram fetchDiagram(String processDefinitionId,
 CIBUser user)
                             throws SystemException

Fetch process diagram, a xml that contains the specification to render the diagram.

Parameters:

processDefinitionId - filter by process definition id.

user - the user performing the search

Returns:

process diagram xml that contains diagram to be render.

Throws:

NoObjectFoundException - when the process definition searched for could not be found.

SystemException - in case of any other error.

fetchStartForm

default StartForm fetchStartForm(String processDefinitionId,
 CIBUser user)
                          throws SystemException

Fetch start-form to start a process

Parameters:

processDefinitionId - of the process to be started.

user - the user performing the search

Returns:

Startform variables and formReference.

Throws:

NoObjectFoundException - when trying to find start form data of a non-existing process definition.

SystemException - in case of any other error.

downloadBpmn

default Data downloadBpmn(String processDefinitionId,
 String fileName,
 CIBUser user)
                   throws SystemException

Download bpmn from a process definition id.

Parameters:

processDefinitionId - filter by process definition id.

fileName - name of the file content the bpmn.

user - the user performing the download

Returns:

Fetched bpmn

Throws:

SystemException - in case of an error.

suspendProcessInstance

default void suspendProcessInstance(String processInstanceId,
 Boolean suspend,
 CIBUser user)
                             throws SystemException

Activate/Suspend process instance by ID.

Parameters:

processInstanceId - instance id to be suspended or activated.

suspend - if true, the process instance will be activated if false process will be suspended.

user - the user performing the operation.

Throws:

SystemException - in case of other error.

deleteProcessInstance

default void deleteProcessInstance(String processInstanceId,
 CIBUser user)
                            throws SystemException

Delete process instance by ID.

Parameters:

processInstanceId - instance id to be deleted.

user - the user performing the deletion.

Throws:

NoObjectFoundException - when the filter to be changed could not be found.

SystemException - in case of any other error.

suspendProcessDefinition

default void suspendProcessDefinition(String processDefinitionId,
 Boolean suspend,
 Boolean includeProcessInstances,
 String executionDate,
 CIBUser user)
                               throws SystemException

Activate/Suspend process instance by ID.

Parameters:

processDefinitionId - definition id to be suspended or activated.

suspend - if true, the process will be activated if false process will be suspended.

includeProcessInstances - indicates whether to activate or suspend also all process instances of the given process definition

executionDate - The date on which the given process definition will be activated or suspended ej. 2013-01-23T14:42:45. yyyy-MM-dd'T'HH:mm:ss, If null, the suspension state of the given process definition is updated immediately.

user - the user performing the operation.

Throws:

SystemException - in case of other error.

UnsupportedTypeException - when a process instance cannot be created because of an unsupported value type or an invalid expression used in the process definition.

NoObjectFoundException - when the filter to be changed could not be found.

startProcess

default ProcessStart startProcess(String processDefinitionKey,
 String tenantId,
 Map<String,Object> data,
 CIBUser user)
                           throws SystemException,
UnsupportedTypeException,
ExpressionEvaluationException

Start process.

Parameters:

processDefinitionKey - of the process to be started.

tenantId - the tenant ID.

data - variables to start process.

user - the user starting the process.

Returns:

information about the process started.

Throws:

UnsupportedTypeException - when a process instance cannot be created because of an unsupported value type or an invalid expression used in the process definition.

ExpressionEvaluationException - when .

SystemException - in case of any other error.

submitForm

default ProcessStart submitForm(String processDefinitionKey,
 String tenantId,
 Map<String,Object> data,
 CIBUser user)
                         throws SystemException,
UnsupportedTypeException,
ExpressionEvaluationException

Submit form with variables.

Parameters:

processDefinitionKey - of the process to be started.

tenantId - the tenant ID.

data - variables to submit.

user - the user submitting the form.

Returns:

information about the process started.

Throws:

UnsupportedTypeException - when a process instance cannot be created because of an unsupported value type or an invalid expression used in the process definition.

ExpressionEvaluationException - when .

SystemException - in case of any other error.

submitForm

default ProcessStart submitForm(String processDefinitionId,
 String formResult,
 CIBUser user)
                         throws SystemException,
UnsupportedTypeException,
ExpressionEvaluationException

Submit a form to start a process with the given process definition id.

Parameters:

processDefinitionId - the process definition id

formResult - the form submission data as a JSON string

user - the authenticated user submitting the form

Returns:

information about the started process instance

Throws:

UnsupportedTypeException - when a variable value type is not supported by the engine

ExpressionEvaluationException - when an expression in the process definition cannot be evaluated

SystemException - in case of any other error

findProcessStatistics

default Collection<ProcessStatistics> findProcessStatistics(String processId,
 CIBUser user)
                                                     throws SystemException,
UnsupportedTypeException,
ExpressionEvaluationException

Search statistics from a process.

Parameters:

processId - filter by process id.

user - the user performing the search

Returns:

Fetched processes instances.

Throws:

SystemException - in case of an error.

UnsupportedTypeException

ExpressionEvaluationException

getProcessStatistics

default Collection<ProcessStatistics> getProcessStatistics(Map<String,Object> queryParams,
 CIBUser user)
                                                    throws SystemException

Search statistics for all processes.

Parameters:

queryParams - query parameters to filter the search

user - the user performing the search

Returns:

Fetched processes instances.

Throws:

SystemException - in case of an error.

findProcessesInstancesHistory

default Collection<HistoryProcessInstance> findProcessesInstancesHistory(Map<String,Object> filters,
 Optional<Integer> firstResult,
 Optional<Integer> maxResults,
 CIBUser user)
                                                                  throws SystemException

Queries for historic process instances that fulfill the given parameters.

Parameters:

filters - is a map of parameters to filter query. Parameters firstResult and maxResults are used for pagination.

user - the user performing the query.

Returns:

Fetched processes instances.

Throws:

SystemException - in case of an error.

findProcessesInstancesHistory

default Collection<HistoryProcessInstance> findProcessesInstancesHistory(String key,
 Optional<Boolean> active,
 Integer firstResult,
 Integer maxResults,
 CIBUser user)
                                                                  throws SystemException

Search processes instances with a specific process key (in the history).

Parameters:

key - the process key to filter by.

active - true means that unfinished processes will be fetched, false means only finished processes will be fetched.

firstResult - index of the first result to return.

maxResults - maximum number of results to return.

user - the user performing the query.

Returns:

Fetched process instances.

Throws:

SystemException - in case of an error.

findProcessesInstancesHistoryById

default Collection<HistoryProcessInstance> findProcessesInstancesHistoryById(String id,
 Optional<String> activityId,
 Optional<Boolean> active,
 Integer firstResult,
 Integer maxResults,
 String text,
 CIBUser user)
                                                                      throws SystemException

Queries for historic process instances that fulfill the given parameters.

Parameters:

id - the ID of the process instance.

activityId - optional activity ID to filter the query.

active - optional flag to filter active or inactive instances.

firstResult - index of the first result to return.

maxResults - maximum number of results to return.

text - additional text filter for the query.

user - the user performing the query.

Returns:

Fetched process instances.

Throws:

SystemException - in case of an error.

countProcessesInstancesHistory

default Long countProcessesInstancesHistory(Map<String,Object> filters,
 CIBUser user)

countProcessesInstancesRuntime

default Long countProcessesInstancesRuntime(Map<String,Object> filters,
 CIBUser user)

findProcessInstance

default ProcessInstance findProcessInstance(String processInstanceId,
 CIBUser user)
                                     throws SystemException

Required by OFDKA Search process instance with a specific process instance id.

Parameters:

processInstanceId - filter by process instance id.

user - the user performing the search.

Returns:

Fetched process instance.

Throws:

NoObjectFoundException - when the process instance searched for could not be found.

SystemException - in case of any other error.

fetchProcessInstanceVariable

default Variable fetchProcessInstanceVariable(String processInstanceId,
 String variableName,
 boolean deserializeValue,
 CIBUser user)
                                       throws SystemException

Required by OFDKA Retrieves a variable of a given process instance by id.

Parameters:

processInstanceId - filter by process instance id.

variableName - variable name.

deserializeValue - whether to deserialize the variable value. Default: true.

user - the user performing the search.

Returns:

Fetched variables.

Throws:

SystemException - in case of an error.

findHistoryProcessInstanceHistory

default HistoryProcessInstance findHistoryProcessInstanceHistory(String processInstanceId,
 CIBUser user)
                                                          throws SystemException

Search process instance with a specific process instance id.

Parameters:

processInstanceId - filter by process instance id.

user - the user performing the search

Returns:

Fetched process instance.

Throws:

NoObjectFoundException - when the process instance searched for could not be found.

SystemException - in case of any other error.

findCalledProcessDefinitions

default Collection<Process> findCalledProcessDefinitions(String processDefinitionId,
 CIBUser user)
                                                  throws SystemException

Throws:

SystemException

getDeployedStartForm

default org.springframework.http.ResponseEntity<byte[]> getDeployedStartForm(String processDefinitionId,
 CIBUser user)
                                                                      throws SystemException

Throws:

SystemException

getRenderedStartForm

default org.springframework.http.ResponseEntity<String> getRenderedStartForm(String processDefinitionId,
 Map<String,Object> params,
 CIBUser user)

updateHistoryTimeToLive

default void updateHistoryTimeToLive(String id,
 Map<String,Object> data,
 CIBUser user)
                              throws SystemException

Throws:

SystemException

deleteProcessInstanceFromHistory

default void deleteProcessInstanceFromHistory(String id,
 CIBUser user)
                                       throws SystemException

Throws:

SystemException

deleteProcessDefinition

default void deleteProcessDefinition(String id,
 Optional<Boolean> cascade,
 CIBUser user)
                              throws SystemException

Throws:

SystemException

findCurrentProcessesInstances

default Collection<ProcessInstance> findCurrentProcessesInstances(Map<String,Object> data,
 CIBUser user)
                                                           throws SystemException

Search processes instances by filter.

Parameters:

data - a map of parameters to filter the query.

user - the user performing the query.

Returns:

Fetched processes instances.

Throws:

SystemException - in case of an error.

findProcessesInstancesRuntime

default Collection<HistoryProcessInstance> findProcessesInstancesRuntime(Map<String,Object> data,
 Optional<Integer> firstResult,
 Optional<Integer> maxResults,
 CIBUser user)
                                                                  throws SystemException

Throws:

SystemException

fetchHistoricActivityStatistics

default Object fetchHistoricActivityStatistics(String id,
 Map<String,Object> params,
 CIBUser user)
                                        throws SystemException

Fetch historic activity statistics for a given process definition ID.

Parameters:

id - the ID of the process definition

params - query parameters to filter statistics (e.g., canceled, finished, incidents)

user - the user performing the operation

Returns:

a list or map containing the historic activity statistics

Throws:

SystemException - in case of an error

fetchIncidents

default Collection<Incident> fetchIncidents(String processDefinitionKey,
 CIBUser user)
                                     throws SystemException

Fetch incidents for an specific process.

Parameters:

processDefinitionKey - of the process to fetch incidents.

user - the user performing the search.

Throws:

UnsupportedTypeException - when a process instance cannot be created because of an unsupported value type or an invalid expression used in the process definition.

SystemException - in case of any other error.

correlateMessage

default Collection<Message> correlateMessage(Map<String,Object> data,
 CIBUser user)
                                      throws SystemException

Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.

Parameters:

data - variables to start process.

user - the user performing the correlation.

Returns:

Collection of correlated messages.

Throws:

SystemException - in case of any other error.

addMemberToGroup

default void addMemberToGroup(String groupId,
 String userId,
 CIBUser user)
                       throws SystemException

Add user to a group.

Parameters:

groupId - the ID of the group.

userId - the ID of the user to be added.

user - the user performing the operation.

Throws:

SystemException

deleteMemberFromGroup

default void deleteMemberFromGroup(String groupId,
 String userId,
 CIBUser user)
                            throws SystemException

Delete user from a group.

Parameters:

groupId - the ID of the group.

userId - the ID of the user to be removed.

user - the user performing the operation.

Throws:

SystemException

deleteUser

default void deleteUser(String userId,
 CIBUser user)
                 throws SystemException

Deletes a user by id.

Parameters:

userId - the ID of the user to be deleted.

user - the user performing the deletion.

Throws:

SystemException

getUserProfile

default SevenUser getUserProfile(String userId,
 CIBUser user)
                          throws SystemException

Get user by id.

Parameters:

userId - the ID of the user to be fetched.

user - the user performing the search.

Returns:

SevenUser object containing user profile information.

Throws:

SystemException

retryJobById

default void retryJobById(String jobId,
 Map<String,Object> data,
 CIBUser user)
                   throws SystemException

Throws:

SystemException

findStacktrace

default String findStacktrace(String jobId,
 CIBUser user)

countIncident

default Long countIncident(Map<String,Object> params,
 CIBUser user)
                    throws SystemException

Throws:

SystemException

countHistoricIncident

default Long countHistoricIncident(Map<String,Object> params,
 CIBUser user)
                            throws SystemException

Throws:

SystemException

findIncident

default Collection<Incident> findIncident(Map<String,Object> params,
 CIBUser user)
                                   throws SystemException

Throws:

SystemException

findIncidentByInstanceId

default List<Incident> findIncidentByInstanceId(String processInstanceId,
 CIBUser user)
                                         throws SystemException

Throws:

SystemException

fetchIncidentsByInstanceAndActivityId

default Collection<Incident> fetchIncidentsByInstanceAndActivityId(String processDefinitionKey,
 String activityId,
 CIBUser user)
                                                            throws SystemException

Throws:

SystemException

setIncidentAnnotation

default void setIncidentAnnotation(String incidentId,
 Map<String,Object> data,
 CIBUser user)

findExternalTaskErrorDetails

default String findExternalTaskErrorDetails(String externalTaskId,
 CIBUser user)
                                     throws SystemException

Throws:

SystemException

findHistoricExternalTaskErrorDetails

default String findHistoricExternalTaskErrorDetails(String externalTaskId,
 CIBUser user)
                                             throws SystemException

Throws:

SystemException

retryExternalTask

default void retryExternalTask(String externalTaskId,
 Map<String,Object> data,
 CIBUser user)

findHistoricIncidents

default Collection<Incident> findHistoricIncidents(Map<String,Object> params,
 CIBUser user)
                                            throws SystemException

Throws:

SystemException

findHistoricStacktraceByJobId

default String findHistoricStacktraceByJobId(String jobId,
 CIBUser user)
                                      throws SystemException

Throws:

SystemException

getEventSubscriptions

default Collection<EventSubscription> getEventSubscriptions(Optional<String> processInstanceId,
 Optional<String> eventType,
 Optional<String> eventName,
 CIBUser user)
                                                     throws SystemException

Required by OFDKA Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the Get Event Subscriptions count method.

Parameters:

processInstanceId - filter by process instance id.

eventType - filter by event type.

eventName - filter by event name.

user - the user performing the search.

Returns:

Collection event subscriptions fetched in the search.

Throws:

SystemException

fetchTenants

default Collection<Tenant> fetchTenants(Map<String,Object> queryParams,
 CIBUser user)
                                 throws SystemException

Throws:

SystemException

fetchTenant

default Tenant fetchTenant(String tenantId,
 CIBUser user)
                    throws SystemException

Throws:

SystemException

createTenant

default void createTenant(Tenant tenant,
 CIBUser user)
                   throws SystemException

Throws:

SystemException

updateTenant

default void updateTenant(Tenant tenant,
 CIBUser user)
                   throws SystemException

Throws:

SystemException

deleteTenant

default void deleteTenant(String tenantId,
 CIBUser user)
                   throws SystemException

Throws:

SystemException

addMemberToTenant

default void addMemberToTenant(String tenantId,
 String userId,
 CIBUser user)
                        throws SystemException

Throws:

SystemException

deleteMemberFromTenant

default void deleteMemberFromTenant(String tenantId,
 String userId,
 CIBUser user)
                             throws SystemException

Throws:

SystemException

addGroupToTenant

default void addGroupToTenant(String tenantId,
 String groupId,
 CIBUser user)
                       throws SystemException

Throws:

SystemException

deleteGroupFromTenant

default void deleteGroupFromTenant(String tenantId,
 String groupId,
 CIBUser user)
                            throws SystemException

Throws:

SystemException

getProcessEngineNames

default Collection<Engine> getProcessEngineNames()
                                          throws SystemException

Get the names of all process engines available on the engine.

Returns:

a collection of engine objects containing name information

Throws:

SystemException - in case of an error

getDefaultEngineConfiguration

@Nullable
default EngineConfiguration getDefaultEngineConfiguration()

Returns the configuration for the default BPM engine.

Returns:

the default EngineConfiguration, or null if no default engine is configured

getEngineConfiguration

@Nullable
default EngineConfiguration getEngineConfiguration(String engineName)

Returns the configuration for the BPM engine with the given name.

Parameters:

engineName - the name of the engine to look up

Returns:

the EngineConfiguration for the specified engine, or null if no engine with that name is configured

requiresSetup

default Boolean requiresSetup(String engine)

Determine whether an initial user needs to be created

Returns:

true if admin group is available and write access is set

Throws:

SystemException - in case of an error

createSetupUser

default void createSetupUser(NewUser user,
 String engine)
                      throws InvalidUserIdException

Creates a new initial user assigned to the also created admin group.

Parameters:

user - the new user to be created.

Throws:

InvalidUserIdException - when the user ID is invalid.

validatePasswordPolicy

default PasswordPolicyResponse validatePasswordPolicy(PasswordPolicyRequest request)
                                               throws SystemException

Throws:

SystemException