...
The following example assume that you are using BeanShell Plugin in a Process Tool. Please refer to Bean Shell Programming Guide for more information.
...
Methods
completeAssignmentForm
orgpublic org.joget.apps.form.model.FormData completeAssignmentForm(java.lang.String appId, java.lang.String version, java.lang.String activityId, org.joget.apps.form.model.FormData formData, java.util.Map<java.lang.String, java.lang.String> workflowVariableMap)
Process a submitted form to complete an assignment
completeAssignmentForm
orgpublic org.joget.apps.form.model.FormData completeAssignmentForm(org.joget.apps.form.model.Form form, org.joget.workflow.model.WorkflowAssignment assignment, org.joget.apps.form.model.FormData formData, java.util.Map<java.lang.String, java.lang.String> workflowVariableMap)
Process a submitted form to complete an assignment
countProcessFormData
intpublic int countProcessFormData(java.lang.String formDefId, java.lang.String query)
...
Deprecated API used in v2. Not implemented since v3.
createAppDefinition
javapublic java.util.Collection<java.lang.String> createAppDefinition(org.joget.apps.app.model.AppDefinition appDefinition)
...
Return A Collection of errors (if any).
createAppDefinition
javapublic java.util.Collection<java.lang.String> createAppDefinition(org.joget.apps.app.model.AppDefinition appDefinition, org.joget.apps.app.model.AppDefinition copyAppDefinition)
...
Return A Collection of errors (if any).
createFormDefinition
javapublic java.util.Collection<java.lang.String> createFormDefinition(org.joget.apps.app.model.AppDefinition appDefinition, org.joget.apps.app.model.FormDefinition formDefinition)
...
createNewAppDefinitionVersion
orgpublic org.joget.apps.app.model.AppDefinition createNewAppDefinitionVersion(java.lang.String appId)
...
deleteAllAppDefinitionVersions
voidpublic void deleteAllAppDefinitionVersions(java.lang.String appId)
...
deleteAppDefinitionVersion
voidpublic void deleteAppDefinitionVersion(java.lang.String appId, java.lang.Long version)
Delete a specific app version
deployWorkflowPackage
orgpublic org.joget.apps.app.model.PackageDefinition deployWorkflowPackage(java.lang.String appId, java.lang.String version, byte[] packageXpdl, boolean createNewApp) throws java.io.Exception
Deploy an XPDL package for an app.
exportApp
public java.io.OutputStream exportApp(java.lang.String appId, java.lang.String version, java.io.OutputStream output) throws java.io.IOException
Export an app version in ZIP format into an OutputStream
getAppDataXmlFromZip
bytepublic byte[] getAppDataXmlFromZip(byte[] zip) throws java.io.Exception
Reads app XML from zip content.
getAppDefinition
orgpublic org.joget.apps.app.model.AppDefinition getAppDefinition(java.lang.String appId, java.lang.String version)
...
getAppDefinitionForWorkflowActivity
orgpublic org.joget.apps.app.model.AppDefinition getAppDefinitionForWorkflowActivity(java.lang.String activityId)
...
getAppDefinitionForWorkflowProcess
orgpublic org.joget.apps.app.model.AppDefinition getAppDefinitionForWorkflowProcess(java.lang.String processId)
Retrieves the app definition for a specific workflow process.
getWorkflowProcessForApp
process.
getWorkflowProcessForApp
public org.joget.workflow.model.WorkflowProcess getWorkflowProcessForApp(java.lang.String appId, java.lang.String version, java.lang.String processDefId)...
getAppDefinitionWithProcessDefId
orgpublic org.joget.apps.app.model.AppDefinition getAppDefinitionWithProcessDefId(java.lang.String processDefId)
Retrieves the app definition for a specific workflow process definition id.
getAppDefinitionXml
bytepublic byte[] getAppDefinitionXml(java.lang.String appId, java.lang.Long version)
...
public java.util.Map<org.joget.apps.app.model.AppDefinition, java.util.Collection<WorkflowProcess>>Collection<org.joget.workflow.model.WorkflowProcess>> getPublishedProcesses(java.lang.String appId)
...
Retrieve all apps without check for permission
getXpdlFromZip
bytepublic byte[] getXpdlFromZip(byte[] zip) throws Exception
Reads XPDL from zip content.
importApp
orgpublic org.joget.apps.app.model.AppDefinition importApp(byte[] zip) throws org.joget.apps.app.model.ImportAppException
Import app from zip file
importAppDefinition
public org.joget.apps.app.model.AppDefinition importAppDefinition(org.joget.apps.app.model.AppDefinition appDef, java.lang.Long appVersion, byte[] xpdl) throws org.joget.apps.app.model.ImportAppException
Import an app definition object and XPDL content into the system.
importPlugins
voidpublic void importPlugins(byte[] zip) throws java.io.Exception
Import plugins (JAR) from within a zip content.
isActivityAutoContinue
booleanpublic boolean isActivityAutoContinue(java.lang.String packageId, java.lang.String version, java.lang.String processDefId, java.lang.String activityDefId)
Check to see whether an activity is configured to automatically continue on to the next activity.
loadAppDefinition
orgpublic org.joget.apps.app.model.AppDefinition loadAppDefinition(java.lang.String appId, java.lang.String version)
...
If version is null, empty or equals to AppDefinition.VERSION_LATEST, the latest version is returned.
listProcessFormData
javapublic java.util.Collection<org.joget.apps.form.model.Form> listProcessFormData(java.lang.String formDefId, java.lang.String processId, java.lang.String query, java.lang.String sort, java.lang.Boolean desc, int start, int rows)
...
Deprecated API used in v2. Not implemented since v3.
loadFormData
orgpublic org.joget.apps.form.model.FormRowSet loadFormData(java.lang.String appId, java.lang.String version, java.lang.String formDefId, java.lang.String primaryKeyValue)
Load specific data row (record) by primary key value for a specific form
loadFormData
orgpublic org.joget.apps.form.model.FormRowSet loadFormData(org.joget.apps.form.model.Form form, java.lang.String primaryKeyValue)
...
loadFormDataWithoutTransaction
orgpublic org.joget.apps.form.model.FormRowSet loadFormDataWithoutTransaction(java.lang.String formDefid, java.lang.String tableName, java.lang.String primaryKeyValue)
...
loadFormDataWithoutTransaction
orgpublic org.joget.apps.form.model.FormRowSet loadFormDataWithoutTransaction(org.joget.apps.form.model.Form form, java.lang.String primaryKeyValue)
...
This method is transactional (since v5), but retains the method name for backward compatibility reasons.
retrieveMappedForm
orgpublic org.joget.apps.app.model.PackageActivityForm retrieveMappedForm(java.lang.String appId, java.lang.String version, java.lang.String processDefId, java.lang.String activityDefId)
Returns the form definition ID for the form mapped to the specified activity definition ID
storeFormData
orgpublic org.joget.apps.form.model.FormRowSet storeFormData(org.joget.apps.form.model.Form form, org.joget.apps.form.model.FormRowSet rows, java.lang.String primaryKeyValue)
Store specific data row (record) for a form.
storeFormData
orgpublic org.joget.apps.form.model.FormRowSet storeFormData(java.lang.String formDefId, java.lang.String tableName, org.joget.apps.form.model.FormRowSet rows, java.lang.String primaryKeyValue)
Store specific data row (record) for a form.
storeFormData
orgpublic org.joget.apps.form.model.FormRowSet storeFormData(java.lang.String appId, java.lang.String version, java.lang.String formDefId, org.joget.apps.form.model.FormRowSet rows, java.lang.String primaryKeyValue)
Store specific data row (record)
submitForm
orgpublic org.joget.apps.form.model.FormData submitForm(org.joget.apps.form.model.Form form, org.joget.apps.form.model.FormData formData, boolean ignoreValidation)
Use case for form submission by Form object
submitForm
orgpublic org.joget.apps.form.model.FormData submitForm(java.lang.String appId, java.lang.String version, java.lang.String formDefId, org.joget.apps.form.model.FormData formData, boolean ignoreValidation)
Use case for form submission by ID
submitFormToStartProcess
public org.joget.workflow.model.WorkflowProcessResult submitFormToStartProcess(java.lang.String appId, java.lang.String version, java.lang.String processDefId, org.joget.apps.form.model.FormData formData, java.util.Map<java.lang.String, java.lang.String> workflowVariableMap, java.lang.String originProcessId, java.lang.String formUrl)
Start a process through a form submission
viewAssignmentForm
orgpublic org.joget.apps.app.model.PackageActivityForm viewAssignmentForm(org.joget.apps.app.model.AppDefinition appDef, org.joget.workflow.model.WorkflowAssignment assignment, org.joget.apps.form.model.FormData formData, java.lang.String formUrl)
Retrieve a form for a specific activity instance
viewAssignmentForm
orgpublic org.joget.apps.app.model.PackageActivityForm viewAssignmentForm(org.joget.apps.app.model.AppDefinition appDef, org.joget.workflow.model.WorkflowAssignment assignment, org.joget.apps.form.model.FormData formData, java.lang.String formUrl, java.lang.String cancelUrl)
Retrieve a form for a specific activity instance
viewAssignmentForm
orgpublic org.joget.apps.app.model.PackageActivityForm viewAssignmentForm(java.lang.String appId, java.lang.String version, java.lang.String activityId, org.joget.apps.form.model.FormData formData, java.lang.String formUrl)
Retrieve a form for a specific activity instance
viewAssignmentForm
orgpublic org.joget.apps.app.model.PackageActivityForm viewAssignmentForm(java.lang.String appId, java.lang.String version, java.lang.String activityId, org.joget.apps.form.model.FormData formData, java.lang.String formUrl, java.lang.String cancelUrl)
Retrieve a form for a specific activity instance
viewDataForm
orgpublic org.joget.apps.form.model.Form viewDataForm(java.lang.String appId, java.lang.String version, java.lang.String formDefId, java.lang.String saveButtonLabel, java.lang.String submitButtonLabel, java.lang.String cancelButtonLabel, org.joget.apps.form.model.FormData formData, java.lang.String formUrl, java.lang.String cancelUrl)
Retrieve a data form
viewDataForm
orgpublic org.joget.apps.form.model.Form viewDataForm(java.lang.String appId, java.lang.String version, java.lang.String formDefId, java.lang.String saveButtonLabel, java.lang.String submitButtonLabel, java.lang.String cancelButtonLabel, java.lang.String cancelButtonTarget, org.joget.apps.form.model.FormData formData, java.lang.String formUrl, java.lang.String cancelUrl)Retrieve a data form
viewStartProcessForm
orgpublic org.joget.apps.app.model.PackageActivityForm viewStartProcessForm(java.lang.String appId, java.lang.String version, java.lang.String processDefId, org.joget.apps.form.model.FormData formData, java.lang.String formUrl)
...