Creatio — Partner connection
The Creatio — Partner connection contains all the information needed to connect your account to the Boomi Enterprise Platform. A single connection serves all operations targeting the same Creatio instance, so create one connection per instance and environment, and reuse it across your processes.
The connection authenticates with OAuth 2.0 using the client credentials grant, through the OAuth 2.0 support built into the Boomi Enterprise Platform. You enter the client ID, the client secret, and the access token URL in the OAuth 2.0 section of the connection. The Boomi runtime requests the access token from the Creatio Identity Service, caches it, and reuses it across executions until it expires. If Creatio rejects a token, the connector requests a new one once and retries the call. No user passwords are stored, and no user sessions are maintained.
Before you begin
Collect the following before you create the connection:
- Confirm that the Solutions Metrix Boomi Connector package is installed in your Creatio instance and that at least one integration flow is configured. The connection cannot browse anything without it. The package requires Creatio 8.3.3 or later.
- Register an OAuth 2.0 client in Creatio. Open the System Designer, click OAuth 2.0 integrated applications in the Import and integration block, click New, and select Server-to-server (client credentials). Save the record: Creatio then fills in the Client Id and Client Secret values. Creatio documents the procedure in "Set up client credentials grant" at https://academy.creatio.com/docs/8.x/no-code-customization/8.3/base-integrations/oauth-2-0/set-up-the-oauth-2-0-authorization-instruction.
- Note the token endpoint URL. It is
{IdentityServiceURL}/connect/token, where{IdentityServiceURL}is the value of the Creatio system setting Authorization server Url for OAuth 2.0 integrations (code OAuth20IdentityServerUrl). In a Creatio cloud subscription, the Identity Service is deployed for you; in an on-site installation, it is deployed separately and usually runs on its own host, so the token endpoint is not a path under your application URL. The connection needs this full URL. See "Authorize external requests using client credentials grant" at https://academy.creatio.com/docs/8.x/dev/development-on-creatio-platform/8.3/integrations-and-api/authentication/oauth-2-0-authorization/identity-service-overview. - Grant the OAuth client's user access rights in Creatio to every object the flow touches: read access for Get operations, read and write access for Execute operations.
- Request a Customer ID and a License Key from Solutions Metrix.
Connection tab
Complete the following fields on the Connection tab. The OAuth 2.0 section shows only the three values the client credentials grant needs: the grant type is fixed, and scope, authorization URL, and extra token parameters are hidden because Creatio does not use them for this grant.
| Field | Required | Description |
|---|---|---|
| Creatio Base URL | Yes | The base URL of your Creatio instance, for example https://myapp.creatio.com. Enter the host only, with no path. A trailing slash is accepted and ignored. |
| OAuth 2.0 > Client ID | Yes | The client ID of the OAuth 2.0 client you registered in the Creatio Identity Service. |
| OAuth 2.0 > Client Secret | Yes | The client secret associated with that client ID. The value is stored encrypted by the Boomi Enterprise Platform and is never written to the process logs. |
| OAuth 2.0 > Access Token URL | Yes | The absolute URL of the Creatio Identity Service token endpoint: the value of the Authorization server Url for OAuth 2.0 integrations system setting (OAuth20IdentityServerUrl) with /connect/token appended, for example https://myapp-is.creatio.com/connect/token. A path relative to the Creatio Base URL is not accepted. |
| Customer ID | Yes | The customer identifier issued to you by Solutions Metrix. It is included in the license request and is validated against the license key. |
| License Key | Yes | The license issued to you by Solutions Metrix, as a single-line value. The value is stored encrypted by the Boomi Enterprise Platform. Without a valid license, the connector refuses to execute. To obtain one, send Solutions Metrix the Customer ID you configured here together with the Boomi Account ID of the account the runtime belongs to (Settings > Account Information in the Boomi platform). Browsing and Test connection work without a license, so the process can be built while the license is issued. |
Test connection
You can test your connection settings before you use or save the connection in a process. Click Test connection, select the runtime that will execute the connector, and click Next. The test runs on that runtime, so it also proves that the runtime itself can reach Creatio, not only that the values are well formed.
The test performs one full round trip: it requests an access token from the OAuth 2.0 > Access Token URL and then reads the list of integration flows from your Creatio instance. A connection to an instance that has no flows configured yet still passes the test. On success, the dialog reports "Test connection successful".
When a value is missing, the test names the field that needs attention. When a call fails, the message states which leg failed, the token endpoint or Creatio itself, and what to check. Credentials are never echoed back: the client secret and the license key are masked in every message the test produces.
The test does not validate the license key. Testing therefore succeeds before a license is issued, which lets you configure and verify the connection while the license is being issued. An invalid or missing license is reported when a process is executed, not when the connection is tested.
Environment extensions
When you move a process between environments, override the following connection fields with environment extensions: Creatio Base URL and the three values of the OAuth 2.0 section: OAuth 2.0 > Client ID, OAuth 2.0 > Client Secret, and OAuth 2.0 > Access Token URL. Keep the Customer ID and License Key aligned with the license you were issued.
If a process reports an unsupported or empty endpoint address at runtime, the environment extension values were not applied to the deployed process. Redeploy the process after setting the extension values.
Troubleshooting
The table lists what the Test connection dialog reports, and what to do about it.
| Message | Cause and resolution |
|---|---|
| <field> is required, followed by an example value. | One of Creatio Base URL, OAuth 2.0 > Client ID, OAuth 2.0 > Client Secret, or OAuth 2.0 > Access Token URL is empty. Fill in the named field. |
| OAuth 2.0 is not configured | The OAuth 2.0 section of the connection was left empty. Fill in the Client ID, the Client Secret, and the Access Token URL. |
| OAuth 2.0 > Access Token URL must be an absolute URL | A relative path such as /connect/token was entered. Enter the full URL of the Creatio Identity Service token endpoint, starting with http:// or https://. |
| Could not obtain an access token from the OAuth 2.0 > Access Token URL <url> | The runtime could not get a token. The URL is wrong or unreachable (check DNS resolution, the TLS certificate, and any firewall or proxy between the runtime and the Identity Service), or the client ID or client secret is wrong, or the OAuth client is not enabled for the client credentials grant. The message ends with the underlying error the runtime reported, for example, invalid_client, which tells these causes apart. |
| Creatio rejected the GetFlows call with HTTP 401 | A token was issued, but Creatio did not accept it. The token endpoint belongs to a different Creatio instance than the base URL, so the token audience does not match, or the OAuth client is not authorized for this instance. |
| Creatio rejected the GetFlows call with HTTP 403 | The OAuth user is authenticated but may not read the integration flow registry. Grant it access to the flow registry web service and read rights on the integration flow object in Creatio. |
| GetFlows returned HTTP 404 - the Solutions Metrix Boomi Connector package is not installed | The instance addressed by Creatio Base URL is reachable, and the credentials are valid, but the server package is missing. Install the package, then test again. |
| Cannot reach Creatio at <url> | The token was obtained, so the credentials are fine, but the call to Creatio itself did not complete. Check Creatio Base URL, DNS, the TLS certificate, and any firewall or proxy between the runtime and Creatio. |
| ... the response was not the expected flow registry JSON | Creatio Base URL points to something other than a Creatio instance, or the request was redirected to a login page. Correct the base URL. |
| A process fails with a licensing error. | The License Key is missing, does not match the Customer ID or the Boomi Account ID, or has expired. The connection test does not check the license, so a connection can pass the test and still fail at execution. Request a license as described for the License Key field above. |
| A process fails with an empty endpoint address. | Environment extension values were not applied to the deployed process. Set the extension values and redeploy. |
Related documentation
- Creatio — Partner Connector (overview)
- Creatio — Partner operation