Odoo v2 Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 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 your Odoo instance URL, User and APIToken to your user credentials, and Database to your Odoo database name.

If you are not using an API token (available only in Odoo 14 and later), you can enter your password directly into the APIToken field instead.

Quick Start: Connecting to Odoo Online

The steps below are a typical setup for connecting to Odoo Online:

1. Set OdooEdition to Online.
2. Set URL to the full URL of your Odoo instance, such as https://mycompany.odoo.com.
3. Set User to your Odoo login (email or username).
4. Set APIToken to your API key or password.
5. Set Database to your database name (optional for Odoo Online, required for On-Premises).

Odoo Edition

The OdooEdition property determines how the connection is established. Odoo offers two different types of environments, and this setting tells the connector which one you are using:

• Online: For Odoo's cloud-hosted SaaS version at odoo.com
• OnPrem: For Odoo installations that you or your company host on your own servers

If you're unsure, use Online if you access Odoo from a web address like yourcompany.odoo.com. Use OnPrem if your organization manages its own Odoo server (often accessed via a custom domain or local network).

Database

Odoo supports multiple databases under the same server. You must provide the name of the specific database you want to connect to.

• For Odoo Online: The database name is often included in the web address, and the connector may be able to detect it automatically if Database is left blank. However, in some cases, the database is not visible in the URL and must be specified manually. Setting this value is always recommended for reliability.
• For Odoo On-Premises: You must set the Database property. The connector cannot detect the database automatically in this case.

How to Find Your Database Name (Odoo Online)

1. Log into your Odoo Online account
2. Click your profile icon in the top-right corner and choose My Databases
3. Your database name will be listed in the table

Alternatively, you can often see the database name in the subdomain of your URL. If your address is https://mycompany.odoo.com, your database name is likely mycompany.

Access Rights

To discover available models (tables) in Odoo, the connector checks the internal ir.model.access table, which defines what models a user is allowed to see.

By default, only Odoo administrators have permission to read this table. To give a non-admin user access, create a new group:

1. Log in as an administrator and enable developer mode in Odoo settings.
2. Open the Groups page (under the Users drop-down) and create a new group.
3. Set the Application to Administration and name the group "Service Access".
4. Add the users who need access under the Users tab.
5. In the Access Rights tab, add a permission for ir.model.access (or Model Access), check Read, and name it Inspect Models.

If you're unable to grant access in this way, set the CheckPermissions property to false. This disables permission checking and allows the connector to list all available models, even if the user doesn't have explicit access.

Troubleshooting

If you encounter errors like missing database or authentication failed, try the following:

• Double-check the value of Database, especially for On-Prem environments.
• Make sure your user credentials are valid by logging into Odoo directly.
• If using Odoo Online, try leaving Database blank and allow auto-detection.
• Ensure the correct OdooEdition is set (Online vs OnPrem).

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 supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.

SSL Configuration

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

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

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

User Defined Views

The Jitterbit Connector for Odoo supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view 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 so that each root element defines the name of a view, and includes 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

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset 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

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

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 available to you will be different depending on the apps you have installed. The tables listed here are only examples, which may differ from those available.

• Tables specify which models can be modified and which are read-only. Modifiable models are represented as tables, allowing for reading, inserting, updating, and deleting data.
• Views read-only models are represented as views, enabling data retrieval like tables while prohibiting insertions, updates, or deletions to maintain data integrity.
• Stored Procedures are scripts that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, and can be used to search, update, and modify information in Odoo.
• Models within Odoo, in addition to columns containing simple values, such as text and dates, there are also columns that hold multiple values in each row. The driver interprets these values differently, based on the type of column from which the value originates. The columns describe different types of relationships that can exist between models (or database tables).

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

Contains mappings and metadata for relational fields used in Odoo models, including many-to-one and many-to-many field types. It is a reference table to identify field dependencies, assist in module development, and facilitate data integrity across various object relationships.

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

Executes a server-side Remote Procedure Call (RPC) within the Odoo framework, allowing seamless interaction with business logic components such as models, workflows, and services. Typically, it triggers automated processes or retrieves computed data from the backend.

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CallProcedure' AND IncludeResultColumns='True'

Columns

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

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

Models

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

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

Specifies the base URL of the Odoo site that you want to connect to.

Data Type

string

Default Value

""

Remarks

This property defines the root address of your Odoo instance. The value should be the full URL, including the protocol (http:// or https://).

For example:

• https://mycompany.odoo.com (Odoo Online)
• http://localhost:8069 (Odoo On-Premise)

The connector uses this URL to establish a connection with your Odoo deployment and derive additional metadata, such as the database name when possible. Ensure that the provided URL matches the externally accessible address of your Odoo instance. If you're connecting to an Odoo Online instance, the subdomain portion typically matches your organization name.

Database

Specifies the name of the Odoo database that you want to connect to.

Data Type

string

Default Value

""

Remarks

The value you provide depends on whether you're connecting to Odoo Online or an On-Premise instance:

• Odoo Online: The database name typically matches your custom Odoo subdomain. For example, if your URL is https://contoso.odoo.com, the database name is "contoso". When using the connector, this value is typically detected automatically from the URL property. If the database cannot be determined from the URL, you must set this property manually.
• Odoo On-Premise: You can find the database name by logging out of Odoo and selecting Manage Databases from the login screen.

OdooEdition

Specifies the edition of Odoo that you are connecting to: Odoo Online or Odoo OnPremise.

Possible Values

Odoo Online, Odoo OnPremise

Data Type

string

Default Value

Odoo Online

Remarks

This property determines how the connector interacts with your Odoo instance based on its deployment type:

• When set to Odoo Online, the connector adjusts float, decimal, and double handling in INSERT statements to account for the system's locale and cultural settings. This helps ensure proper formatting and compatibility with cloud-hosted Odoo instances.
• When set to Odoo OnPremise, the connector assumes a local deployment and disables certain behaviors specific to Odoo Online.

Set this property to match the environment your Odoo instance is running in. If you're using Odoo via a hosted subdomain like https://yourcompany.odoo.com, choose Odoo Online. For self-hosted instances, choose Odoo OnPremise.

User

Specifies the Odoo user account used to authenticate.

Data Type

string

Default Value

""

Remarks

This property specifies the Odoo username used for authentication. It is typically the email address associated with the Odoo user account.

This value is used together with the APIToken property to authenticate requests to the Odoo server.

APIToken

Specifies the API token or password used to authenticate the user.

Data Type

string

Default Value

""

Remarks

This property accepts either an API token or a password, depending on the Odoo version in use:

• For Odoo 14 and later, authentication via API token is supported and recommended.
• For Odoo 13 and earlier, you may need to enter your Odoo account password in this field instead.

You can generate API tokens in the Odoo web interface under My Profile > Preferences > API Keys.

If you are using an Odoo Online instance, make sure the user account has a password or token configured, as these are not always set by default.

CheckPermissions

Specifies whether the provider uses the Odoo user's permissions to determine which tables and views to expose.

Data Type

bool

Default Value

true

Remarks

Odoo users have different levels of access to various models. When this property is set to true, the connector checks model-level permissions to classify objects:

• Models the user can modify appear as tables.
• Models the user can only read appear as views.
• Models the user cannot access are excluded from the schema.

To perform this permissions check, the connector queries the ir.model.access model. However, most users do not have read access to this model by default. If the connecting user lacks access, and administrator-level access cannot be granted, set this property to false.

When this property is set to false, the connector skips the permissions check and lists all models in Odoo as tables, regardless of the user’s actual access level.

Set this property to false only if the connecting user lacks access to ir.model.access.

SSL

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

SSLServerCert

Specifies 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

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\Odoo Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\Odoo Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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`.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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`.

AllowComputedFields

Specifies whether computed fields in Odoo are exposed as columns.

Data Type

bool

Default Value

false

Remarks

Odoo includes both stored and computed fields. Stored fields are retrieved directly from the database, while computed fields are generated dynamically at query time.

When this property is set to true, the connector includes computed fields as columns in the exposed schema. This allows access to additional metadata or derived values that Odoo generates during runtime.

This property is useful when working with tools that rely on a complete set of available fields, but do not allow you to edit the schema or query structure manually.

Performance Considerations

Including computed fields can impact performance, especially when querying large tables. Since Odoo must evaluate computed fields at runtime, queries (particularly star queries or those involving joins) may take significantly longer to complete. Use this property only when you need access to specific computed fields that are not stored directly in the database.

ExpandReferences

Specifies whether 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 comma-separated values within a single row. For example, if a calendar event is associated with partners 13 and 57, the partner_ids field appears as '13,57'.

When this property is set to true, the connector expands these multi-valued fields across multiple rows—one for each unique combination. This behavior makes it easier to join tables on relationship fields but results in duplicated row data.

To support this expansion, the connector generates a synthetic primary key called id:multi, since the original id field is no longer unique when rows are duplicated. This key is assigned client-side and should not be used in filters, as it depends on the full result set returned by Odoo.

This property does not affect how records are inserted. Even when expansion is enabled, multi-valued fields must still be inserted as comma-separated values.

Performance Considerations

Expanding multi-valued references can significantly increase the number of rows returned, especially when multiple Many2Many or One2Many fields are present. While this can improve usability in joins, it may slow down query performance and increase memory usage. Consider enabling this option only when working with relationships that require relational joins or flattening.

ShowParameterizedTables

Specifies whether tables and views that require input parameters are included in the schema.

Data Type

bool

Default Value

false

Remarks

Some tables and views in Odoo require parameters in order to return data. These are considered parameterized objects, and they are hidden from the default schema to avoid confusion or runtime errors in tools that cannot supply required inputs.

• When this property is set to true, the connector includes these parameterized tables and views in the metadata.
• When set to false, these objects are excluded from the schema.

The following parameterized tables are affected by this setting:

• 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

Performance Considerations

Enabling this property does not affect query performance directly, but it may expose objects that cannot be queried without providing required inputs. If your application does not support parameterized queries, leave this property disabled to avoid errors.

UseDisplayNames

Specifies whether the provider uses display names instead of API names for column labels.

Data Type

bool

Default Value

true

Remarks

When this property is set to true, the connector uses the display names defined in Odoo as column names. These names are often more user-friendly and better suited for use in reports or low-code tools.

When this property is set to false, the connector uses the underlying API names for columns. This ensures consistent naming across schema refreshes and protects against changes if display names are updated in your Odoo instance.

Use false if your workflow depends on stable column names such as with long-lived integrations or business-intelligence dashboards, or if you prefer to work directly with the technical field names exposed in the Odoo API.

Miscellaneous

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

Language

Specifies the language in which data should be returned.

Data Type

string

Default Value

""

Remarks

This property defines the locale used for returning translated field values where available. The value must match a supported language code in your Odoo environment.

If no value is set, the connector defaults to en_US (English – United States).

You can set this property to any language code supported by your Odoo instance. A complete list of supported language codes is maintained in your Odoo system configuration.

Supported Languages:

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

Pagesize

The maximum number of records per page the provider returns when requesting data from Odoo.

Data Type

int

Default Value

5000

Remarks

When processing a query, instead of requesting all of the queried data at once from Odoo, the connector can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the connector requests per page.

Note that setting large page sizes may improve overall query execution time, but doing so causes the connector to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
    }

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.