Business Parameters
Business parameters are default configuration sets that allow you to define the business environment you are working on. For example, they define conditions for timeouts and feature flags. These parameters refer to how the AS operates and not to the authentication rules it includes. Business parameters are defined in the AS model within a database separate from the Middleware database.
In the Business Parameters page (Configuration > Business Parameters) you can see a list of all the parameters configured for the environment you are working on.
Note
Each Veritran platform component has a specific type of business parameters. AS business parameters are identified with a T at the beginning of the parameter name and are set in a specific database.
Navigate the Business Parameters page
By default, all the parameters are displayed. To filter the parameters one by one, go to the Parameters field, click the arrow and select a parameter from the drop-down menu. Then, press Enter in your keyboard or click Search to filter the parameter.
In both cases, you can see the name given to the parameter when created, its value and the last time and date when the parameter was modified. If you need to make changes to the parameter value, you can edit it.
See below for a table of all the parameters available in the Authentication Server, a description and their accepted values:
Parameter | Description | Accepted Values |
|---|---|---|
TUseWSA | Flag indicating if WSA should be used in AS services. (0-OFF and 1-ON) | 0 (OFF), 1 (ON) |
MDestinationParamName | Name of the client station for communicating with the Auth Server. | String |
MXSOAResponseTimeOut | Time (in seconds) to wait for a response from the Auth Server. | Integer (seconds) |
TknSttlExecIntervalDays | Number of days between each execution of the settlement process when generating partial reports. | Integer (days) |
TknSttlHistoRetentionMonths | Number of months the information will be retained in the VT-Token history table. | Integer (months) |
TknSttlHistoDumpPath | Directory path where the exported records from the VT-Token history table will be stored. | String (directory path) |
TknSttlSummRptPath | Directory path where the VT-Token usage reports will be stored. | String (directory path) |
TknSttlBillRptPath | Directory path where the VT-Token billing reports will be stored. | String (directory path) |
TknSttlUnusedInfoRetMonths | Number of months obsolete information will be retained in the system tables. NoteThis depuration can be disabled with theDisableUnusedDataDepuration parameter | Integer (months) |
TknSttlPartSummRetMonths | Number of months partial usage reports will be stored in the summarization tables. | Integer (months) |
TknSttlActiveScopeMonths | Number of months from the last token usage to consider it active in the system. | Integer (months) |
TQueueTimeOut | Maximum time (in seconds) a message remains in queue before being discarded. | Integer (seconds), 0 (disabled) |
TExplicitNSInResponse | Flag indicating whether the namespace should be explicitly included in the response. | 0 (OFF), 1 (ON) |
TknActivLogOutput | Parameter that pecifies whether to save activity logs to the database, file, or both. | DB, File, Both |
DisableHistoryExport | Parameter that indicates whether the historical information export is disabled. | true, false |
DisableHistoryDepuration | Parameter that indicates whether the historical information cleanup is disabled. | true, false |
DisableUnusedDataDepuration | Parameter that indicates whether the cleanup of unused data/information is disabled. | true, false |
Note
Business parameters are used and modified by the ITCD team.
Edit a Business Parameter
Since business parameters are not created in the AS console, you can only edit specific values within each one. Refer to the instructions below to learn how to edit a business parameter.
Find the parameter in the Business Parameters list.
Click the pencil icon to the right of the parameter you want to modify.
The Edit Business Parameter page opens, where you can only edit the Value and Comments fields.
Click the Value field and modify it. Refer to the table below to read about accepted values for each parameter.
Click the Comments field and modify or add the comments description to inform platform users about the purpose of the parameter and the changes made to the value (if applicable).