This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

Follow the steps below to add the Comala Document Management Java API to your app:

You must be already familiar with developing Confluence apps to be able to use the Comala Document Management API

1. Add the appfire-comalatech-public maven repository in your .m2/settings.xml:

<repository>
	<id>appfire-comalatech-public</id>
    <url>https://nexus.appfire.com/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

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:

<dependency>
    <groupId>com.comalatech.workflow</groupId>
    <artifactId>workflows-api</artifactId>
    <version>[replace with Comala Workflows version of your choice]</version>
    <scope>provided</scope>
</dependency>

3. Import the required components

In your atlassian-plugin.xml:

<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"/>

or if you are using atlassian spring scanner right inside your plugin component:

    @ComponentImport
    private WorkflowService workflowService;
    @ComponentImport
    private StateService stateService;
    @ComponentImport
    private TaskService taskService;
    @ComponentImport
    private ApprovalService approvalService;

The components will be injected in your plugin components.

4. Use it!

You can now use the API Services, or handle Workflow Events.

  • No labels