Asana Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8895 of the connector.

Get Started¶

Asana Version Support

The connector leverages the Asana API to enable bidirectional access to Asana work management entities.

Establish a Connection¶

Connect to Asana¶

You can optionally set the following to refine the data returned from Asana.

• WorkspaceId: The globally unique identifier (gid) associated with your Asana Workspace to only return projects from the specified Workspace. To get your Workspace Id, navigate to https://app.asana.com/api/1.0/workspaces while logged into Asana. This displays a JSON object containing your Workspace name and Id.
• ProjectId: The globally unique identifier (gid) associated with your Asana Project to only return data mapped under the specified Project. Project Ids can be found in the URL of your project's Overview page. This will be the numbers directly after /0/.

Authenticate to Asana¶

Asana uses the OAuth authentication standard.

User Accounts (OAuth)¶

AuthScheme must be set to OAuth in all user account flows.

Desktop Applications¶

provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId (custom applications only): The client ID assigned when you registered your app.
• OAuthClientSecret (custom applications only): The client secret assigned when you registered your app.
• CallbackURL (custom application only): The redirect URI defined when you registered your app. For example: https://localhost:3333

When you connect, the connector opens Asana's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. The connector obtains an access token from Asana and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Service Accounts¶

To authenticate with a Server Account (Enterprise only), use a Personal Access Token by setting these connection properties:

• InitiateOAuth: OFF.
• OAuthAccessToken: Your access token value.

For more more information, see the Asana documentation for personal access tokens and service accounts.

Create a Custom OAuth App¶

To obtain an OAuthClientId, OAuthClientSecret, and CallbackURL, you first need to create an app linked to your Asana account.

To create an app linked to your Asana account:

1. Log in to your Asana account.
2. Navigate to My profile Settings > Apps > Manage Developer Apps or https://app.asana.com/0/developer-console.
3. Under My apps, select New app. Specify the app name, then select Create app.
4. Once your app created, set Redirect URL to http://localhost:33333 (or a different available port of your choice), then select add.

Once you are done with creating a new app, it will be displayed on your screen. From there, you can click View Client ID to reveal your newly created app's OAuthClientId and OAuthClientSecret.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the Asana connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Asana and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views¶

The Asana connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM projects WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

Overview

This section shows the available API objects and provides more information on executing SQL to Asana APIs.

Key Features

• The connector models Asana entities as relational views, allowing you to write SQL to query Asana data.
• Stored procedures allow you to execute operations to Asana, including retrieving the access token and keeping it refreshed in OAuth 2.0.
• Live connectivity to these objects means any changes to your Asana account are immediately reflected when using the connector.
• IncludeCustomFields connection property allows you to retrieve custom fields for Tasks view. Set this property to True, to enable this feature.

Views

Views describes the available views. Views are statically defined to model Projects, Users, Workspaces, and more.

Stored Procedures

Stored Procedures are function-like interfaces to Asana. Stored procedures allow you to execute operations to Asana, including downloading documents and moving envelopes.

Tables¶

The connector models the data in Asana as a list of tables in a relational database that can be queried using standard SQL statements.

Asana Connector Tables¶

Attachments¶

To Delete and Query from the Attachments in the tasks.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The TaskId or ID is required to make a request and the rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• TaskId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Attachments WHERE Id = '1134618934491707'

SELECT * FROM Attachments WHERE TaskId = '1128092964672854'

Delete¶

Following is an example of how to delete from Attachments table:

DELETE FROM Attachments WHERE ID = '1134618934491707'

Columns¶

GoalMembership¶

To Create, Delete and Query memberships in the Goal.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• GoalId supports the '=' comparison.
• MemberId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM GoalMembership

SELECT * FROM GoalMembership WHERE Id = '1126938837961834'

SELECT * FROM GoalMembership WHERE MemberId = '1126938837961830'

SELECT * FROM GoalMembership WHERE GoalId = '1126938691750986'

Insert¶

GoalId and MemberId is a mandatory column for inserting into GoalMembership table. For example:

INSERT INTO GoalMembership (GoalId, MemberId) VALUES ('1161963899354167', '1126938837961830')

Delete¶

Following is an example of how to delete from GoalMembership table:

DELETE FROM GoalMembership WHERE ID = '1161963899354167'

Columns¶

Goals¶

To Create, Update, Delete and Query the Goals table.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• IsWorkspaceLevel supports the '=' comparison.
• TeamId supports the '=' comparison.
• TimeId supports the '=' comparison.
• WorkspaceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Goals

SELECT * FROM Goals WHERE Id = '1126938837961834'

SELECT * FROM Goals WHERE IsWorkspaceLevel = 'false'

SELECT * FROM Goals WHERE TeamId = '122334345323466' AND WorkspaceId = '1126938837961830'

SELECT * FROM Goals WHERE TimeId = '1243436322145547'

SELECT * FROM Goals WHERE WorkspaceId = '1126938837961830'

Insert¶

UserId and Goals is a mandatory column for inserting into Goals table. For example:

INSERT INTO Goals (Name, DueOn, StartOn, IsWorkspaceLevel, liked, WorkspaceId, OwnerId, TimePeriodId) VALUES ('Sample Goal', '2023-10-31', '2023-09-15', 'false', 'false', '1203124527069362', '1203124437606434', '1203124434984659' )

Update¶

Following is an example of how to update a Goals table:

UPDATE Goals SET DueOn ='2023-10-20' WHERE ID = '1128092864672888'

Delete¶

Following is an example of how to delete from Goals table:

DELETE FROM Goals WHERE ID = '1161963899354167'

Columns¶

PortfolioItems¶

To Create, delete, and Query Items in the Portfolio.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The PortfolioId is required to make a request and rest of the filter is executed client side within the connector.

• PortfolioId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PortfolioItems WHERE PortfolioId = '1173026173301164'

Insert¶

ProjectId and PortfolioId is a mandatory column for inserting into PortfolioItems table. For example:

INSERT INTO PortfolioItems (ProjectId, PortfolioId) VALUES ('1173023668354420', '1173026173301164')

Delete¶

Following is an example of how to delete from PortfolioItems table:

DELETE FROM PortfolioItems WHERE ProjectId = '1173023668354420' AND PortfolioId = '1173026173301164'

Columns¶

PortfolioMembership¶

To Create, Delete and Query memberships in the Portfolio.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The [WorkspaceId AND UserId] OR PortfolioId OR ID is required to make a request and rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• WorkspaceId supports the '=' comparison.
• UserId supports the '=' comparison.
• PortfolioId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PortfolioMembership WHERE WorkspaceId = '1172686716695308' AND UserId = '1172686741877880'

SELECT * FROM PortfolioMembership WHERE PortfolioId = '1172684730399265'

SELECT * FROM PortfolioMembership WHERE ID = '1172684730399266'

Insert¶

PortfolioId and UserId is a mandatory column for inserting into PortfolioMembership table. For example:

INSERT INTO PortfolioMembership (PortfolioId, UserId) VALUES ('1172684730399265', '1172686741877880')

Delete¶

Following is an example of how to delete from PortfolioMembership table:

DELETE FROM PortfolioMembership WHERE PortfolioId = '1172684730399265' AND UserId = '1172686741877880'

Columns¶

Portfolios¶

To Create, update, delete, and query from Portfolios table.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The [WorkspaceId AND OwnerId] OR ID is required to make a request and rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• WorkspaceId supports the '=' comparison.
• OwnerId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Portfolios WHERE WorkspaceId = '1172686716695308' AND OwnerId = '1172686741877880'

SELECT * FROM Portfolios WHERE Id = '1172684730399265'

Insert¶

WorkspaceId is a mandatory column for inserting into Portfolios table. For example:

INSERT INTO Portfolios (Name, Color, WorkspaceId)  VALUES ('Test', 'dark-pink', '1172686716695308'

Update¶

Following is an example of how to update a Portfolios table:

"UPDATE Portfolios SET Name = 'IT-Test' WHERE ID = '1173026173301164'

Delete¶

Following is an example of how to delete from Portfolios table:

DELETE FROM Portfolios WHERE ID = '1172684730399265'

Columns¶

ProjectMembership¶

To Create, Delete and Query memberships in the Project.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• ProjectId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ProjectMembership WHERE Id = '1127092449876445'

SELECT * FROM ProjectMembership WHERE ProjectId = '1127092449876444'

Insert¶

UserId and ProjectId is a mandatory column for inserting into ProjectMembership table. For example:

INSERT INTO ProjectMembership (UserId, ProjectId) VALUES ('1161963899354167', '1128092964672848')

Delete¶

Following is an example of how to delete from ProjectMembership table:

DELETE FROM ProjectMembership WHERE UserId = '1161963899354167' AND ProjectId = '1128092964672848'

Columns¶

Projects¶

To Create, Update, Delete and Query the Projects table.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• workspaceId supports the '=' comparison.
• TaskId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM projects WHERE workspaceId = '1126938837961830'

SELECT * FROM projects WHERE Id = '1128092864672888'

SELECT * FROM projects WHERE TaskId = '1130092964672468'

Insert¶

WorkspaceId or TeamId is a mandatory column for inserting into Projects table. For example:

INSERT INTO Projects (Name, Color, StartOn, WorkspaceId, DueOn, public, UserId) VALUES ('ProjectName', 'dark-pink', '2020-03-01', '1126938837961830', '2020-04-30', false, '1130062547672468')

Update¶

Following is an example of how to update a Projects table:

UPDATE Projects SET TeamId = '1129514033997890' WHERE ID = '1128092864672888'

Delete¶

Following is an example of how to delete from Projects table:

DELETE FROM Projects WHERE ID = '1128092864672888'

Columns¶

ProjectStatuses¶

To Create, Delete and Query from ProjectStatuses table. A project status is an update on the progress of a particular project, and is sent out to all project followers when created.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• ProjectId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ProjectStatuses WHERE Id = '1127092449876445'

SELECT * FROM ProjectStatuses WHERE ProjectId = '1127092449876444'

Insert¶

ProjectId is a mandatory column for inserting into ProjectStatuses table. For example:

INSERT INTO projectstatuses (Color, Title, Text, ProjectId) VALUES ('red', 'Status1', 'StatusNotes', '1127092449876444')

Delete¶

Following is an example of how to delete from ProjectStatuses table:

DELETE FROM ProjectStatuses WHERE ID = '1127092449876445'

Columns¶

Sections¶

To Create, Update, Delete, and Query from Sections table. A section is a subdivision of a project that groups tasks together.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• ProjectId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Sections WHERE Id = '1127092449876457'

SELECT * FROM Sections WHERE ProjectId = '1128092964672848'

Insert¶

ProjectId is a mandatory column for inserting into Sections table. For example:

INSERT INTO Sections (Name, ProjectId) VALUES ('SectionName', '1128092964672848')

Update¶

Following is an example of how to update a Sections table:

UPDATE Sections SET Name = 'IT-Pending' WHERE ID = '1127092449876457'

Delete¶

Following is an example of how to delete from Sections table:

DELETE FROM Sections WHERE ID = '1127092449876457'

Columns¶

Stories¶

To Create, Update, Delete and Query from stories table. A story represents an activity associated with an object in the Asana system. Stories are generated by the system whenever users take actions such as creating or assigning tasks, or moving tasks between projects.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The TaskId or ID is required to make a request and rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• TaskId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Stories WHERE Id = '1126938691750986'

SELECT * FROM Stories WHERE TaskId = '1129514033997892'

Insert¶

TaskId is a mandatory column for inserting into Stories table. For example:

INSERT INTO Stories (Text, TaskId, IsPinned) VALUES ('InProgress', '1129514033997892', false)

Update¶

Following is an example of how to update a Stories table:

UPDATE Stories SET Text = 'story line' WHERE ID = '1126938691750986'

Delete¶

Following is an example of how to delete from Stories table:

DELETE FROM Stories WHERE ID = '1126938691750986'

Columns¶

SubTasks¶

To Create, update, delete, and query from SubTasks table.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• ParentTaskId supports the '=' comparison.

For example, the following query is processed on server side and it is a required filter:

SELECT * FROM SubTasks WHERE ParentTaskId = '1127092449876457'

A simple SELECT query will only return the first level of subtasks.

SELECT * FROM SubTasks

There may be up to five levels of subtasks below a task. (Note, Asana does not recommend using sub-subtasks). If additional levels of subtasks are needed, a subquery can be used:

SELECT * FROM SubTasks WHERE ParentTaskId IN (SELECT ID FROM SubTasks)

When executing a query without a ParentTaskId filter, due to the Asana API design, subtasks are only retrieved on a per task basis. The connector will first query the workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. Another request will be made for each task to retrieve any subtasks associated with the task. In theory, this is similar to executing the following query:

SELECT * FROM SubTasks WHERE ParentTaskId IN (SELECT ID FROM Tasks WHERE ProjectId IN (SELECT ID FROM Projects))

Due to the number of required requests, performance may be impacted.

Insert¶

ParentTaskId is a mandatory column for inserting into Projects table. For example:

INSERT INTO SubTasks (ParentTaskId, Name, Assignee, AssigneeStatus, startOn, DueOn, Completed, ProjectId, Notes, ApprovalStatus, Followers) VALUES ('1167713816822372', 'subtask1', '1167715005778471', 'later', '2020-03-25', '2020-04-01', false, 1167713816822364, 'SubTask Notes', 'changes_requested', '1167715005778471')

Columns¶

Tags¶

To Create, Update and Query from Tags table. A tag is a label that can be attached to any task in Asana. It exists in a single workspace.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• WorkspaceId supports the '=' comparison.
• TaskId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Tags WHERE Id = '1129517083601713'

SELECT * FROM Tags WHERE WorkspaceId = '1126938837961830'

SELECT * FROM Tags WHERE TaskId = '1128092964672854'

Insert¶

Workspaceid is a mandatory column for inserting into Tags table. For example:

INSERT INTO Tags (Name, Color, WorkspaceId, Notes) VALUES ('TestTag', 'dark-blue', '1126938837961830', 'sample notes')

Update¶

Following is an example of how to update a Tags table:

UPDATE Tags SET Name = 'IT-1' WHERE ID = '1158271967831255'

Columns¶

Tasks¶

To Create, Update, Delete and Query from Tasks table.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• ProjectId supports the '=' comparison.
• Assignee supports the '=' comparison.
• TagId supports the '=' comparison.
• SectionId supports the '=' comparison.
• UserTaskListId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Tasks WHERE Id = '1127092449876457'

SELECT * FROM Tasks WHERE ProjectId = '1128092964672848'

SELECT * FROM Tasks WHERE Assignee = '1126938691750986' AND WorkspaceId = '1126938837961830'

SELECT * FROM Tasks WHERE Assignee = '1126938691750986'

SELECT * FROM tasks WHERE TagId = '1129517083601713'

SELECT * FROM tasks WHERE SectionId = '1127092449876457'

SELECT * FROM tasks WHERE UserTaskListId = '1126938837961837'

When executing a query without one of the above filters, due to the Asana API design, tasks must be retrieved per project. The connector will first query the workspace to retrieve a list of projects. A separate request will then be made for each project to retrieve all the applicable tasks. In theory, this is similar to executing the following query:

SELECT * FROM Tasks WHERE ProjectId IN (SELECT ID FROM Projects)

Due to the number of required requests, performance may be impacted. Note, tasks may also be orphaned and not belong to a project. The connector will not be able to retrieve orphaned tasks.

Insert¶

ProjectId is a mandatory column for inserting into Tasks table. For example:

INSERT INTO Tasks (Name, Assignee, AssigneeStatus, startOn, DueOn, Completed, ProjectId, Notes, ApprovalStatus, Followers) VALUES ('Task1', '1167715005778471', 'later', '2020-03-25', '2020-04-01', false, 1167713816822364, 'TaskNotes', 'changes_requested', '1167715005778471')

Update¶

Following is an example of how to update a Tasks table:

UPDATE Tasks SET Browser = 'ie' WHERE ID = '1167713816822371'

Delete¶

Following is an example of how to delete from Tasks table:

DELETE FROM Tasks WHERE ID = '1167713816822371'

Columns¶

TeamMembership¶

To represents a users connection to a team.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• UserId supports the '=' comparison.
• WorkspaceId supports the '=' comparison.
• TeamId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TeamMembership WHERE UserId = '1126938691750986' AND WorkspaceId = '1126938837961830'

SELECT * FROM TeamMembership WHERE TeamId = '1126938837961832'

SELECT * FROM TeamMembership WHERE Id = '1126938837961832'

Insert¶

UserId and TeamId is a mandatory column for inserting into TeamMembership table. For example:

INSERT INTO TeamMembership (UserId, TeamId) VALUES ('1161963899354167', '1126938837961832')

Delete¶

Following is an example of how to delete from TeamMembership table:

DELETE FROM TeamMembership WHERE UserId = '1161963899354167' AND TeamId = '1126938837961832'

Columns¶

Teams¶

A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• WorkspaceId supports the '=' comparison.
• UserId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Teams WHERE Id = '1126938837961832'

SELECT * FROM Teams WHERE WorkspaceId = '1126938837961830'

SELECT * FROM Teams WHERE UserId = '1126938691750986' AND workspaceid = '1126938837961830'

Insert¶

WorkspaceId is a mandatory column for inserting into Teams table.In the WorkspaceId only the organisation ID can be used to create teams. Teams can not be created for workspaces which are not part of a organisation. For example:

INSERT INTO Teams (Name, Description, HTMLDescrption, WorkspaceId) VALUES ('Salessssk', 'sales developers should be members of this team.', '<body> <em>All</em> developers should be members of this team.</body>', '1126938837961830')

Columns¶

WorkspaceMembership¶

To Create, Delete and Query memberships in the Workspace.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• UserId supports the '=' comparison.
• WorkspaceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkspaceMembership WHERE WorkspaceId = '1126938837961830'

SELECT * FROM WorkspaceMembership WHERE UserId = '1126938691750986'

SELECT * FROM WorkspaceMembership WHERE ID = '1126938837961834'

Insert¶

UserId and WorkspaceId is a mandatory column for inserting into WorkspaceMembership table. For example:

INSERT INTO WorkspaceMembership (UserId, WorkspaceId) VALUES ('1161963899354167', '1126938837961830')

Delete¶

Following is an example of how to delete from WorkspaceMembership table:

DELETE FROM WorkspaceMembership WHERE UserId = '1161963899354167' AND WorkspaceId = '1126938837961830'

Columns¶

Workspaces¶

To Update and Query from Workspaces table. A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• UserId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Workspaces WHERE Id = '1126938837961835'

SELECT * FROM Workspaces WHERE UserId = '1126938691750986'

Update¶

Following is an example of how to update a Workspaces table:

UPDATE Workspaces SET Name = 'IT-Eng' WHERE ID = '1126938837961835'

Columns¶

Views¶

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Asana Connector Views¶

CustomFields¶

To view the Custom Fields in the project.

Table Specific Information¶

Select¶

The connector uses the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side in the connector.

• ProjectId supports the '=' comparison.

For example, the following query is processed server side:

SELECT * FROM CustomFields WHERE ProjectId = '1126938691750986'

Columns¶

Events¶

To view the events in projects and tasks.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The resource ID will be either Project or Task Id. The rest of the filter is executed client side within the connector.

• ResourceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Events WHERE ResourceId = '1128092964672854'

Columns¶

ProjectFollowers¶

To view the Project follower details.

Columns¶

ProjectTemplates¶

TO get ProjectTemplates in the Team or workspace.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TaskStatuses¶

Get task count of a project.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• ProjectId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TaskStatuses WHERE ProjectId = '1136437449978157'

Columns¶

Users¶

To view the users details.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• WorkspaceId supports the '=' comparison.
• TeamId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE Id = '1126938691750986'

SELECT * FROM Users WHERE WorkspaceId = '1126938837961835'

SELECT * FROM Users WHERE TeamId = '1129514033997892'

Columns¶

UserTaskList¶

Generated schema file.

Table Specific Information¶

Select¶

The connector will use the Asana API to process WHERE clause conditions built with the following column and operator. The [UserId and workspaceId] or ID is required to make a request and the rest of the filter is executed client side within the connector.

• Id supports the '=' comparison.
• UserId supports the '=' comparison.
• workspaceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM UserTaskList WHERE Id = '1126938837961837'

SELECT * FROM UserTaskList WHERE UserId = '1126938691750986' AND workspaceId = '1126938837961830'

Columns¶

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Asana.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Asana, along with an indication of whether the procedure succeeded or failed.

Asana Connector Stored Procedures¶

AddDependenciesToTask¶

To set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 15 dependencies.

Input¶

Result Set Columns¶

AddDependentsToTask¶

To Set or Unlink dependents to the task.

Input¶

Result Set Columns¶

AddFollowers¶

To add followers to the tasks or projects.

Input¶

Result Set Columns¶

AddProjectToTask¶

Add a project to a task.

Input¶

Result Set Columns¶

AddTagsToTask¶

To Set or Unlink dependents to the task.

Input¶

Result Set Columns¶

AddTaskToSection¶

Add a task to a specific, existing section. This will remove the task from other sections of the project.

Input¶

DownloadAttachment¶

To Download an Attachment.

Input¶

Result Set Columns¶

DuplicateProject¶

To create a duplicate copy of the project.

Input¶

Result Set Columns¶

DuplicateTask¶

To Set or Unlink dependencies to the task.

Input¶

Result Set Columns¶

GetOAuthAccessToken¶

Gets an authentication token from Asana.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input¶

Result Set Columns¶

MoveSectionsinProject¶

To reorder the section in the project.

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with Asana.

Input¶

Result Set Columns¶

RemoveDependenciesFromTask¶

To Set or Unlink dependencies to the task.

Input¶

Result Set Columns¶

RemoveDependentsFromTask¶

To Set or Unlink dependents to the task.

Input¶

Result Set Columns¶

RemoveFollowers¶

To remove followers from the tasks or projects.

Input¶

Result Set Columns¶

RemoveProjectsFromTask¶

Remove a project from a task.

Input¶

Result Set Columns¶

RemoveTagsFromTask¶

To Set or Unlink dependents to the task.

Input¶

Result Set Columns¶

SetParentofTask¶

To Set the parent of a task.

Input¶

Result Set Columns¶

UploadAttachment¶

Uploads an Attachment to Asana.

Input¶

Result Set Columns¶

System Tables¶

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables¶

The following tables return database metadata for Asana:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables¶

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables¶

The following table returns query statistics for data modification queries, including batch operations:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

The following query returns the columns and data types for the projects table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='projects'

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the UploadAttachment stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='UploadAttachment' AND Direction=1 OR Direction=2

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

The following query retrieves the primary key for the projects table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='projects'

Columns¶

sys_foreignkeys¶

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

sys_primarykeys¶

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

sys_connection_props¶

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:asana:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

sys_sqlinfo¶

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns¶

sys_identity¶

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns¶

sys_information¶

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns¶

Advanced Configurations Properties¶

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Connection

OAuth

SSL

Schema

Miscellaneous

Connection¶

This section provides a complete list of connection properties you can configure.

ProjectId¶

The globally unique identifier (gid) associated with your Asana Project.

Data Type¶

string

Default Value¶

""

Remarks¶

Requests will return the data mapped under this project.

WorkspaceId¶

The globally unique identifier (gid) associated with your Asana Workspace.

Data Type¶

string

Default Value¶

""

Remarks¶

Requests will return the projects mapped under this WorkspaceId.

IncludeCustomFields¶

Custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables.

Data Type¶

bool

Default Value¶

false

Remarks¶

If set to TRUE, custom fields may be added to the Tasks, SubTasks, and PortfolioItems tables. The WorkspaceId should also be specified. Custom fields are related to a specific Workspace. If no WorkspaceId is specified, the first available WorkspaceId will be used.

OAuth¶

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\Asana Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\Asana Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

http://localhost:33333

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL¶

This section provides a complete list of SSL properties you can configure.

SSLServerCert¶

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type¶

string

Default Value¶

""

Remarks¶

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema¶

This section provides a complete list of schema properties you can configure.

Location¶

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type¶

string

Default Value¶

%APPDATA%\Asana Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\Asana Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas¶

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables¶

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views¶

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous¶

This section provides a complete list of miscellaneous properties you can configure.

MaxRows¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

Remarks¶

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting¶

PseudoColumns¶

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews¶

A filepath pointing to the JSON configuration file containing your custom views.

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM projects WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.