Overview
Follow the steps below to add the Comala Workflows API to your app.
...
Note |
---|
You must be already familiar with developing Confluence apps to be able to use the |
...
Comala Document Management API |
Follow the steps below to add the Comala Document Management Java API to your app:
1. Add the appfire-comalatech-public
maven repository in your .m2/settings.xml
:
Code Block | ||||
---|---|---|---|---|
| ||||
<repository> <id>comalatech <id>appfire-comalatech-public</id> <url>https://nexus.comalatechappfire.com/content/groups/repository/comalatech-maven-public/</url> <snapshots> <enabled>true</enabled> </snapshots> <releases> <enabled>true</enabled> </releases> </repository> |
2. Add a dependency to the Comala
...
Document Management API in your pom.xml
...
:
Info |
---|
Only available from Comala Document Management |
...
6. |
...
16.0 onwards, there will always be a corresponding API library with the same version available. |
The new Comala Workflows API library coordinates:
Code Block | ||||
---|---|---|---|---|
| ||||
<dependency> <groupId>com.comalatech.workflow</groupId> <artifactId>workflows-api</artifactId> <version>[replace with Comala Document WorkflowsManagement version of your choice]</version> <scope>provided</scope> </dependency> |
Previous API library, now deprecated (as of Comala Document Management version 5.1), dependency:
|
3. Import the required components
In your atlassian-plugin.xml
:
Code Block | ||||
---|---|---|---|---|
| ||||
<component-import name="Comala Workflows Services" key="workflowService" interface="com.comalatech.workflow.WorkflowService"/> <component-import name="Comala State Services" key="stateService" interface="com.comalatech.workflow.StateService"/> <component-import name="Comala Tasks Services" key="taskService" interface="com.comalatech.workflow.TaskService"/> <component-import name="Comala Approvals Services" key="approvalService" interface="com.comalatech.workflow.ApprovalService"/> <component-import name="Comala Document Activity API" key="documentActivitySevice" interface="com.comalatech.workflow.DocumentActivityService"/> |
or if you are using atlassian spring scanner right inside your plugin component:
Code Block | ||||
---|---|---|---|---|
| ||||
@ComponentImport private WorkflowService workflowService; @ComponentImport private StateService stateService; @ComponentImport private TaskService taskService; @ComponentImport private ApprovalService approvalService; @ComponentImport private DocumentActivityService documentActivityService; |
The components will be injected in your plugin components.
...
You can now use the API Services, or handle Workflow Events. Access the full Javadoc documentation here.