# Process beans Process beans are Spring beans that can be used inside a Camunda BPMN process. The BPMN expression fields have access to all process beans. This page gives an overview of all available process beans. ## ConnectorService This process bean makes it possible to interact with connectors inside the BPMN process. ```kotlin fun getConnectorTypes() ``` Lists all connector-types. ```kotlin fun getConnectorInstances(pageable: Pageable = Pageable.unpaged()) ``` Lists all connector-instances. ```kotlin fun getConnectorInstancesByType(typeId: UUID, pageable: Pageable = Pageable.unpaged()) ``` Get a list of connector-instances by type ID ```kotlin fun getConnectorInstancesByTypeName(typeName: String, pageable: Pageable = Pageable.unpaged()) ``` Get a list of connector-instances by type name. ```kotlin fun getConnectorInstanceById(id: UUID): ConnectorInstance ``` Get a connector-instance by id. ```kotlin fun loadByName(name: String) ``` Loads the connector-instance by name. ```kotlin fun loadByClassName(clazz: Class) ``` Loads the connector-instance by class name ## CorrelationService This process bean provides a way to manipulate jobs within the current process. ```kotlin fun sendStartMessage(message: String, businessKey: String) fun sendStartMessage(message: String, businessKey: String, variables: Map?) fun sendStartMessageWithProcessDefinitionKey(message: String, targetProcessDefinitionKey: String, businessKey: String, variables: Map?) fun sendCatchEventMessage(message: String, businessKey: String) fun sendCatchEventMessage(message: String, businessKey: String, variables: Map?) fun sendCatchEventMessageToAll(message: String, businessKey: String) fun sendCatchEventMessageToAll(message: String, businessKey: String, variables: Map?) fun sendGlobalCatchEventMessage(message: String) fun sendGlobalCatchEventMessage(message: String, variables: Map?) fun sendGlobalCatchEventMessageToAll(message: String) fun sendGlobalCatchEventMessageToAll(message: String, variables: Map?) ``` Information on all methods can be found [here](/v12/features/process/correlation-service.md). ## JobService This process bean provides a way to manipulate jobs within the current process. ```kotlin fun updateTimerDueDateByActivityId(dueDateString: String, activityId: String, execution: DelegateExecution) fun addOffsetInMillisToTimerDueDateByActivityId(millisecondsToAdd: Long, activityId: String, execution: DelegateExecution) ``` Information on all methods can be found [here](/v12/features/process/job-service.md). ## ProcessDocumentGenerator This process bean provides an interface for generating documents. ```kotlin fun generate(execution: DelegateExecution, mediaType: String, templateIdentifier: String) ``` Provides an interface for generating documents. This method only works if your implementation has overriden the interface to actually generate a document. ## MailService This process bean is for sending emails. ```kotlin fun sendElementTemplateTaskMail(execution: DelegateExecution) ``` Is able to send an email using the configured Camunda extension properties. The extension properties are: * `mailSendTaskFrom` - The email-address of the sender. * `mailSendTaskSubject` - The subject of the email. * `mailSendTaskTo` - The email-address of the receiver. * `mailSendTaskTemplate` - The template that is used for the email. The template often has placeholders. The method uses all process variables as possible placeholders for the template. ## DocumentDelegate This process bean is deprecated. Please use the `DocumentDelegateService` process bean instead. ## DocumentVariableDelegate This process bean is deprecated. Please use the `DocumentDelegateService` process bean instead. ## DocumentDelegateService This process bean is for retrieving and updating the document. ```kotlin fun getDocumentVersion(execution: DelegateExecution) ``` Returns the version of the document. ```kotlin fun getDocumentCreatedOn(execution: DelegateExecution) ``` Returns the creation date of the document. ```kotlin fun getDocumentCreatedBy(execution: DelegateExecution) ``` Returns the email of the creator of the document. ```kotlin fun getDocumentModifiedOn(execution: DelegateExecution) ``` Returns the last modified date of the document. ```kotlin fun getDocumentAssigneeId(execution: DelegateExecution) ``` Returns the ID of the person assigned to the document version. ```kotlin fun getDocumentAssigneeFullName(execution: DelegateExecution) ``` Returns the full name of the person assigned to the document. ```kotlin fun getDocument(execution: DelegateExecution) ``` Returns the entire document as an object. ```kotlin fun findValueByJsonPointer(jsonPointer: String?, execution: DelegateExecution?) ``` Returns the value retrieved from the document at a given pointer. ```kotlin fun findValueByJsonPointerOrDefault(jsonPointer: String?, execution: DelegateExecution, defaultValue: Any) ``` Returns the value retrieved from the document at a given pointer, or the given default when the property described by the pointer does not exist. ```kotlin fun setAssignee(execution: DelegateExecution, userEmail: String?) ``` Assigns a person to a document. ```kotlin fun unassign(execution: DelegateExecution) ``` Removes the assigned person from a document. ## ProcessDocumentsService This process bean is for functions that affect both the document and the process. ```kotlin fun startProcessByProcessDefinitionKey(processDefinitionKey: String, documentId: String) fun startProcessByProcessDefinitionKey(processDefinitionKey: String, documentId: String, variables: Map?) ``` Starts a new process and attaches it to the current document. ## ValueResolverDelegateService This process bean contains functions for accessing the Valtimo value resolver. More information [here](https://github.com/valtimo-platform/valtimo/blob/v12-stable/documentation/nog-een-plek-geven/reference/broken-reference/README.md) ### Resolve value ```kotlin fun resolveValue(execution: DelegateExecution, key: String) ``` Resolves a value from a specified source. The resolved value is only returned. An example: ```spel ${execution.setVariable('firstName', valueResolverDelegateService.resolveValue(execution, 'doc:person.firstName'))} ``` ### Handle value ```kotlin fun handleValue(execution: DelegateExecution, key: String, value: Any) ``` Handles a value for a specified target. The example below shows how a process-variable is stored in the document on path `/person/firstName`: ```spel ${valueResolverDelegateService.handleValue(execution, 'doc:person.firstName', execution.getVariable('firstName'))} ``` ### Process Service Terminate all running processes that are associated with a specific case. This can be achieved by configuring a BPMN ServiceTask expression: ```bpmn ${processService.deleteAllProcessInstancesForThisDocument(execution, "Test deletion process")} ``` #### Details * The expression stops all active process instances related to the current case/document. * A *reason* can be provided as a parameter (in the example above: "Test deletion process"). * Once invoked, all processes for the case are stopped immediately. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.valtimo.nl/v12/nog-een-plek-geven/reference/process-beans.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.