Skip to main content

Version: 18.05 (EOL)

Setup Transact SDK

If you have previously relied on Maestro and/or the TM Console to develop Transact Manager (TM) applications, you may not be familiar with using an IDE to achieve the same result. This guide does not assume any prerequisite knowledge, and is suitable for developers who have not had a lot of exposure to IDEs.

System Requirements​

Building Transact SDK applications requires Java, Groovy and Ant to be installed on your computer. The installers for many modern IDEs can install additional software products such as Groovy and Ant. If your IDE's installer does not include these products, you will need to add them to your IDE manually.

The following software product versions are recommended for use with Transact SDK.

Installing Transact SDK​

This documentation is bundled in your Transact SDK download, and is also available on the Avoka Documentation web site. Additionally, you can check the Release Notes on the Avoka Community web site for new Transact SDK releases.

The distribution file is called transact-sdk-<version>.zip. Unzip it into a folder of the same name as the ZIP file. It is important that you extract the ZIP file into the correctly named folder, otherwise classpath settings for scaffolded projects will not resolve classes correctly.

Configuring Transact Manager Permissions​

To access SDK functionality in Transact Manager, each application developer must be provisioned a role or roles which have one or more of the following Transact Manager permissions.

  • REST Application Package API
  • REST Delivery Service API
  • REST Form Groups API
  • REST Groovy Service Invoke
  • REST Service Definitions API

For security reasons, none of these permissions are assigned by default to existing Transact Manager roles; therefore, suitable roles must be assigned to user accounts manually.

Best practice is to create a new role or roles, such as 'IDE Developer' and assign permissions to the Transact Manager module as required.

Assigning roles and permissions in Transact Manager

To provide even finer granularity, create roles such as 'IDE Application Package Developer' and assign individual permissions to it.