Skip to main content

What are the considerations for using Dimensions APIs?

What are the considerations for using Dimensions APIs in hosted and on-premise deployments?

Understanding the applicability and usage of Dimensions APIs is crucial for both hosted and on-premise deployments. This article provides an overview of key considerations, including documentation applicability, deployment-specific requirements, and available tools.

Overview of Dimensions API Applicability

The Dimensions API documentation is applicable to version 2.60a, including on-premise deployments. This ensures that users of this version can rely on the provided documentation for guidance.

Hosted vs On-Premise Deployment Considerations

  • Hosted Deployments: The published Dimensions APIs are fully functional and supported for hosted environments.

  • On-Premise Deployments: While the APIs can be used, accessing the SQL database tables requires the use of SQL Connect. This tool is essential for interacting with the database in on-premise setups.

Tools and Support for On-Premise Deployments

For on-premise deployments, SQL Connect is a necessary tool to access the SQL database tables. However, it is important to note that SQL Connect usage is not officially supported by the product team. Users requiring assistance with SQL Connect may need to engage a consultant for support.

Additional Notes and Recommendations

  • Ensure that you are using the correct version of the Dimensions API documentation for your deployment.

  • For on-premise deployments, plan for additional resources or expertise if SQL Connect is required.

  • Consult with your IT team or a qualified consultant for complex on-premise configurations.

By understanding these considerations, you can effectively utilize Dimensions APIs in both hosted and on-premise environments.

Did this answer your question?