Configure IntelliJ IDEA

IntelliJ IDEA ships with built-in Groovy and Ant so you don't need to do much to prepare your IDE.

caution

IntelliJ refers to its Java JDK as an SDK, so take care not to confuse the Transact SDK with IntelliJ's SDK.

The following steps outline how to prepare IntelliJ IDEA for Transact application development.

• Open the Transact SDK project – the SDK includes libraries and a scaffold task to create your own projects.
• Configure a JDK (if necessary) – you can skip this step if you already have a JDK configured.
• Create a Transact SDK global library – this library contains the Transact SDK JAR files.
• Scaffold a new project – this new project is where you will build your Transact Application.
• Add the Transact SDK libraries to the scaffolded project – this enables the Ant tasks to resolve required classes.

Open the Transact SDK project

1. Open IntelliJ IDEA and select File > Open. Alternatively, from the Welcome page you can click the Open item.

   

   The Open File or Project dialog is displayed.

2. Browse to the Transact SDK top-level folder and select it, then click OK to open the Transact SDK project.

   

   The Transact SDK project appears in the Project panel.

   

(Optional) Configure a JDK

1. Select File > Other Settings > Default Project Structure....

   

   The Default Project Structure dialog is displayed.

2. In the left pane, select Project Settings > Project to display the Project page in the main panel.

   Select an SDK (i.e. Java JDK) from the Project SDK dropdown list and click OK.

   

   tip

   If your Java JDK is not displayed in the dropdown list or the only option is <No SDK>, you can add a new JDK (see below) and then select it from the dropdown list.

(Optional) Add a new Java JDK

If your Java JDK is not available for selection in the Project SDK dropdown list, you can add it as follows.

1. Click New... and select JDK.

   

   The Select Home Directory for JDK dialog is displayed.

2. Browse to the Java JDK's top-level directory and select it, then click OK.

   

   The selected JDK is shown as the Project SDK.

   

Create a global library containing the Transact SDK JAR files

1. Select File > Other Settings > Default Project Structure....

   

   The Default Project Structure dialog is displayed.

2. In the left pane select Platform Settings > Global Libraries then click the New Global Library icon.

   

   The Select Library Files dialog is displayed.

3. Select the lib folder under the Transact SDK top-level folder, then click OK.

   

4. Enter "Transact SDK" in the Name field then click OK to save your changes and close the dialog.

   

Scaffold a new IntelliJ project

1. Select View > Tool Windows > Ant Build to display the Ant Build pane to the right of the editor pane.

   

2. Click the Add icon in the Ant Build panel.

   

   The Select Ant Build File dialog is displayed.

3. Browse to and select the build.xml file under the Transact SDK top-level folder, then click OK.

   

   The Avoka Transact SDK tasks appear in the Ant Build pane.

   

4. In the Ant Build pane under the Avoka Transact SDK item, select the project-scaffold task and click the Run icon. Alternatively, you can double-click the project-scaffold task to run it.

   

5. Enter appropriate values for Project Name, Project Folder and Project Layout when prompted then click OK.

   

   

   

   A new project is created in a folder with the name you just entered at the same level as the Transact SDK root folder but it does not appear in the Project panel immediately. You need to open the new project.

6. Select File > Open to open the new Transact SDK project.

   

   The Open File or Project dialog is displayed.

7. Browse to the new project folder - it will be at the same folder level as the Transact SDK root folder - and select it, then click OK.

   

8. Click New Window to open the new project in a new window.

   

9. Update the transact-auth.properties file with your Transact Manager credentials.

   • In the Project pane, expand the Home Loan project item then locate and open the transact-auth.properties file.

     

   • Update the file contents with your Transact Manager credentials and server details, then save the file.

     

Configure new project with Ant dependency libraries

1. Select View > Tool Windows > Ant Build to display the Ant Build pane.

   

   The Ant Build pane is displayed to the right of the editor pane.

2. Click the Add icon in the Ant Build pane.

   

   The Select Ant Build File dialog is displayed.

3. Browse to the build.xml file under the new project folder and select it, then click OK.

   

   caution

   Take care to add the new project's build.xml file, not the main Transact SDK build.xml file.

   The new project's Ant tasks appear in the Ant Build pane.

   

4. Edit the Ant Build properties.

   Right-click the project in the Ant Build pane and select Properties.

   

   The Build File Properties dialog is displayed.

5. Select the Additional Classpath tab then click Add All in Directory.

   

   The Select Path dialog is displayed.

6. Browse to and select the lib folder under the Transact SDK top-level folder, then click OK.

   

   The selected lib folder appears in the Additional Classpath list.

   

7. Click OK to close the Build File Properties dialog.

You are now ready to scaffold content into your new project.