Items appearing on the Define Priority dialog box are shown below.
| Add | Defines a new set of priorities for XDB Server usage. Priorities are assigned to AuthIDs to limit server usage. |
| Delete | Permanently removes an XDB Server usage priority specification. |
| Update | Changes the parameters that define a priority specification for XDB Server usage. |
| Close | Closes the Define Priority dialog box. |
| Priority Name | Identifies a priority. This entry can be up to eight characters long. |
| Number of API Calls | Specifies the maximum number of Application Programming Interface (API) calls allowed during a single session on the XDB Server.
This entry must be greater than or equal to zero. The entry must be greater than or equal to zero, up to a maximum of 999,999,999. When this entry is zero, users with this priority are not limited by the number of API calls in the XDB Server SQL engine. APIs are routines that are invoked by calls to the SQL engine from the user's application. The number of API calls that users cause the XDB Server engine to invoke is an accurate gauge of their overall use of system resources. The purpose of limiting API calls is to control user access to the system resources. To limit users to a certain number of API calls, you need to know how many calls the users generally need during the course of their work. In many cases, determining this number is complex because it is dependent on the size of the tables the user accesses. In this case it might be best to set the number of API calls to zero (unlimited number of API calls) while limiting the user with one of the other priorities. |
| Max Time in Engine | Specifies the maximum cumulative time (in seconds) a user with this priority can use the XDB Server SQL engine during a single session on the XDB Server (called being "in the engine"). This number must be greater than or equal to zero, up to a maximum of 999,999,999 seconds (31 years, 259 days, 1 hour, 40 minutes, and 39 seconds). When set to zero, users with this priority will be allowed unlimited time in the engine. The purpose of this limit is to control the use of system resources. |
| Max Time Per API | Specifies the maximum time allowed (in seconds) per API from a user with this priority. This number must be greater than or equal to zero, up to a maximum of 9,999 seconds. When set to zero, users with this priority will not be limited by how much SQL engine time is used by an API. The purpose of this limit is to prevent the use of too much SQL engine time on a single API. |
| Max Idle Time | Specifies the maximum time a user with this priority can be connected to the XDB Server without running any operation on the engine (called "idle time"). This number must be greater than or equal to zero, up to a maximum of 999,999,999 seconds. When set to zero, users with this priority will be allowed unlimited idle time. The purpose of this limit is to prevent users from taking up engine threads while not using the engine. |
| Max Fetches | Limits a user with this priority to a specified number of records returned (fetches). This number must be greater than or equal to zero, up to a maximum of 999,999,999 fetches. When set to zero, users with this priority will be allowed an unlimited number of fetches. The purpose of this limit is to control the use of system resources. |
| Start Enforcement | Specifies the start of a time period (which ends with END ENFORCEMENT) when engine restrictions are enforced for a user with
this priority. The format of the entry is dependent on the time picture defined in Options.
Note:
If the start and end free times are equal and not null (blank entry), then all priority limits are effectively canceled. This is equivalent to saying that the full 24-hour period is free time. |
| End Enforcement | Specifies the end of the time period (which begins with Start Enforcement) when engine restrictions are enforced for a user with this priority. The format of the entry is dependent on the time picture
defined in Options.
Note:
If the start and end free times are equal and not null (blank entry), then all priority limits are effectively canceled. This is equivalent to saying that the full 24-hour period is free time. |
| Comments | Adds an optional description (up to 254 characters) about the general purpose or scope of this priority. |