Extensions

Extensions enable administrators to connect IBM OpenPages® to virtually any endpoint that exposes an API, enabling advanced use cases such as running FAIR or Monte Carlo simulations, etc.

You can configure extensions from Open Administration menu Administration menu > Integrations > Extensions. It requires the SOX > Administration > Extensions permission to be enabled.

Note: A new extension is not enabled by default. You won't be able to test it until you enable it from the grid on the Extensions tab. The first GET operation in a specification is used to test connectivity and authentication. If a specification doesn't include a GET operation, an extension cannot be tested, but it can still be enabled. If you're on IBM OpenPages as a Service, wait a few minutes after you enable the extension and before you test the connection as it may take a few minutes for the egress to be opened. If you're on IBM OpenPages on Cloud and the firewall is not opened, you must contact IBM® support to update the firewall to allow the connection.

Requirements

To create a new extension, you need the following:
  • OpenAPI specification (JSON, YAML, or YML)
  • Authentication information
  • Values of server variables (if the specification includes variables)
As a Service If you're on IBM OpenPages as a Service, server domains must be on the approved allowlist:
Note: The wildcard (*) denotes any subdomain.
*.azure.com
*.*.services.ai.azure.com
*.*.models.ai.azure.com
*.openai.azure.com
*.lambda-url.*.on.aws
*.googleapis.com
api.openai.com
api.llama.com
api.mistral.ai
api.gemini.com

For more information on the specification, see the extensions topic for developers.

Enabling and testing connections

A new extension is not enabled by default. You cannot test a connection until you enable the extension from the grid on the Extensions tab.

The first GET operation in a specification is used to test connectivity and authentication. If a specification doesn't include a GET operation, an extension cannot be tested, but it can still be enabled.

Important:

As a Service If you're on IBM OpenPages as a Service, wait a few minutes after you enable the extension and before you test the connection as it may take a few minutes for the egress to be opened.

On Cloud If you're on IBM OpenPages on Cloud and the firewall is not opened, you must contact IBM support to update the firewall to allow the connection.