monday.com Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started¶

Monday Version Support

The connector leverages the Monday API to enable bidirectional access to Monday.

Establish a Connection¶

Connect to Monday¶

Monday AuditLog API¶

Monday AuditLog API only supports authentication via API Token.

To generate the audit log API token:

1. Log into your Monday account.
2. Access the Admin section.
3. Navigate to Security.
4. Click the Audit tab.
5. Click Monitor by API. Monday displays the API token.

After you retrieve the API token, set the following conenction properties:

• Schema=AuditLog
• AuthScheme=Token
• APIToken=The audit log API token you just obtained
• **Domain**=https://yourdomain.monday.com

You are now ready to connect to Monday AuditLog API.

Monday GraphQL API¶

Monday GraphQL API supports authentication via either API Token or the OAuth standard.

API Token¶

To connect to connector via an API Token, set the AuthScheme to Token and obtain the APIToken as follows:

1. Log in to your Monday account.
2. Navigate to Manage Applications in the left pane. Monday displays a list of application to manage.
3. Select the application that you would like to create a token for. You may need to create an application first.
4. To generate an APIToken, click Create token.

OAuth¶

Monday supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to Monday from three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
• Web: access to data via a shared website.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Monday, see Connection.

Desktop Applications¶

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

• InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId = the client ID assigned when you registered your application.
• OAuthClientSecret = the client secret that was assigned when you registered your application.
• CallbackURL = the redirect URI that was defined when you registered your application.

When you connect, the connector opens Monday's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector then completes the OAuth process:

1. The connector obtains an access token from Monday and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token, do the following:

1. The first time you connect to data, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client ID in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by .
   • OAuthSettingsLocation = the path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Create a Custom OAuth Application¶

To create a custom OAuth application for use in Monday:

1. Login to your Monday account dashboard.
2. Click the avatar icon and select Developers.
3. In MyApps, click Create App.
4. In the new application's Basic Information section, record the application's OAuthClientId and OAuthClientSecret.
5. In the new application's OAuth section, enable the following scopes:
   • boards:read
   • workspaces:read
   • users:read
   • account:read
   • updates:read
   • assets:read
   • tags:read
   • teams:read
6. If this will be a Desktop app, specify a redirect URL of http://localhost:3333.

GraphQL Limitations¶

Every GraphQL API has its own limitations and we can not query an arbitrarily large number of nodes because every query has a cost and the API will return an error if the connector exceeds the maximum cost. The query cost function is directly dependent on the page sizes. The connector uses its own algorithms for finding the page sizes but also gives you the freedom to tweak them based on your needs. There are two ways you can achieve this behavior:

• Specify custom page size weights by including the "other:pageSizeWeights" attribute. Let's suppose that we have a "Customers" table which has two nested GraphQl connections, businesses and customers. If you want a specific ratio between these two entities per query, let's say 200 customers per 1 business, you should specify "other:pageSizeWeights=1:200" in the respective script. The advantage of this attribute is that you do not bypass our logic for finding the optimal page size based on the query cost.
• Specify custom page sizes by including the "other:pageSizes" attribute. By specifying this attribute you will bypass any check we do for query cost, so you should be careful because there will be API errors if you exceed the maximum cost per query. Example: "other:pageSizeWeights=10,30", retrieve at most 10 businesses and at most 30 customers per business in one query.

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 Monday 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 Monday and then processes the rest of the query in memory (client-side).

User Defined Views¶

The Jitterbit Connector for Monday 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 Invoices 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¶

The Jitterbit Connector for Monday models Monday objects as relational tables and views. An Monday object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Monday APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Using GraphQL API

See GraphQL Data Model for the available entities in the GraphQL API.

Using AuditLog API

See AuditLog Data Model for the available entities in the AuditLog API.

GraphQL Data Model¶

Overview¶

The Jitterbit Connector for Monday models Monday objects as relational tables and views.

A Monday object has relationships to other objects in the tables. These relationships are expressed through foreign keys. The following sections show the available API objects and provide more information regarding executing SQL to Monday APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Views¶

Views describes the available views. Views are statically defined to model Accounts, Customers, Products, and more.

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.

Jitterbit Connector for Monday Views¶

ActivityLogs¶

The board log events.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• BoardId supports the '=, IN' operators.
• UserId supports the '=, IN' operators.
• ColumnId supports the '=, IN' operators.
• GroupId supports the '=, IN' operators.
• ItemId supports the '=, IN' operators.
• CreatedAt supports the '=, >, >=, <, <=' operators.

SELECT

SELECT * FROM ActivityLogs WHERE BoardId IN ('2307103055', '2182296646')
SELECT * FROM ActivityLogs WHERE UserId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ColumnId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE GroupId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ItemId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE CreatedAt > '2022-02-17 05:12:04.419' AND CreatedAt < '2022-02-17 05:12:04.861'

SELECT * FROM ActivityLogs WHERE CreatedAt >= '2022-02-17 05:12:04.419' AND CreatedAt <= '2022-02-17 05:12:04.861'

Columns¶

Assets¶

Get a collection of assets by ids.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

• Id supports the '=, IN' operators.

SELECT

SELECT * FROM Assets WHERE Id = '397532775'

SELECT * FROM Assets WHERE ID IN ('397532775', '397532776')

Columns¶

BoardItemsInternal¶

Get a collection of board and item IDs. This view is for internal usage only.

Columns¶

Boards¶

Get a collection of boards.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• Id supports the '=, IN' operators.
• BoardKind supports the '=' operators.

SELECT

SELECT * FROM Boards WHERE Id = '2182296646'
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030')
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030') AND BoardKind = 'public'

SELECT * FROM Boards WHERE BoardKind = 'public'

Columns¶

BoardViews¶

The board's views.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

• BoardId supports the '=, IN' operators.
• Type supports the = operator.

SELECT

SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'

SELECT * FROM BoardViews WHERE BoardId IN ('2182296646', '2181960030')

Columns¶

Columns¶

The board's visible columns.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• ID supports the '=, IN' operators.
• BoardId supports the '=, IN' operators.

SELECT

SELECT * FROM Columns WHERE ID = 'name'
SELECT * FROM Columns WHERE ID IN ('name', 'person')
SELECT * FROM Columns WHERE BoardId = '2182296646'

SELECT * FROM Columns BoardId IN ('2182296646', '2181960030')

Columns¶

ColumnValues¶

The item's column values.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

• Id supports the '=, IN' operators.
• ItemId supports the '=, IN' operators.

SELECT

SELECT * FROM ColumnValues WHERE Id = 'person'
SELECT * FROM ColumnValues WHERE Id IN ('person', 'status')
SELECT * FROM ColumnValues WHERE ItemId IN ('2181853162', '2181853151')
SELECT * FROM ColumnValues WHERE ItemId = '2181853162'

SELECT * FROM ColumnValues WHERE ItemId = '2181853162' AND ID = 'status'

Columns¶

Groups¶

The board's visible groups.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• Id supports the '=, IN' operators.
• BoardId supports the '=, IN' operators.

SELECT

SELECT * FROM Groups WHERE Id = 'topics'
SELECT * FROM Groups WHERE Id IN ('topics', 'group_title')
SELECT * FROM Groups WHERE BoardId IN ('2182296646', '21822966')

SELECT * FROM Groups WHERE BoardId = '2182296646' AND ID = 'topics'

Columns¶

Items¶

Get a collection of items.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• Id supports the '=' operators.
• BoardId supports the '=' operators.
• ColumnId supports the '=' operators.
• ColumnValue supports the '=, IN' operators.

SELECT

SELECT * FROM Items ORDER BY CreatedAt DESC
SELECT * FROM Items WHERE Id = 2181917692
SELECT * FROM Items WHERE BoardId = '2181917679' AND ColumnId = 'text' AND ColumnValue = 'test'

SELECT * FROM Items WHERE BoardId = '2181917679' AND ColumnId = 'text' AND ColumnValue IN ('Working on it', 'test')

Columns¶

Tags¶

Get a collection of tags.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

• ID supports the '=, IN' operators.
• IsPrivate supports the = operator.

SELECT

SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE IsPrivate = false
SELECT * FROM Tags WHERE ID = '13327214'

SELECT * FROM Tags WHERE ID IN ('13327214', '13327217')

Columns¶

Teams¶

Get a collection of teams.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• Id supports the '=, IN' operators.

SELECT

SELECT * FROM Teams WHERE Id = '565332'

SELECT * FROM Teams WHERE ID IN ('565332, 565333')

Columns¶

Updates¶

Get a collection of updates.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Updates

Columns¶

Users¶

Get a collection of users.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

• ID supports the '=, IN' operators.
• IsPending supports the '=' operators.
• IsGuest supports the '=' operators.
• Email supports the '=, IN' operators.

SELECT

SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE ID = '27278379'
SELECT * FROM Users WHERE ID IN ('27278379', '27278377')
SELECT * FROM Users WHERE Email = 'test@cdata.com'

SELECT * FROM Users WHERE Email IN ('test@cdata.com', 'test@gmail.com')

Columns¶

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Monday.

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

Jitterbit Connector for Monday Stored Procedures¶

GetOAuthAccessToken¶

Gets the OAuth access token from GitHub.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Gets the GitHub authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to GitHub.

Input¶

Result Set Columns¶

AuditLog Data Model¶

Overview¶

The Jitterbit Connector for Monday models Monday objects as relational tables and views.

A Monday object has relationships to other objects in the tables. These relationships are expressed through foreign keys. The following sections show the available API objects and provide more information regarding executing SQL to Monday APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Views¶

Views describes the available views. Views are statically defined to model AuditLogs.

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.

Jitterbit Connector for Monday Views¶

AuditLogs¶

The board audit log events.

Table Specific Information¶

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

• Timestamp supports the '=, >, >=, <, <=' operators.
• UserId supports the = operator.
• IpAddress supports the = operator.
• Event supports the '=, IN' operators.

All available values for the event filter are listed and explained below:

• export-board-activity-log: Logs board Activity Log export by users
• export-account-data: Logs account data export by admins
• download-attachment: Logs file downloads by users
• export-board: Logs board exports by users
• export-dashboard: Logs dashboard exports by users
• export-content-directory: Logs content directory exports by admins
• login: Logs users' logins to the system
• forgot-password: Logs users' "Forgot password?" clicks from the login page
• logout: Logs users' logouts from the system
• failed-login: Logs users' failed login attemts
• user-reactivated: Logs users' reactivation by admins
• user-deactivated: Logs users' deactivation by admins
• user-details-deleted: Logs users' deletion by admins
• user-invite: Logs users' invite from within the system
• cancel-user-invite: Logs cancelled users' invite from within the system
• user-role-change: Logs users' type change by admins
• delete-board: Logs board deletion by users
• delete-workspace: Logs workspace deletion by users
• create-team: Logs team creation by users
• delete-team: Logs team deletion by users
• security-settings-change: Logs security settings changes by admins
• board-broadcast-enabled: Logs board broadcast enablement by users
• add-user-to-team: Logs users' addition to teams by users
• remove-user-from-team: Logs users' removal from teams by users
• add-user-to-product: Logs users' addition to Work OS Products
• remove-user-from-product: Logs users' removal from Work OS Products
• add-team-to-product: Logs teams' addition to Work OS Products
• remove-team-from-product: Logs teams' removal from Work OS Products
• api-complexity-breach-over-time: Logs api calls reaching the account limit

SELECT

The following queries are executed server-side:

SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z'
SELECT * FROM AuditLogs WHERE Event IN ('export-board-activity-log', 'delete-board')
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z' AND Event = 'delete-board' AND UserId = 27 AND IpAddress = '123.123'

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 Monday:

• 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:

• 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 Invoices table:

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

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 SampleProcedure stored procedure:

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

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

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

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

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:monday: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¶

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.

Authentication

OAuth

SSL

Schema

Miscellaneous

Authentication¶

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

Schema¶

Specifies which Monday API to use.

Possible Values¶

GraphQL, AuditLog

Data Type¶

string

Default Value¶

GraphQL

Remarks¶

The available values are GraphQL and AuditLog.

AuthScheme¶

The type of authentication to use when connecting to Monday.

Possible Values¶

Token

Data Type¶

string

Default Value¶

Token

Remarks¶

• Token: Set this to perform Monday token authentication.
• OAuth: Set this to perform Monday OAuth authentication.

APIToken¶

The API token obtained from your Monday account.

Data Type¶

string

Default Value¶

""

Remarks¶

Admin Tab

If you are an admin user on your monday.com account, you are able to access your API tokens from the "Admin" tab with the following steps:

1. Log into your monday.com account.
2. Click on your avatar (picture icon) in the bottom left corner of your screen.
3. Select Admin from the resulting menu (this requires you to have admin permissions).
4. Go to the API section.
5. Generate a "API v2 Token"
6. Copy your token.

Developer Tab

If you are a member user on your monday.com account, you are able to access your API tokens from the Developer tab with the following steps:

1. Log into your monday.com account.
2. Click on your avatar (picture icon) in the bottom left corner of your screen.
3. Select Developer from the resulting menu.
4. In the top menu, click on the "Developer" dropdown menu.
5. Select the first option on the dropdown menu titled "My Access Tokens."
6. Click on the blue "Show" button to expose your API token and copy it.

Domain¶

Specify the domain of your Monday account. Required only when using AuditLog schema. Example: https://yourdomain.monday.com.

Data Type¶

string

Default Value¶

""

Remarks¶

Specify the domain of your Monday account. Required only when using AuditLog schema. Example: https://yourdomain.monday.com

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%\Monday 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%\Monday 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¶

""

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%\Monday 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%\Monday 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.

MaxPointsPerCall¶

Specifies how many points a call will cost.

Data Type¶

string

Default Value¶

1000000

Remarks¶

The total cost of your queries cannot exceed 5,000,000 points at any given time.

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 Invoices 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.