Adeptia Suite 6.2. Application Services Guide. Release Date October 16, 2014

Adeptia Suite 6.2

Application Services Guide

Release Date October 16, 2014

343 West Erie, Suite 440

Chicago, IL 60654, USA

Phone: (312) 229-1727 x111

Fax: (312) 229-1736

Document Information

DOCUMENT INFORMATION

Adeptia Inc.

Application Services Guide Printed October 2014 Printed in USA

Adeptia Support Information

For support queries, please contact us at [email protected].

Access the Adeptia Web site at the following URL:

www.adeptia.com

Copyright

Copyright © 2000-2014 Adeptia, Inc. All rights reserved.

Trademarks

Adeptia™ is a trademark of Adeptia, Inc. All other trademarks and registered trademarks are the property of their respective owners.

Confidentiality

This document is the confidential and proprietary information of Adeptia. The information set forth herein represents the confidential and proprietary information of Adeptia. Such information shall only be used for the express purpose authorized by Adeptia and shall not be published, communicated, disclosed or divulged to any person, firm, corporation or legal entity, directly or indirectly, or to any third person without the prior written consent of Adeptia.

Disclaimer

Adeptia, Inc. provides this publication "as is" without warranty of any kind, either express or implied. In no event shall Adeptia be liable for any loss of profits, loss of business, loss of use or data, interruption of business, indirect, special, punitive, incidental, or consequential damages of any kind.

No part of this work should be reproduced in any form or by any means—graphic, electronic, or mechanical—

including photocopying, recording, taping, or storage in an information retrieval system, without prior written permission of Adeptia Inc.

This publication is subject to replacement by a later edition. To determine if a later edition exists, contact www.adeptia.com.

Table of Contents

TABLE OF CONTENTS

Document Information ... 2

Table Of Contents ... 3

Preface ... 4

Using Application Services ... 7

Configuring Keystore In Adeptia Suite ... 8

Steps To Configure The Keystore In Adeptia Suite ... 8

Configuring Truststore In Adeptia Suite ... 9

Configuring Dropbox Application: ... 10

Configuring Dropbox App Keys In Adeptia Suite ... 13

Configuring Box Application ... 15

Configuring Box App Keys In Adeptia Suite ... 19

Configuring Google Drive Application ... 20

Configuring Google Drive App Keys In Adeptia Suite ... 26

Creating An Application Source Activity ... 27

Creating An Application Event Activity ... 32

Creating An Application Target Activity ... 38

Managing Application Accounts ... 43

Editing Application Accounts ... 43

Deleting Application Accounts ... 44

Preface

PREFACE

With changing trends, cloud has gained a competitive advantage. As it has reduced spending on technology infrastructure, organizations tend to store their important data and information over the cloud. To manage this data with an ease, Adeptia has introduced Application Service feature. This feature enables you to retrieve/send your data directly from/to a Cloud Application. The supported Cloud Applications include:

 Box

 Dropbox

 Google Drive

Target Audience

This document is intended for those users, who want to retrieve/send their data from/to their cloud applications. For e.g., with application services, you may automate the process of retrieving purchase orders from your Dropbox account, processing it, and sending the corresponding Sales order to your client’s Google Drive account.

This document explains how to manage Cloud data using Application Services.

How is this guide organized?

This guide is organized into the following sections:

Section Description

Document Information Introduction to this document

Preface Need for Application Services

Configuring Keystore &

Truststore

Prerequisites, configuring keystore and truststore in Adeptia Suite

Configuring Application Accounts

Steps to configure application accounts like Dropbox, Box, and Google Drive

Creating Application Source, Target, and Event Activities

Steps to create application activities

Managing Application Accounts

Explains how to edit or delete existing application accounts

Migrating Application Accounts

Considerations while migrating Application accounts

Preface

Conventions

The following tables list the various conventions used in Adeptia documentation. We follow these conventions to help you quickly and easily identify particular elements, processes, and names that occur frequently in documents.

Typographical conventions

This guide uses the following typographical conventions:

Convention Description

Bold text Indicates one of the following:

 Screen element

 New terminology

 A file or folder name

 A control in an application’s user interface

 Important information

Italic text Indicates a reference or the title of a publication.

Monospaced text Indicates code examples or system messages.

Monospaced bold text Indicates system commands that you enter.

Hyperlink Indicates an Internet link to target material.

Graphical conventions

This guide uses the following graphical conventions:

Convention Description

Indicates additional information that may be of interest to the reader.

Preface

Contacts/Reporting problems

These sections present contact information for a variety of situations.

Sales

In case of any sales queries, please contact us at [email protected].

Support

For support queries, please contact us at [email protected].

Latest updates and information

For the latest updates and information, please visit us at www.adeptia.com.

Adeptia Website

Access the Adeptia Website at the following URL:

www.adeptia.com

Using Application Services

USING APPLICATION SERVICES

Application Services enable you to create Source, Target, and Event (which will trigger the process flow) activities for cloud applications.

Application Services Include:

 Application Source

 Application Event

 Application Target

Prerequisites

 Adeptia Suite must be installed on a Public IP, which is accessible over web.

 Adeptia Suite must be accessed through HTTPS protocol. For this you need to configure Adeptia Suite Keystore to use the certificate signed by CA authority.

 You need to import the certificate of the cloud application, which you want to use within Adeptia Suite Trustsore.

 You must configure each of your Cloud Applications (Box/Dropbox/Google Drive).

This section covers:

 Configuring Keystore in Adeptia Suite

 Configuring Truststore in Adeptia Suite

 Configuring Dropbox Application

 Configuring Box Application

 Configuring Google Drive Application

 Creating an Application Source Activity

 Creating an Application Event Activity

 Creating an Application Target Activity

 Managing Application Accounts

Creating Keystore and Configuring in Adeptia Suite

CONFIGURING KEYSTORE IN ADEPTIA SUITE

To transfer data to and from cloud applications, it is mandatory that Adeptia Suite is configured on Public IP and it is accessed through HTTPS protocol. You also need to configure the Keystore with Certificate signed by CA authority.

You need to generate a new public/private key pair in default Adeptia keystore or any other keystore. Later, a Certificate Signing Request (CSR) needs to be generated and sent to a Certification Authority (CA) like VeriSign, Geotrust and Comodo. The response from the CA is then imported into keystore in which public/private key pair was generated. You can use Java Keytool for generating key, CSR and importing CA response into keystore. The advantage of using this approach is that root certificates of Certification Authority (CA) are already present in most internet browsers and widely accepted. User don’t have to manually trust these certificates when accessing Adeptia Server over SSL through internet browser.

This section explains how to configure the keystore, which contains CA signed certificate, within Adeptia Suite.

Pre-requisites

 Java keytool must be installed before you follow the steps mentioned below.

Steps to Configure the Keystore in Adeptia Suite

1. Copy the Keystore file to <Adeptia Installation folder>/ServerKernel\etc\jetty folder.

Alternately, you may place the keystore file in any folder of your choice.

2.

.

3.

Figure 1: Configuring Keystore in Adeptia Suite 4. Save this file.

5. Now restart Adeptia Suite Kernel and WebRunner and login to make sure that the process has been

successfully completed. If the keystore is configured properly, you can see a lock sign on address bar of the browser.

Configuring Dropbox Application

CONFIGURING TRUSTSTORE IN ADEPTIA SUITE

For successful communication between Adeptia Suite and cloud application, you need to import the certificates of each of the cloud applications (that you want to use) within Adeptia Suite truststore. You can download these certificates from the websites of the respective applications. You can also download Apps_Certificate.zip from the following URL.

URL : http://support.adeptia.com/entries/60546435-Cloud-Apps-Certificates This zip contains certificates for Box, Dropbox and Google Drive.

This section explains how to import these certificates within Adeptia Suite’s truststore.

1. Make sure you that have the administrative rights of the operating system.

2. Extract the downloaded zip.

3. Run the command as shown in Figure 2 and follow the wizard.

keytool -import -keystore <TruststorePath>. -file <certificatename> -alias

<aliasName>

Here:

<TrustorePath> is the path of the truststore along with its name, which is being used by Adeptia Suite. By default this path is <Adeptia Installation folder>/ServerKernel\etc/truststore/cacerts.

Figure 2: Configuring Truststore

Configuring Dropbox Application

CONFIGURING DROPBOX APPLICATION:

This section explains the process of configuring Dropbox application.

Steps to Configure Dropbox

1. Go to https://www.dropbox.com/developers.

2. Click the App Console link.

Figure 3: App Console Link 3. Sign in using your Dropbox credentials.

Figure 4: Sign-in 4. Click the Create app button.

Configuring Dropbox Application

Figure 5: Create app 5. Select the Dropbox API app radio button.

Figure 6: Type of Apps

6. Now, select Files and datastores as the type of data your app needs to store on Dropbox.

Figure 7: Dropbox Platform app

7. Select the No radio button to grant access to files already on Dropbox.

Figure 8: App Limitation

8. Select the All file Types radio button to access all types of files.

Configuring Dropbox Application

Figure 9: Type of Files 9. Enter a name for your APP for, e.g., My App.

Figure 10: Name of App 10. Click the Create app button. The following screen displays.

Figure 11: Settings Tab

You must apply for production use. Please refer the following URL for details.

https://www.dropbox.com/developers/reference/devguide.

11. Click Enable additional User.

Keep a note of the value of App Key and App Secret Key. You need to configure these values in Adeptia Suite.

Configuring Dropbox Application

12. Enter the following URL in the Redirect URIs textbox: https://50.100.205.123:8443 /app/rest/adapters/dropbox/account (see figure above).

13. Replace the highlighted part with the Domain where Adeptia Suite is installed, which will be accessed by the end user.

14. Click the Add button.

Figure 12: User Limitation 15. Click Okay to close this dialog box.

16. Now, go to Details tab and fill the information as shown below:

Figure 13: Details Tab 17. Click Save changes.

Configuring Dropbox App keys in Adeptia Suite

1. Go to <Adeptia Suite Installation folder>\AdeptiaServer\ServerKernel\etc folder.

Configuring Dropbox Application

2. Open the adapter.properties file and configure the Dropbox app key as shown in the figure below:

Figure 14: Adapter.properties File 3. Save the file.

4. Restart Adeptia Suite’s Kernel and WebRunner.

Configuring Box Application

CONFIGURING BOX APPLICATION

This section explains the process of configuring Box application.

Steps to Configure Box

1. Go to https://developers.box.com/.

Figure 15: Home Page

2. Click the My Apps link.

3. Log into Box account using your credentials.

Figure 16: Log-in page

4. Within the Applications section, click Create a Box Application link.

Configuring Box Application

Figure 17: Create a Box Application 5. Enter a name for the App in the provided textbox.

Figure 18: App Name 6. Select the Box Content radio button.

7. Click the Create Application button.

Configuring Box Application

Figure 19: Successful Creation

8. Click the Configure your application button.

9. Enter the required information as shown in the figure below.

Figure 20: General Information

10. Enter the Oauth2 Parameters as shown in the figure below.

Configuring Box Application

Figure 21 : OAuth2 Parameters

11. Enter the following URL in the redirect_uri textbox:

https://50.100.205.123:8443/app/rest/adapters/box/account (see figure above).

12. Replace the highlighted part with the Domain where Adeptia Suite is installed, which will be accessed by the end user.

 Do not change the client_secret key. It gets populated automatically.

 Keep a note of the value of client_id (App Key) and client_secret (App Secret Key).

You need to configure these values in Adeptia Suite.

13. Go at the end of the page and click the Save Application button.

Configuring Box Application

Configuring Box App keys in Adeptia Suite

1. Go to <Adeptia Suite Installation folder>\AdeptiaServer\ServerKernel\etc folder.

2. Open the adapter.properties file and configure the Box app key as shown in the figure below:

Figure 22 : Adapter.properties File 3. Save the file.

4. Restart Adeptia Suite’s Kernel and WebRunner.

Configuring Google Drive Application

CONFIGURING GOOGLE DRIVE APPLICATION

This section explains the process of configuring Google Drive application.

Steps to Configure Google Drive

1.

Figure 23: Sign in Page

2.

Configuring Google Drive Application

Figure 24: Create Project

3.

Figure 25: Projects Pane

4.

Configuring Google Drive Application

Figure 26: Create Project

5.

Figure 27: Project Details

6.

7.

8.

Configuring Google Drive Application

Figure 28: Project Dashboard

9.

10.

11.

 Big Query API

 Drive API

 Drive SDK

 Google Cloud SQL

 Google Cloud Storage

 Google Cloud Storage JSON API

 Google+ API

 Google+ Domains API

Figure 29: Enabled APIs

12.

Configuring Google Drive Application

Figure 30: Create new Client ID

13.

Figure 31: Create Client ID

Configuring Google Drive Application

Enter the Authorized Redirect URI as follows:

https://example.com:8443/app/rest/adapters/googledrive/account (see figure above).

15.

16.

Figure 32: Client ID for Web Application 17. Click the Consent screen link.

Figure 33: Consent screen

18. Select your EMAIL ADDRESS from the dropdown list.

19. Now, enter your PRODUCT NAME.

20. Click Save.

Configuring Google Drive Application

Keep a note of the value of CLIENT ID (App key) and CLIENT SECRET (appKeySecret). You need to configure these values in Adeptia Suite.

Configuring Google Drive App keys in Adeptia Suite

1. Go to <Adeptia Suite Installation folder>\AdeptiaServer\ServerKernel\etc folder.

2. Open the adapter.properties file and configure the Google Drive app key as shown in the figure below:

Figure 34: Adapter.properties File 3. Save the file.

4. Restart Adeptia Suite’s Kernel and WebRunner.

Creating Application Source Activity

CREATING AN APPLICATION SOURCE ACTIVITY

Adeptia Suite enables you to transfer data from any source location to any target location. In order to transfer any data, you need to first fetch the data. To perform the same, you need to create a Source activity. The Source activity enables you to specify the location, where the data is stored.

The Application Source activity enables you to retrieve data from the cloud applications for further transformation or processing. Through Adeptia Source Application activity, you may retrieve your invoice stored in a Dropbox application account, transform it, and send it to any supported location that you want.

This feature is available in:

Enterprise Premier Professional Express

   

Steps to create a File Source Activity

1. On the Adeptia Suite homepage, go to Develop > Services > Source and then click Application.

The Manage Application Source screen is displayed (see Figure 35).

Figure 35: Manage Application Source 2. Click the Create New link. The New Application Source screen is displayed.

3. Select the required type of cloud application from the dropdown list and then click the Next button (see Figure 36).

Creating Application Source Activity

Figure 36: New Application Source

4. Enter the name and the description of the new Application Source in the textboxes Name and Description respectively (see Figure 37).

Figure 37: New Application Source

5. Click the Add Account button to include your application account in the dropdown list.

6. Enter a name for your application account in the textbox. Your application account will appear in the list with this particular name.

7. Click the Continue button (see Figure 38).

Creating Application Source Activity

Figure 38: Add Account

8. Enter your credentials and click the Sign-in button (see Figure 39).

Figure 39: Dropbox Login 2. Click the Allow button to grant access of your account.

Creating Application Source Activity

Figure 40: Grant Access

 You may use the same application account in multiple activities, however, adding your account is required only for the first time. Once you add it, the next time you can simply choose your account from the Application Account dropdown list, without entering your credentials or allowing access every time.

 If you do not already have an application account, after clicking Continue button, you may click the Create an account link to register for the same (see Figure 39).

 To edit or delete your existing Application Accounts, please refer the Managing Application Accounts section.

3. You may click the Test button to verify a successful connection with your Application Account.

This feature helps you to avoid the failure of this activity while executing the process flow. To test this activity, select an application account and click Test. If the Application Account specified in this activity exists, the test will be successful, otherwise it will give an error.

4. Click the Browse button of the Folder field to choose the folder location within your application account from where you want to retrieve data (see Figure 41).

Creating Application Source Activity

Figure 41: Select Folder

5. Click the Submit button.

6. Enter the source file name in the File Name field.

7. Click the Advance Properties to set the values of the advance properties related with Application Source Activity.

8. Select the Delete File on Success checkbox, if you want to delete the source file after it is used in the process flow execution. This selection will delete the source file once the process flow is executed successfully during the process flow execution.

To learn about Advanced Properties refer to Changing Advanced Properties section of the Developer Guide.

9. Click the Save button. The Application source activity will be created and the dialog box will be closed.

Creating Application Event Activity

CREATING AN APPLICATION EVENT ACTIVITY

Events are used to schedule and trigger a process flow. Events enable you to specify when and how frequently the process flow should be executed on a recurring basis.

Application Event activity enables you to automate the processing/transforming/moving of data stored on the cloud applications. It specifies, when and how frequently a process flow should be executed based on creation of a new file.

This feature is available in:

Enterprise Premier Professional Express

   

Steps to create an Application Event

1. On the Adeptia Suite homepage menu, click the Develop tab.

2. Go to Events > Application.

The Manage Application Event screen is displayed (see Figure 42).

Figure 42: Manage Application Event 3. Click the Create New link. The New Application Event screen is displayed.

Creating Application Event Activity

Figure 43: New Application Event

4. Select the required type of application from the dropdown list and then click the Next button (see Figure 43).

5. Enter the name and the description of the new Application Event activity in the textboxes Name and Description respectively.

Figure 44: New Application Event

2. Select the trigger type from the dropdown list Trigger Type. Presently we only support New File in Directory trigger type. The effect on the selection is listed in the table below.

Table 1: Trigger Type Selection Values Trigger Type Selection Description

New File in Directory To configure the file event to check for the creation of a new file(s).

3. Click the Add Account button to include your required application account in the dropdown list.

4. Enter a name for your event application account in the textbox. Your application account will appear in the list with this particular name.

5. Click the Continue button (see Figure 45).

Creating Application Event Activity

Figure 45: Add Account

6. Enter your credentials and click the Sign-in button (see Figure 46).

Figure 46: Dropbox Login 1. Click the Allow button to grant access for your account (see Figure 47).

Creating Application Event Activity

Figure 47: Grant Access

 You may use the same application account in multiple activities, however, adding your account is required only for the first time. Once you add it, the next time you can simply choose your account from the Application Account dropdown list, without entering your credentials or allowing access every time.

 If you do not already have an application account, after clicking Continue button, you may click the Create an account link to register for the same (see Figure 46).

 To edit or delete your existing Application Accounts, please refer the Managing Application Accounts section.

2. You may click the Test button to verify a successful connection with your Application Account.

This feature helps you to avoid the failure of this activity while executing the process flow.

To test this activity, select an application account and click Test. If the Application Account specified in this activity exists, the test will be successful, otherwise it will give an error.

3. Click the Browse button of the Folder field to choose the folder location within your application account where you want to send data (see Figure 48).

Creating Application Event Activity

Figure 48: Select Folder

4. Enter the file name that the Application event needs to verify in the textbox Search Criteria. For example *.txt is entered in Search Criteria, to include all the text files on a particular location. To specify more than one file in Search Criteria, you can use regular expressions listed in the table below.

Table 2: Expressions used in Search Criteria Expression Description

*.* For all files with some extension

* For all files in a directory

a*.txt For files starting with a and having extension txt (e.g. arch.txt)

a??????.txt For files starting with a and have 6 more character followed by txt extension (e.g. archive.txt)

a[1-9] For a1, a2 ,a3 …………..a9

b[aiu]t For bat, bit or but

a.txt, a.doc For two files named as a.txt and a.doc

If more than one file is specified in the Search Criteria field, process flow will triggered for each file.

5. Enter the time interval for which Application event will check for the arrival of any file or upon modification of existing file in the Polling Frequency field. Enter the digit in the Frequency field and select the unit of time i.e.

Creating Application Event Activity

Recommended minimum Polling Frequency is 30 seconds.

To learn about Advanced Properties refer to Changing Advanced Properties section.

6. Click the Save button.

On the Application Event Manage page, you can view the details of the process flow associated with an application event, to do so, click the view link, under the PF column.

Creating Application Target Activity

CREATING AN APPLICATION TARGET ACTIVITY

Adeptia Suite enables you to transfer data from any source location to any target location. Once you have fetched the data (by creating a source activity) and defined the file format for the source data or the target data (by creating a schema), you will be required to create a target activity. A Target Activity allows you to identify specific data that you can create and the means to deliver it.

The Application Target activity provides the ability to specify a cloud location as a target activity.

This feature is available in:

Enterprise Premier Professional Express

   

Steps to create an Application Target Activity

1. On the Adeptia Suite homepage, click the Develop tab.

2. Go to Services > Target and then click Application.

The Manage Application Target screen is displayed (see Figure 49).

Figure 49: Manage Application Target 7. Click the Create New link. The New Application Target screen is displayed.

8. Select the required type of application from the dropdown list and then click the Next button (see Figure 50).

Creating Application Target Activity

Figure 50: New Application Target

9. Enter the name and description of the new Application Target in the textboxes Name and Description respectively.

Figure 51: New Application Target

10. Click the Add Account button to include your target application account in the dropdown list.

11. Enter a name for your application account in the textbox. Your application account will appear in the list with this particular name.

12. Click the Continue button (see Figure 52).

Creating Application Target Activity

Figure 52: Add Account 13. Enter your credentials and click the Sign-in button (see Figure 53).

Figure 53: Dropbox Login 14. Click the Allow button to grant access for your account (see Figure 54).

Creating Application Target Activity

Figure 54: Grant Access

 You may use the same application account in multiple activities, however, adding your account is required only for the first time. Once you add it, the next time you can simply choose your account from the Application Account dropdown list, without entering your credentials or allowing access every time.

 If you do not already have an application account, after clicking Continue button, you may click the Create an account link to register for the same (see Figure 53).

 To edit or delete your existing Application Accounts, please refer the Managing Application Accounts section.

15. You may click the Test button to verify a successful connection with your Application Account.

This feature helps you to avoid the failure of this activity while executing the process flow.

To test this activity, select an application account and click Test. If the Application Account specified in this activity exists, the test will be successful, otherwise it will give an error.

16. Click the Browse button of the Folder field to choose the folder location within your application account where you want to send data (see Figure 55).

Creating Application Target Activity

Figure 55: Select Folder

17. Click the Submit button.

18. Enter the name of the target file in the textbox File Name.

19. If you want to append date and time stamp in the target file name, then select the date and time stamp from the dropdown list Time Stamp.

20. Click Advanced Properties to expand the hierarchy. All items in Advance Properties are displayed.

To learn about Advanced Properties refer to Changing Advanced Properties section.

21. Click the Save button.

Managing Application Account

MANAGING APPLICATION ACCOUNTS

A list of application accounts is also displayed on the Application Accounts page, you can manage your application accounts from here. Through this page you may edit or delete the existing application accounts.

Editing Application Accounts

To edit an existing application account, follow the steps below:

1. Go to Services > Connector and then click Application Accounts.

2. On the Application Accounts page, click the Action field (see figure below).

Figure 56: Application Accounts Page

Figure 57: Edit Account

Managing Application Account

Figure 58: Log in Screen

5. Log in and click the Authorize Button.

6. Now, click the Grant access to Box button.

Figure 59: Grant Access

Dele ting Application Accounts

To delete an existing application account, follow the steps below:

1. On the Application Accounts page, enable the checkbox to select the account that you want to delete.

2. Click the Delete icon .

Migrating Application Account

MIGRATING APPLICATION ACCOUNTS

At times while working with application services, you may come across a situation, where you need to transfer the objects across multiple environments. For this, Adeptia offers a Migration utility which facilitates you to seamlessly migrate objects.

To learn how to migrate objects, please refer to the Migration Utility guide.

Prerequisites

 The following steps need to be performed on both source as well as target environment:

 Configuring Keystore in Adeptia Suite

 Configuring Truststore in Adeptia Suite

 Configuring Dropbox Application

 Configuring Box Application

 Configuring Google Drive Application

 Creating an Application Source Activity

 While configuring cloud applications on target environment make sure you enter the respective URL in the Redirect URIs textbox. For, e.g., https://50.100.205.123:8443 /app/rest/adapters/dropbox/account.

Application accounts are environment specific, so, whenever you export your application account objects from one environment, and migrate them to another one, make sure you edit them to refresh their attributes after moving.