Odoo v2 Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8858 of the connector.

Get Started

Odoo Version Support

The connector can connect to Odoo version 8 and above. The connector leverages Odoo's XML-RPC interface which is made available by default in both the on-premise version and by many hosting services such as odoo.sh

Establish a Connection

Connect to Odoo

To connect, set the URL to a valid Odoo site, User and APIToken to the connection details of the user you are connecting with, and Database to the Odoo database. If you are not using API tokens (they are only supported in Odoo 14 and above), you can also provide the password in the APIToken field.

Access Rights

In order for the connector to determine what models you can access in Odoo, the user you connect with must have permissions to read from "ir.model.access" (an internal Odoo model that governs access rights). Normally this is reserved for administrators, but it can be granted to any user by creating a service group:

1. As an administrator, open the Odoo settings page and enable "developer mode". If this is not available you may need to login as the superuser instead.
2. Open the Groups page (under the Users dropdown) and create a new group
3. Set the Application to "Administration" and the name to "Service Access"
4. Add any users who need service access in the Users tab
5. In the Access Rights tab, add an entry for the "ir.model.access" object (it may be called "Model Access"), check Read Access, and give it the name "Inspect Models"
6. Save the group

If making this change is not possible, then you should set the CheckPermissions option to false. That will list all models in Odoo as tables, regardless of what permissions your user actually has for those models.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit 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 Odoo 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 Odoo and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Jitterbit Connector for Odoo 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 res_users 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 connector represents Odoo models as relational tables and views. The table definitions are dynamically obtained from the Odoo site you connect to, and the exact ones that will be availble to you will be different depending upon the apps you have installed. The tables listed here are only examples, which may differ from the ones available to you.

Tables

When connecting, the connector determines what models you can modify and which are read-only. Models that can be modified are represented as tables, which have support for reading, inserting, updating and deleting data.

Views

Any models that are read-only are represented as views. You can read data from them the same as you would a table, but inserting, updating and deleting are not allowed.

Many2One, One2Many and Many2Many Columns

Within Odoo, in addition to columns with simple values like text and dates, there are also columns that contain multiple values on each row. The connector decodes these kinds of values differently, depending upon the type of column the value comes from:

Many2One

Many2One columns are references to a single row within another model. Within the connector, Many2One columns are represented as integers, whose value is the ID that they refer to in the other model.

For example, the Calendar module inludes a model for events called "calendar_event", which has a column called "opportunity_id" that refers to an opportunity in the "crm_lead" model. When creating or updating a calendar event, you can set the opportunity_id to the ID of the lead the meeting is for:

INSERT INTO calendar_event (name, start, stop, opportunity_id) VALUES ('Meet With Potential Customer', '...', '...', 42)

If you were to read this event later, the value of opportunity_id would be the number 42.

Many2Many

Many2Many columns are references to many rows within another model. Within the connector, Many2Many columns are represented as text containing a comma-separated list of integers. Each value in that list is the ID of a row that is being referenced.

For example, the Calendar module inludes a model for events called "calendar_event", which has a column called "partner_ids" that refers to contacts in the "res_partner" model. When creating or updating a calendar event, you can set the partner_ids to the ids of the people who are attending the meeting:

INSERT INTO calendar_event (name, start, stop, partner_ids) VALUES ('Meet With Potential Customer', '...', '...', '13,57')

If you were to read this event later, the value of partner_ids would be the text "13,57" (or "57,13", since the ids can be in any order).

One2Many

One2Many columns are references to many rows within another model - they are similar to Many2Many columns, except that each row in the referenced model must belong to only one in the main model.

For example, the Calendar module inludes a model for events called "calendar_event", which has a column called "attendee_ids" that refers to the meeting invitations stored in the "event_attendee" model. Unlike partner_ids, where different meetings can share the same partners and different partners can go to the same meeting, each invitation is linked to just one event.

Currently, these columns are read the same was as Many2Many columns (as text containing a comma-separated list of ids), but they cannot be written to.

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 Odoo Views

FieldReferences

Retrieves both single-value and multi-value references from a table.

Columns

Stored Procedures

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

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

Jitterbit Connector for Odoo Stored Procedures

CallProcedure

Calls a server-side RPC within Odoo.

Procedure-Specific Information

Odoo exposes its RPCs using the External API. This API uses an XML-RPC method called execute_kw to call Odoo procedures on specific modules. Internally the method looks like this:

execute_kw(database, user_id, password, model, operation, arguments, keyword_args)

The connector will provide the connection information automatically, so the only parameters required for CallProcedure are the model, the operation, a list of arguments and a map of keyword arguments. The arguments and keyword arguments are provided as a JSON array and object respectively. The connector will take the result of the RPC and convert it back into JSON for the procedure output.

For example, you could call the 'read' method on the 'hr.employee' model to read information about specific employees. In this case you would retrieve the name and department for the employees with the IDs 2 and 4:

EXECUTE CallProcedure
  Model = 'hr.employee',
  Operation = 'read',
  -- The read RPC takes one argument, which is the list of IDs
  Arguments = '[[4, 2]]',
KeywordArgs = '{"fields": ["department_id", "name"]}'

Calling this procedure on the Odoo sample data will return this JSON result:

[
  {"department_id": [4, "Research & Development"], "id": 4, "name": "Sharlene Rhodes"},
  {"department_id": [4, "Research & Development"], "id": 2, "name": "Ronnie Hart"}
]

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

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

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

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

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

Columns

sys_keycolumns

Describes the primary and foreign keys.

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

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

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

SSL

Schema

Miscellaneous

Authentication

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

URL

The base URL of the Odoo site you're connecting to. For example, http://my.odoo.com/.

Data Type

string

Default Value

""

Remarks

The base URL of the Odoo site you're connecting to. For example, http://my.odoo.com/.

Database

The name of the Odoo database you're connecting to.

Data Type

string

Default Value

""

Remarks

When connecting to Odoo online, this value is usually the name of your custom Odoo domain. For example, if you connect to https://contoso.odoo.com, then the Database will be contoso. This property will be interpreted from the URL property.

When connecting to an on-premise instance of Odoo, you can find this value by logging out of Odoo and opening the Manage Databases page from the login screen. There, you can determine the database you need to connect to.

OdooEdition

The edition of Odoo being used. Set either Odoo Online or Odoo On-Premise.

Possible Values

Odoo Online, Odoo OnPremise

Data Type

string

Default Value

Odoo Online

Remarks

The edition of Odoo being used. Set either Odoo Online or Odoo On-Premise. When the OdooEdition is set to Odoo Online, the driver will consider the System's culture while processing the float/decimal/double data types for Insert statements.

User

The Odoo user account used to authenticate.

Data Type

string

Default Value

""

Remarks

Together with APIToken, this field is used to authenticate against the Odoo server.

APIToken

The API token (or password) used to authenticate the user.

Data Type

string

Default Value

""

Remarks

When using Odoo 14 and above, this option can be set to either an API token or password. API tokens are recommended over passwords.

CheckPermissions

Whether to use Odoo user's permissions to determine which tables and views to list.

Data Type

bool

Default Value

true

Remarks

Each user in Odoo has different permissions to some models - they can modify some, read others, and may not be able to access some at all. When CheckPermissions is true (the default), the model permissions are examined so that modifiable models are classified as tables, read-only models are classified as views, and inaccessible models are not listed.

When CheckPermissions is false, all the models within Odoo are listed as tables and the permissions check is skipped.

Checking model permissions requires an administrator to grant your user read-only access to the "ir.model.access" model because it is not readable to most users by default. If access to that model cannot be granted to the connecting user, then set this option to false.

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

AllowComputedFields

Boolean determining whether computed names from Odoo are mapped to columns.

Data Type

bool

Default Value

false

Remarks

Internally, Odoo stores some fields directly in its database and computes other fields dynamically when you request them. While stored fields are usually fast to retrieve, computed fields can potentially be much slower since Odoo has to do additional work on each row.

By default, this property is false and computed fields are not available. You can set this property to true if you need to access a computed field, although this will make queries (including star queries) on many tables take longer to run.

ExpandReferences

Boolean determining if multi-valued Many2Many and One2Many fields are expanded into separate rows.

Data Type

bool

Default Value

false

Remarks

By default Many2Many and One2Many fields are collapsed into single values separated by commas. For example, a record in calendar_event IDs will generate a result like this if partners 13 and 57 are attending.

SELECT id, name,                           partner_ids, x_custom_ids FROM calendar_event
--      1  'Meet With Potential Customer'  '13,57'      '1,2'

With this option enabled, the connector will expand each combination of multi-valued field values across multiple rows. This means that row data will be duplicated but makes it simpler to JOIN between tables that are linked by multi-valued references.

In addition, the connector will use a separate primary key called id:multi since id) not unique when rows are duplciated. This primary key is generated client-side and its use should be avoided in filters, since it depends upon the exact rows returned by any filters evaluated by Odoo.

SELECT "id:multi", id, name,                          partner_ids, x_custom_ids FROM calendar_event
--      1:1        1  'Meet With Potential Customer'  13           1
--      1:2        1  'Meet With Potential Customer'  57           1
--      1:3        1  'Meet With Potential Customer'  13           2
--      1:4        1  'Meet With Potential Customer'  57           2

Note that this option does not affect how INSERTs are processed. If you want to insert a record containing a multi-valued field you must always insert using a comma-separated value.

ShowParameterizedTables

Show tables that require inputs.

Data Type

bool

Default Value

false

Remarks

When this property is set to true, all the tables or views that require inputs to fetch data are displayed.

When this property is set to false, those tables and views are hidden.

The following is the complete list of tables that are shown/hidden based on the value of this property:

• calendar_alarm_manager
• forum_post
• ir_actions_act__window
• website_seo_metadata
• publisher_warranty_contract
• board_board
• hr_leave_report_calendar
• report_stock_quantity
• res_users_apikeys_show
• account_aged_payable
• account_aged_receivable
• account_multicurrency_revaluation

UseDisplayNames

Boolean determining if the display names for the columns should be used instead of the API names.

Data Type

bool

Default Value

true

Remarks

Display names may be changed in the future. Set this to false if you would like to ensure column names are always constant.

Miscellaneous

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

Language

This property specifies the language in which the data should be returned.

Data Type

string

Default Value

""

Remarks

This property can take one of the following values:

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

Pagesize

The maximum number of results to return per page from Odoo.

Data Type

int

Default Value

5000

Remarks

The Pagesize property affects the maximum number of results to return per page from Odoo. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

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