...
Rego OData allows uses both basic authentication and Clarity API Keys to authenticate users to access the OData environment. Syntax to be used is as follows:
...
API Keys
Username : <API Client ID>|<Clarity Username>
Password: <API Key>
...
Rego ODATA now supports API Keys as well for user authentication. The format of the Username is: <API Client >|<
Note:
ODATA does not use Single Sign on or Cognito password. Basic authentication or API keys are used for authentication.
All the rules associated with API Keys such as key expiration will be applied.
Existing Odata access right is still needed to access Odata.
Administrators will need to enable APIs in their environment and create an API Client that end-users should use to generate API keys.
When refreshing non-production from a production environment the API keys for the non-production environment will be overwritten with the production values as the API keys are stored in the database.
...
ODATA Query Code | Provide the unique identifier for the feed in “ODATA Query Code”. The code should start with an alphabetic letter, can contain only alphanumeric digits with no spaces or other special characters except underscore. |
Short Description | Description of the feed details |
SQL Query | a SELECT query to execute for the feed. If all fields of a table are required, use “SELECT * from <table_name>” IMPORTANT NOTE: Queries containing Avoid using “;” or those that begin using WITH clause should be avoided(semi colon) in the queries as this is a reserved character |
Query Primary Keys Alias | Each OData feed entry must have a primary key. It can be combination of multiple keys. In such case, use a comma to separate the key aliases |
Query Status | Can have a status as New, Valid, Invalid. Only Valid queries will be available for the ODATA feed IMPORTANT NOTE: If the query takes more than 15 seconds to execute, then status is set to invalid. Such queries hit the hard threshold limits of AWS architecture and will adversely impact the main Clarity transactional database. |
Error | If the query or the primary key details provided are invalid, then Query Status will be set to invalid, and the respective error reason will be displayed in this field. |
Active | When inactive, the fields: short description, SQL Query, Query Primary Keys Alias will be editable and can be changed. To validate the query, Check the Active field and save the changes. This will auto trigger the process “Rego Validate OData Extension” which will perform all the validations. If validations are successful, the status is set to valid. Otherwise, the status is marked as invalid, and reasons are mentioned under the Error field |
...