Global Variables List
The following lists describe the global variables. For general information about how global variables work, refer to Global Variables.
This article categorizes variables by the user interface in which they are available. There are three groups:
- Power User Specific: Variables that are only available in the Power User Interface and affect only the KB in which they are defined.
- Admin Console Specific: Variables that are only available in the Admin Console, for use on dedicated servers or self-hosted systems. These variables configure server-wide behavior, potentially affecting all KBs on the server.
- Multi-level: Variables that are available in both the Power User interface and the Admin Console. With these variables, the value defined in the Power User Interface for a KB takes precedence over the value in the Admin Console. If a multi-level variable in not set in a KB but is defined in the Admin Console, the Admin Console value takes effect. This allows you to set server-wide behavior while also maintaining flexibility for each KB.
Additional security-related variables are configured in the Security wizard. See Security for information.
Power User Specific Global Variables
The following list describes the global variables that are available only in the Power User Interface. To access these global variables, go to Setup > System > Manage Global Variables.
Action Button record lock timeout (action_button_view_record_lock_timeout)
Name: action_button_view_record_lock_timeout
Description: The number of milliseconds to wait for the previous record lock to be removed when an action button is clicked.
Default Value: 2000
Allowed Values: integer
Location: Power User Interface
Add a "cannot see - cannot search" restriction to each interactive saved search filter (PrerestrictedFiltration)
Name: PrerestrictedFiltration
Description: Controls whether search results are shown for fields the user doesn't have permission to view. When this variable is enabled, set to Yes, and a user searches a field they don't have permission to view, the search does not return results.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
AI Feature Flags (feature_flags)
Name: feature_flags
Description: Controls access to AI features. Do not edit this variable. To ensure system stability and integrity, changes should only be made by Agiloft Support.
Default Value: blank
Location: Power User Interface
AI Platform Region (ai_platform_region)
Name: ai_platform_region
Description: Defines the regional server that AI runs on. The default value is blank, which means US.
Default Value: blank
Allowed Values: blank or EU
Location: Power User Interface
Always display visibility dependent field values in table views (field_visibility_in_views)
Name: field_visibility_in_views
Description: Determines whether field visibility conditions also apply to table views and HTML reports. If this variable is set to Yes, visibility dependent field values appear in table views and HTML reports regardless of whether the field's visibility condition is met. If this is set to No, the values appear only if the condition is met.
Default Value: Yes
Allowed Values: Yes, No
Location: Power User Interface
Always use JavaScript Charts (force_js_charts)
Name: force_js_charts
Description: Defines whether charts shown on the dashboard are forced to use JavaScript rendering, even if they weren't configured to use JavaScript in their setup options. If this variable is set to Yes, the charts still display on the dashboard in the interactive format even if the "Use JavaScript Charts" option has not been selected in its Output format.
This variable only affects the display of charts on the dashboard. Other outputs such as email distribution display in the non-interactive format if they have not been configured to use JavaScript charts.
Default Value: No
Allowed Values: Yes, No
Recommended Values: Yes
Location: Power User Interface
Analyze Table Frequency (AnalyzeTableFrequency)
Name: AnalyzeTableFrequency
Description: Defines the frequency with which background services automatically perform table analysis. The results of the analysis can be found at <installation>/wildfly/standalone/log/server.log.
Default Value: week
Allowed Values: hour, 4 hours, 8 hours, 12 hours, day, week, month, never
Location: Power User Interface
Analyze Tables Period (AllowableAnalyzeTablePeriod)
Name: AllowableAnalyzeTablePeriod
Description: Defines the time of day (in hours) in which background services are permitted to perform table analysis. For example, a value of "23-04" means between 11 pm and 4 am.
Default Value: 23-04
Recommended Values: A period of system inactivity is best.
Location: Power User Interface
Autotag Clause based Templates (print_template_auto_tag_clauses)
Name: print_template_auto_tag_clauses
Description: Defines whether or not to add document variables to document templates automatically for field from other table syntax and to eliminate them if the clause is conditional.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
CAS Server Login URL (casserverloginurl)
Name: casserverloginurl
Description: Used to integrate with a Centralized Authentication Server (CAS). Defines the URL Agiloft redirects a user to in order to authenticate against CAS before proceeding to login, such as https://<yourhost>/cas/login. For more information, see Apereo CAS SSO.
Default Value: blank
Location: Power User Interface
CAS Ticket Validator (casticketvalidator)
Name: casticketvalidator
Description: Defines the CAS Ticket Validator to be used for user authentication. Set this value according to your CAS Server version. For more information, see Apereo CAS SSO.
Default Value: CAS 2.0 Service
Allowed Values: CAS 1.0, CAS 2.0 Service, CAS 3.0 Service
Location: Power User Interface
Checking frequency for inbound emails (minutes) (check_inbound_each_N_minutes)
Name: check_inbound_each_N_minutes
Description: Controls the frequency (in minutes) that the system checks for inbound emails. For more information, see Email Troubleshooting.
Default Value: 1
Allowed Values: integer
Location: Power User Interface
Cloud OCR Rolling Page Limit (ocr_rolling_page_limit)
Name: ocr_rolling_page_limit
Description: Places a limit on the number of pages that are processed each 30 days using Amazon Textract OCR. If the limit is reached, text recognition is performed using Agiloft's internal OCR for the remainder of the 30 days.
Default Value: 10000
Allowed Values: An integer from 1 - 10000
Location: Power User Interface
Cognizer AI Max Batch Size (cognizer_ai_max_batch_size)
Name: cognizer_ai_max_batch_size
Description: The maximum number of documents that can be submitted to Cognizer within a single API call.
Default Value: 100
Allowed Values: An integer from 1 - 100
Location: Power User Interface
Cognizer response enrichment JSON (cognizerAddFieldsJSON)
Name: cognizerAddFieldsJSON
Description: Contains JSON structure that describes additional information that formulates the response from Cognizer. This variable should not be modified unless instructed by Support.
Default Value: {"contract_id": "contractOriginalId", "contract_title": "contractOriginalTitle", "contract_status": "contractOriginalStatus", "id": "attachmentOriginalId", "contract_party_name": "contractOriginalPartyName", "title": "attachmentOriginalTitle", "hotlinks": ["contractOriginalRecordDeepLink", "attachmentOriginalRecordDeepLink", "attachmentDownloadHotLink", "attachmentOriginalDocumentViewerDeepLink", "viewAllDocumentsDeepLink"]}
Location: Power User Interface
Concurrent Editing Transaction Session Timeout (coauthoring_session_time_out)
Name: coauthoring_session_time_out
Description: Defines the number of seconds to wait before timing a coauthor out of a document editing session due to inactivity. This variable applies when multiple users are editing the same document. If a user checks out a document for editing and doesn't make any changes to it for the amount of time set in this variable, the system ends that user's session, and the user will not be able to save any further changes.
Default Value: 600
Allowed Values: integer
Location: Power User Interface
Custom Cipher transform for decrypting SAML Keys (custom_saml_enc_key_cipher_transform)
Name: custom_saml_enc_key_cipher_transform
Description: SAML SSO messages sent to Agiloft by SAML Identity Providers (IdPs) are encrypted using public key cryptography. In public key cryptography, cipher transformation is the process of preparing a message for encryption or signing using a specification or scheme. By default, Agiloft supports the following standard cipher transformations:
- RSA/ECB/PKCS1Padding
- RSA/ECB/OAEPWithSHA-1AndMGF1Padding
- RSA/ECB/OAEPWithSHA-256AndMGF1Padding
- RSA/ECB/OAEPWithSHA-512AndMGF1Padding
While these cipher transformations should suffice for most commonly used IdPs, if you find that your IdP uses a special cipher transform, you can specify a Java-supported custom transform using this global variable. If your IdP uses any of the cipher transforms listed above, then those transforms take precedence over the custom transforms defined here.
For more information about configuring SAML SSO, refer to SAML 2.0 SSO.
Location: Power User Interface
Custom SMTP Configuration Properties (mail_smtp_custom_options)
Name: mail_smtp_custom_options
Description: Additional JavaMail API SMTP Configuration Properties in Java property format (name=value). They are applied over Agiloft defaults.
Default Value: blank
Allowed Values: Text in Java property format
Location: Power User Interface
Dashboard chart widget render timeout (in seconds) (dashboard_chart_render_timeout)
Name: dashboard_chart_render_timeout
Description: The number of seconds to wait for a dashboard chart widget to load before timing out. If the chart fails to load in the time limit, Agiloft aborts chart processing and releases system resources.
Default Value: 60
Allowed Values: An integer from 20 - 120
Location: Power User Interface
Default day/month order for date/time strings (date_format_order)
Name: date_format_order
Description: Defines how the system parses date/time strings during record importation, email parsing, and web services calls. Allowed values:
LOCALE – Parse dates based on the user's locale during login or REST calls.
DMY – Parse dates in Day, Month, Year order.
MDY – Parse dates in Month, Day, Year order.
Note that if the system detects date strings that do not fit the specified format, it automatically switches from day/month to month/day parsing as needed.
For more information about importing data or email parsing, refer to the following topics:
Default Value: DMY
Location: Power User Interface
Default language (default_language)
Name: default_language
Description: Defines the default language if the user's Language setting is unknown.
Default Value: English
Location: Power User Interface
Deprecate Old File Options (deprecate_old_field_options)
Name: deprecate_old_field_options
Description: Defines whether or not the system hides several deprecated options when creating or editing a File with Versioning field. Select Yes to hide the following options:
- Display changes to .docx files
- OCR
- PDF Searchable
- Document Title
Default Value: No
Location: Power User Interface
Disable email loop detection (disable_email_loop_detection)
Name: disable_email_loop_detection
Description: Determines whether Agiloft filters emails that are sent to one of the inbound emails accounts of the current KB as a result of a rule. Select Yes to disable email loop detection.
Note that loop detection distinguishes between two types of loops:
- One table loop: when one of the recipients has the same email address as the inbound email address configured for the table from which the email is sent.
- Complex loop: all other cases. For instance, an email sent by a rule from table A to an inbound account specified for table B, then table B has a rule that sends an email to the inbound account configured for table A.
In the case of a one table loop, the problem email is removed from the recipients list. In other complex cases, a warning is put into the logs.
For information about configuring your inbound emails for further loop protection, refer to Customize Optional Inbound Email Settings.
Default Value: No
Recommended Values: We do not recommend disabling loop detection.
Location: Power User Interface
Disable Marketing Email Image Tracking (disable_marketing_email_image_tracking)
Name: disable_marketing_email_image_tracking
Description: Determines whether the email marketing functionality is disabled. Select Yes to disable the functionality. For more information, see Email Marketing.
Default Value: No
Recommended Values: We do not recommend disabling the email marketing functionality. However, doing so can reduce warnings from the email client.
Location: Power User Interface
Disable OAuth Content-Type validation (disable_content_type_validation_at_api_oauth_login)
Name: disable_content_type_validation_at_api_oauth_login
Description: Controls whether OAuth content-type validation is enabled or disabled. This variable must be disabled, set to Yes, to use the Agiloft Workato connector.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Display Database Update Warning (warn_on_record_changed)
Name: warn_on_record_changed
Description: Determines whether a warning appears when users are editing a record and the system updates the value of a field within that record.
| Value | Behavior |
|---|---|
| Yes | When the user finishes editing the record:
|
| No | When the user finishes editing the record:
|
Default Value: Yes
Allowed Values: Yes, No
Location: Power User Interface
Do not resend old letters (stop_resend_to_broken_smtp)
Name: stop_resend_to_broken_smtp
Description: Defines the maximum number of days Agiloft attempts to resend an email that originally failed to send as a result of a broken SMTP connection. Note that this global variable works in conjunction with the How many minutes to wait before resending failed letters global variable. For example, if this global variable is set to 3 and "How many minutes to wait before resending failed letters" is set to 30, the system attempts to resend the email every thirty minutes until either the email is sent or, if the SMTP connection remains broken, the email is 3 days old.
For more information, see Required Email Setup.
Default Value: 5
Allowed Values: integer
Location: Power User Interface
Document Viewer Fuzzy Search Page Count Threshold (docviewer_fuzzy_search_page_count_threshold)
Name: docviewer_fuzzy_search_page_count_threshold
Description: Specifies the maximum page count for documents where fuzzy search can be applied. If the page count of the document exceeds this threshold, the fuzzy search feature will be disabled.
Default Value: 40
Allowed Values: An integer from 0 - 10000
Location: Power User Interface
Dummy Communications (create_dummy_communication_records)
Name: create_dummy_communication_records
Description: Determines whether the system creates a Communication record even if an email fails to send because the "To" or "From" fields are blank. Select Yes to create a Communication record for this type of unsent email. Note that the behavior defined here also applies to emails received by Agiloft where the "To" field is blank. This means that if this global variable is set to No, a Communication record is not created if Agiloft receives an email where the "To" field is blank and the inbound email address for a table is included in the "BCC" field.
Default Value: No
Recommended Values: In most cases, the default value of No is recommended as it can help prevent your Communications table from bloating. However, if your organization regularly receives emails in which the "To" field is blank because the inbound email address for a table was included in the "BCC" field, selecting Yes might be useful.
Location: Power User Interface
Email Marketing's URL Age (link_age)
Name: link_age
Description: Determines how many days hotlinks sent in marketing emails are kept active in the database. Effectively, this serves as an expiration date for hotlinks in marketing emails for which an expiration date was not specified during creation. For more information about hyperlinks in emails, see Sending Emails. If you want to create an age limit for all hotlinks, regardless of whether they are in marketing emails or not, use the Hotlink Age global variable.
Default Value: 365
Allowed Values: integer
Location: Power User Interface
Enable Chinese Word Segmenter (ChineseWordSegmenter)
Name: ChineseWordSegmenter
Description: Determines whether the Chinese Word Segmenter is enabled. The Chinese Word Segmenter sequentially consumes third-party library objects meant for splitting Chinese text without spaces into words.
Default Value: No
Recommended Values: Set this variable to Yes to enable CWS if you need full-text searching over Chinese words.
Location: Power User Interface
Enabled Non-versioned File and Image Fields (oldFileNewMenuItemEnabled)
Name: oldFileNewMenuItemEnabled
Description: Determines whether non-versioned file and image fields can be created. Select Yes to enable these types of fields. Note that File with versioning and Image with versioning fields have the option to disable or limit versioning. For more information about these data types, see List of Data Types.
Default Value: No
Recommended Values: Because you have the option to disable or limit versioning in File with versioning and Image with versioning fields, it is unlikely that you would need to enable non-versioned file and image-type fields.
Location: Power User Interface
Enable Expand All Sections Links (show_expand_collapse_links)
Name: show_expand_collapse_links
Description: Determines whether the system shows shortcuts to expand and collapse all sections when viewing or editing records. Select No to hide these shortcuts.
| Value | Behavior |
|---|---|
| Yes |
|
| No |
|
Default Value: Yes
Allowed Values: Yes, No
Location: Power User Interface
Enable Hotkeys (hotkeys_enabled)
Name: hotkeys_enabled
Description: Determines whether Hotkeys (also called keyboard shortcuts) are enabled. Select No to disable Hotkeys. For more information about hotkeys, see Keyboard Shortcuts.
Default Value: Yes
Allowed Values: Yes, No
Location: Power User Interface
Enable Japanese Word Segmenter (JapaneseWordSegmenter)
Name: JapaneseWordSegmenter
Description: Determines whether full text searching supports Japanese text and documents, including morphological parsing and equivalent Kanji and Kana search capabilities. When enabled, this allows Japanese search results for equivalent Japanese words even when different characters are used.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Enable Usage Tracking (pendo_enabled)
Name: pendo_enabled
Description: Controls whether Pendo usage tracking is enabled or disabled.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Enduser Title (enduser_title)
Name: enduser_title
Description: Defines the string that appears as the title in the browser tab when logged in to the Legacy End-User interface. Note that the Legacy End-User Interface is deprecated.
Default Value: Agiloft Contract Lifecycle Management - End User Portal
Allowed Values: text
Location: Power User Interface
Force use sub-selects rather than temp tables for complex filters (force_avoid_temptables)
Name: force_avoid_temptables
Description: Determines whether the system only uses sub-selects to display the results of complex filters and saved searches. Sub-selects and temporary tables are techniques that mySQL uses to respond to requests for complex saved searches. Using temporary tables often negatively effects performance.
Note that this global variable relies on the Use sub-selects rather than temp tables global variable. If the Use sub-selects rather than temp tables global variable is set to:
- No, then this global variable has no effect.
- Yes, then the value of this global variable is used to determine whether the system can use temporary tables.
- If this global variable is set to No, then the system prefers using sub-tables but can still use temporary tables.
- If this global variable is set to Yes, then the system cannot use temporary tables.
Default Value: Yes
Recommended Values: Due to the performance implications, we recommend using sub-selects rather than temporary tables.
Location: Power User Interface
Header Text (swheader_text)
Name: swheader_text
Description: Defines the text that appears in the header to the left of the KB name and to the right of the search box.
Default Value: blank
Location: Power User Interface
Hotlink Age (hotlink_age)
Name: hotlink_age
Description: Determines how many days hotlinks sent in emails are kept active in the database. Effectively, this serves as an expiration date for those hotlinks for which an expiration date was not specified during creation. For more information about hotlinks in emails, see Hyperlinks in Emails. To only set an age limit for hotlinks in marketing emails, use the Email Marketing's URL Age global variable.
Default Value: 100
Allowed Values: integer
Location: Power User Interface
Hotlink Length (hotlink_length)
Name: hotlink_length
Description: Defines the number of characters contained within hotlinks created by Agiloft. The maximum length is 255 characters.
Default Value: 128
Recommended Values: We recommend having hotlinks between 128 and 255 characters in length.
Location: Power User Interface
How many minutes to wait before resending failed letters (try_resend_to_broken_smtp)
Name: try_resend_to_broken_smtp
Description: Defines the frequency (in minutes) at which the system tries to resend emails that failed due to a broken SMTP connection. Note that this global variable works in conjunction with the Do not resend old letters global variable. For example, if this global variable is set to 30 and the Do not resend old letters global variable is set to 3, the system attempts to resend the email every thirty minutes until either the email is sent or, if the SMTP connection remains broken, the email is 3 days old.
For more information, see Required Email Setup.
Default Value: 30
Allowed Values: integer
Location: Power User Interface
How to update a record locked by a user (process_email_when_record_locked_by_user)
Name: process_email_when_record_locked_by_user
Description: When someone submits an update to a record by sending an email, and that record is currently locked by a user, this variable determines what happens. Set this to -1 to wait until the record is unlocked, then update it. Set this to 0 to update the record immediately. Set it to a positive integer to set the number of seconds to wait until updating the record, while it is still locked.
Default Value: -1
Allowed Values: An integer from -1 - 60
Location: Power User Interface
IAM KB Name (ocr_iam_kb_name)
Name: ocr_iam_kb_name
Description: The Identity and Access Management (IAM) KB name.
Default Value: EW Support
Location: Power User Interface
IAM Server (ocr_iam_server)
Name: ocr_iam_server
Description: The URL for the Identity and Access Management (IAM) KB server.
Default Value: https://support.agiloft.com
Location: Power User Interface
Include 'Saved Search' button in default action bar (show_saved_search_to_left_filter_button_ab)
Name: show_saved_search_to_left_filter_button_ab
Description: Controls whether to show the Saved Search button to the left of the Search button in the default action bar.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Inbound letters limit (inbound_processing_count_limit)
Name: inbound_processing_count_limit
Description: Defines how many emails can be received during one POP3/IMAP session. The value contained in this variable must be less than the specified total system value defined in wildfly.local.properties as mail.incoming.session.limit, which is 100 by default.
Default Value: 50
Allowed Values: integer
Location: Power User Interface
Iterative resolving variables and formulas in the email body (iterative_email_body_formula_resolver)
Name: iterative_email_body_formula_resolver
Description: Adds a second cycle of variable resolution for the body and subject of an email when the value is Yes. For example, if a Service Requests email template includes $solution, which adds the resolution to the email body, and the Resolution field includes "Working Hours to Close: $working_hours_to_close" at the end, by default, that text is included in the email body without inserting the actual value of the Working Hours to Close field. With this global variable set to Yes, this is first resolved to the text of the Resolution field, and then checked a second time to resolve the value of the number of working hours entered.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Keep slash prior escaped dollar sign (keep_slash_in_escaped_dollar_sign)
Name: keep_slash_in_escaped_dollar_sign
Description: Determines whether the system keeps a backward slash (\) inserted into a document template before a dollar sign ($) after formula processing.
Normally, when using dollar signs in a print template to format values in a number field, the dollar sign is eliminated because the system expects it to be part of a formula. One workaround is to put a backward slash (\) in front of the dollar sign. This retains the $ sign in the output of the template and removes the slash. This variable, if set to Yes, does not remove the slash from the output. The result:
Value | Result |
No | \$25,000 - result: $25,000 |
Yes | \$25,000 - result: \$25,000 |
Default value: No
Location: Power User Interface
Layouts in EUI (eui_layout)
Name: eui_layout
Description: Determines what record layout is used when power users access a record from the EUI. When set to "Based on user group," the system checks whether the user belongs to any power user groups. If they do belong to at least one power user group, they are shown the power user layout instead of the end user layout.
Default Value: End user layouts
Allowed Values: Based on user group, End user layouts
Location: Power User Interface
LDAP Read Timeout (ldap_read_timeout)
Name: ldap_read_timeout
Description: Changes the timeout for running queries via Active Directory. For example, if the LDAP Filter uses a complex search, it will timeout if it runs over the 10 second default timeout restriction.
Default Value: 30 seconds
Allowed Values: integer
Location: Power User Interface
Login URL (LoginURL)
Name: LoginURL
Description: Determines the location to which the system directs users when they are logged out automatically from Agiloft due to a system timeout. This URL also determines where users are directed if they enter an incorrect login or password when attempting to login manually.
This URL can be overridden by parameters in a custom login block or hyperlink. For more information see:
- How do Users Access the System? for creating custom login blocks.
- Hyperlinks for creating and using custom hyperlinks.
Default Value: /gui2/login.jsp
Recommended Values: In conjunction with the Exit URL global variable, define this global variable to ensure that users never see the default system login screen.
Location: Power User Interface
Max Email Attach Size (max_size_of_email_attachments_in_kbytes)
Name: max_size_of_email_attachments_in_kbytes
Description: Defines the maximum size of attachments (in kilobytes) that Agiloft is able to send. If the cumulative size of any attachments exceeds this amount, the sender receives an error message and the email is not sent. See Email Troubleshooting for more information.
Default Value: 7500
Recommended Values: There are two things to consider if configuring this global variable:
- Even if an email contains attachments whose cumulative size falls within the limit defined in this global variable and its body size falls within the limit defined in the Max Email Body Size (without attachments) global variable, your email cannot successfully send if its overall size (body and attachments) exceeds the limits set by your SMTP.
- Allowing Agiloft to send very large files can lead to slower performance.
Location: Power User Interface
Max Email Body Size (without attachments) (max_size_of_email_body_in_kbytes)
Name: max_size_of_email_body_in_kbytes
Description: Defines the maximum email body size (in kilobytes) that Agiloft is able to send. The body size of an email does not include attachments. If the body size of an email exceeds this amount, the sender receives an error message and the email is not sent. See Email Troubleshooting for more information.
Default Value: 5000
Recommended Values: There are two things to consider if configuring this global variable:
- Even if an email body size falls within the limit defined in this global variable and it contains attachments whose cumulative size falls within the limit defined in Max Email Attach Size global variable, your email cannot successfully send if its overall size (body and attachments) exceeds the limits set by your SMTP.
- Allowing Agiloft to send very large emails can lead to slower performance.
Location: Power User Interface
Maximum allowed recursion depth for rules (rules_recursion_depth)
Name: rules_recursion_depth
Description: Asserts a limit on how many recursive changes can be made based on a single trigger point. For example, if a user edits a record, and that triggers a rule, and the rule runs a record update that triggers another rule, this variable controls how many subsequent triggers are followed before the system stops processing.
Default Value: 10
Allowed Values: An integer from 4 - 40
Location: Power User Interface
Maximum Number of External Records to Cache (max_LF_records_cached_for_quick_search)
Name: max_LF_records_cached_for_quick_search
Description: This variable applies to linked fields that link to many records. It places a limit on the number of linked records that are cached in case the linked field is used as a quick search filter.
Default Value: 100
Allowed Values: integer
Location: Power User Interface
Maximum number of large files attached to a record to be indexed (max_large_files_to_fts_index)
Name: max_large_files_to_fts_index
Description: Defines the maximum number of large files attached to a record that the system can full-text index. Once this limit is reached, full-text indexing stops for all remaining large files. For full-text indexing, a file is considered “large” if it is bigger (in kilobytes) than the value set in the Maximum size of file to be fulltext indexed global variable.
Default Value: 5
Recommended Values: Dangerous if too high.
Location: Power User Interface
Maximum size of archive to be fulltext indexed (max_archive_size_to_fts_index)
Name: max_archive_size_to_fts_index
Description: Defines the maximum archive size (in kilobytes) that the system can extract files from for full-text indexing.
Default Value: 200
Recommended Values: Very dangerous if too high.
Location: Power User Interface
Maximum size of file to be fulltext indexed (max_file_size_to_fts_index)
Name: max_file_size_to_fts_index
Description: Defines the maximum file size (in kilobytes) that the system can extract text from when creating the full-text search index. If the file size exceeds the value defined in this global variable, the first x kilobytes of the file are indexed with a "strings" extracting algorithm like the strings Unix utility.
Default Value: 10240
Recommended Values: Dangerous if too high
Location: Power User Interface
OCR PDF files containing text (ocr_pdf_files_with_text)
Name: ocr_pdf_files_with_text
Description: Defines whether the system completes the OCR process in OCR-enabled file fields when a PDF file that contains text is attached. Select Yes to allow the system to complete the OCR process in such instances.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
OCR Threads Maximum Number (ocr_threads_max_number)
Name: ocr_threads_max_number
Description: If OCR is performed on many documents at the same time, and they each simultaneously use the number of threads allowed by the OCR Threads Number global variable, system performance could be affected. This global variable sets a limit to the total number of threads that can perform OCR across any number of simultaneous PDFs.
For instance, imagine that this global variable is set to 32. If there are 100 documents queued for processing, the system will not use more than 32 threads at a time. This protects server performance during intensive OCR sessions.
Default Value: 32
Allowed Values: An integer from 1 - 128
Location: Power User Interface
OCR Threads Number (ocr_threads_number)
Name: ocr_threads_number
Description: Defines the number of threads that can be used simultaneously when completing the OCR process on multi-page PDFs.
During OCR, threads work together to process the document. Each thread recognizes and processes a single page at a time. By increasing or decreasing the number of OCR threads available, you can either speed up or slow down the document recognition process. Keep in mind that larger thread numbers can affect server load.
Default Value: 6
Allowed Values: An integer from 1 - 32
Location: Power User Interface
Protect All Communication table for custom fields exceed table limit (comm_table_column_limit_check)
Name: comm_table_column_limit_check
Description: When enabled, this variable protects the size of the Communications table and its subtables by preventing users from creating new fields in the tables if they reach 95% of their size limit. This ensures 5% of space remains for system usage, such as if fields are added in a new release. We recommend that you leave this variable enabled.
Default Value: Yes
Allowed Values: Yes, No
Location: Power User Interface
Row size limitation warning (row_size_limitation_warning)
Name: row_size_limitation_warning
Description: Shows a warning when the table exceeds a certain percentage of the size limit for the table. For example, at the default value of 50, a warning appears when a table exceeds 50% of the size limit.
Default Value: 50
Allowed Values: An integer from 1 - 100
Location: Power User Interface
S3 storage cache total max size in MB (S3_cache_max_total_size_in_mb)
Name: S3_cache_max_total_size_in_mb
Description: Determines the size limit for total local file storage before files are moved to S3 storage, if S3 storage is enabled for the KB and configured to use an option that references a cache size limit.
Default Value: 1024
Allowed Values: An integer from 1 - 99999999
Location: Power User Interface
S3 storage migration max duration (S3_migration_max_duration_in_minutes)
Name: S3_migration_max_duration_in_minutes
Description: Defines the maximum duration (in minutes) of an S3 migration event. If the migration can't complete in the number of minutes defined by this variable, the operation stops once the current file is moved. Then the migration continues the next time an S3 migration event is triggered.
Default Value: 30
Allowed Values: An integer from 1 - 1000
Location: Power User Interface
S3 storage migration timeslot (S3_migration_timeslots_in_minutes)
Name: S3_migration_timeslots_in_minutes
Description: Defines the maximum time to wait between S3 migration events. When an S3 migration ends, the time slot for the next event is calculated as a random value between 0 and the number of minutes set in this variable.
Default Value: 30
Allowed Values: An integer from 1 - 1000
Location: Power User Interface
Salesforce Max Threads (sf_max)
Name: sf_max
Description: This variable sets the maximum number of threads that can be used to sync with Salesforce. A high number will result in faster synchronization but impose a greater burden on interactive performance. The recommended range is 1 to 16, depending upon the number of CPU’s and amount of RAM on the machine. At least 48G RAM is required for a value of 16.
Default Value: 2
Allowed Values: An integer from 1 - 32
Location: Power User Interface
SAML Request secure Hash Algorithm (saml_req_enc_digest_algo)
Name: saml_req_enc_digest_algo
Description: Defines the encryption algorithm for SAML authentication requests. Typically SHA-256.
Location: Power User Interface
SCCM Max Threads (sccm_max)
Name: sccm_max
Description: Sets the maximum number of threads to use to sync with Microsoft System Center Configuration Manager (SCCM). A higher number of threads results in faster synchronization but slows down interactive performance. We recommend a range of 1 to 16, depending upon the number of CPU and amount of RAM on the server. At least 48G RAM is required for a value of 16.
Default Value: 2
Allowed Values: An integer from 1 - 32
Location: Power User Interface
Set Creation Date on Record Saving (creation_date_on_save)
Name: creation_date_on_save
Description: Defines how the system determines the date of record creation. Select Yes for the date of record creation to be captured at the moment when the record is saved, rather than when the New button is clicked, as is the case by default. This can be useful in cases where time-based rules fail to trigger because the user spent too much time creating the record after clicking New, and the record becomes too old after the first save.
For instance, suppose you are handling support issues and they need to be acknowledged or assigned within 10 minutes to meet their service-level agreement, but the creator spends 20 minutes filling out the form. Without this new variable being set to Yes, the Date Created will already be 20 minutes old when the record is saved.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Should inbound process replies from other tables (inbounds_process_strange_replays)
Name: inbounds_process_strange_replays
Description: Determines whether inbound accounts process replies sent from other tables. Select Yes to enable processing replies from other tables. This may result in inbound accounts processing strange replies.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Show action buttons at the bottom of the record (show_action_buttons_bottom_row)
Name: show_action_buttons_bottom_row
Description: Defines whether to show action buttons at the bottom of forms in addition to the top. If set to Yes, action buttons like Save, Edit, and Cancel are also visible at the bottom of forms.
Default Value: No
Location: Power User Interface
Show navigation buttons at the bottom of the setup wizard (show_navigation_buttons_bottom_row)
Name: show_navigation_buttons_bottom_row
Description: Defines whether to show navigation buttons at the bottom of setup wizards in addition to the top. If set to Yes, navigation buttons like Back, Next, Finish, and Cancel are also visible at the bottom of wizard forms.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Specify character(s) that separate the list of Group/Team Names sent in SAML Assertion response (saml_grp_team_separator)
Name: saml_grp_team_separator
Description: SAML Identity Providers can choose to send Group and Team names as a list. This variable allows you to enter the character(s) used to separate each group/team name in the list. Note that space or tab character cannot be used as a separator. For example, if you need to send a list of groups for SAML as "Customer Group;Contract Creator Group", set this variable to ;.
Default Value: blank
Allowed Values: short text
Location: Power User Interface
Strip HTML Formatting During Copy Paste (html_paste_optimize)
Name: html_paste_optimize
Description: Controls pasting into HTML text fields. Set to Yes to strip formatting when pasting, which improves performance for pasting large blocks of text. Set to No to preserve formatting, which is usually recommended but can have performance impact when pasting large entries.
Default Value: No
Recommended value: Unless you need to paste large amounts of text into HTML fields, leave this set to No.
Location: Power User Interface
Strip non-printable characters (strip_non_printable_characters)
Name: strip_non_printable_characters
Description: Determines whether the system removes all non-printable characters from all text fields. Select Yes to remove these characters.
If you select Yes, this could have an impact when using hidden tags in HTML fields for processing.
Default Value: No
Recommended value: Due to the potential impact, we recommend that you do not remove these characters.
Location: Power User Interface
Style preference for paragraphs in Printed Document (printtemplatestylepreference)
Name: printtemplatestylepreference
Description: Defines whether the paragraph styles in a printed document should be determined by the styles of the print template or by the styles of the respective HTML field.
This global variable is only relevant in the processing of fields defined as HTML text. If you insert a field variable for an HTML-formatted text field into a print template, this global variable determines whether any HTML style formats – such as font face, size, and color – are retained or overridden by the MS Word style of the paragraph into which it is inserted in the print template. Note that bullets and numbers in the HTML field are retained with either setting.
Value | Result |
|---|---|
field | Preserves the font and paragraph formatting in any HTML field inserted into the print template. This includes font face, size, color, and paragraph spacing. Here is an example with the variable set to field:
|
printtemplate | Applies the MS Word paragraph style from the print template and eliminates any HTML font formatting in the field (such as font face, size, or color) but preserves bold, italic, and underlining. Here is the same template from above with the variable set to printtemplate:
|
Default Value: printtemplate
Location: Power User Interface
Threads to use for Contract Clause Creation (print_templ_contract_clause_threads)
Name: print_templ_contract_clause_threads
Description: This is used by Document Template actions to specify the maximum number of threads to use to speed up Contract Clause records creation. A high number results in faster processing but imposes a greater burden on interactive performance. The recommended range is 1- 8, depending upon the number of CPUs and amount of RAM on the machine. At least 48G RAM is required for a value of 8. On shared servers, it is recommended to set a value of 2 in order to avoid imposing a load that affects other KBs. On dedicated servers, the value can be half of the number of CPUs available. For a dedicated server with 8 CPUs, the value can be 4, or for 16 CPUs, the value can be 8.
Default Value: 1
Recommended Values: 1
Allowed Values: An integer from 1 - 8
Location: Power User Interface
Timeout for File Checkout Lock (direct_edit_checkout_lock_timeout)
Name: direct_edit_checkout_lock_timeout
Description: Defines the amount of time (in minutes) before the checkout expires if a file is checked out through direct editing and not checked back in. For more information about direct editing, see Direct File Edit.
Default Value: 1440
Allowed Values: integer
Location: Power User Interface
Timeout: Record Update Time (record_update_timeout)
Name: record_update_timeout
Description: Defines the maximum amount of time (in seconds) that can be spent on record creation and updating at the server. If an update takes longer than the specified amount of time, the transaction fails and is rolled back.
Default Value: 600
Allowed Values: integer
Location: Power User Interface
Timeout: Run Rule in Background (async_rule_transaction_timeout)
Name: async_rule_transaction_timeout
Description: Rules run in the background will time out if working for more than X seconds.
Default Value: 14400
Allowed Values: integer
Location: Power User Interface
Timeout: Table Search Time (table_search_timeout)
Name: table_search_timeout
Description: Defines the maximum amount of time (in seconds) that can be spent searching a single table using the "Search All Tables" functionality. If the time is exceeded within a particular table, the search in that table is cancelled. The search results in other tables still appear.
Default Value: 30
Allowed Values: integer
Location: Power User Interface
Timeout: Wait to Run Rule In Background (async_rule_run_wait_timeout)
Name: async_rule_run_wait_timeout
Description: Asynchronous rules wait for X milliseconds for a free slot in a thread pool before returning to the queue. This is used to optimize how asynchronous rules run in the background when handling mass changes.
Default Value: 500
Allowed Values: An integer from 1 - 10000
Location: Power User Interface
Track envelopes sent outside Agiloft (track_envelopes_sent_outside_agiloft)
Name: track_envelopes_sent_outside_agiloft
Description: Controls whether records are created automatically in the DocuSign Envelopes table when DocuSign envelopes are created outside Agiloft. If you change this variable to Yes, this feature is turned on, and the table in Agiloft will contain records for every envelope associated with the DocuSign account. If you leave it set to No, DocuSign data is accepted only for envelopes that already have a DocuSign Envelope record.
In most cases, this should be set to No. If you set it to Yes, envelopes that were intentionally handled outside of Agiloft become visible in Agiloft, so you need to evaluate the permissions associated with attachments and DocuSign tables to make sure those envelopes are available only to the appropriate users. You might also modify the DocuSign Envelope table rules so that Attachment records aren't created for DocuSign envelopes that didn't originate in Agiloft.
Default Value: No
Recommended Values: No
Location: Power User Interface
Treat message/rfc822 email parts as attachments (attach_message_rfc822)
Name: attach_message_rfc822
Description: Defines how the system treats content with a content type of message/rfc822 when processing inbound emails. Select Yes to treat content of this type as attachments. If set to No, the system merges content of this type with the main email body.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Update already generated Email hotlinks when accessed by user(s) (updateEmailHotlinks)
Name: updateEmailHotlinks
Description: Determines whether email hotlinks are updated when accessed by users. If you select Yes, the system automatically adapts the email hotlinks for a user based on the current Authentication option of the user.
Default Value: No
Recommended Values: If it is likely (or possible) that your Single Sign-on option can change for users after email hotlinks are generated, set this global variable to Yes.
Location: Power User Interface
Use AltChunk while running a Print Action (applyAltChunkAutoNum)
Name: applyAltChunkAutoNum
Description: Determines whether the system processes HTML fields as altchunks in Microsoft Word while running a Print action.
If you select Yes, any auto-numbering or bullet formats in the print template are lost for inserted HTML fields, and the Normal (Web) style is used instead. This is how the system previously functioned, but an enhancement changed how HTML fields are processed so that the paragraph formatting in the print template is retained. This global variable is available on the small chance that someone wants to return to the system’s previous behavior.
Default Value: No
Recommended Value: This variable provides backward compatibility but there is no expected situation in which behavior would be desirable. As such, leaving the variable inactive or set to No is the best policy.
Location: Power User Interface
Use loginless user during email processing (use_login_less_users_in_email_processing)
Name: use_login_less_users_in_email_processing
Description: If a user who does not have an Agiloft login emails an inbound email account, email processing usually uses the credentials and information of the user record specified in the "Update the record under this user account" option on the Access tab of the Inbound Email wizard to create or edit the relevant record. If this global variable is enabled and the system receives an email from such a user, email processing creates or edits the relevant record using the loginless user's user record rather than using the user record specified in the Inbound Email account settings.
Note that with this global variable enabled, any changes created in the above circumstances are attributed to an Unknown User in the record history. Additionally, it is not possible to use a loginless user for versioned attachments processing, even with this variable enabled. Of course, if you have configured a table's inbound email account so that emails for record creation or updates are discarded if the sender is not recognized, this global variable has no effect. For more information, see Customize Optional Inbound Email Settings.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Use sub-selects rather than temp tables (avoid_temptables)
Name: avoid_temptables
Description: Determines whether the system attempts to use sub-selects rather than temporary tables to respond to and display the results of related table filters, linked field multi-value-enabled filters, and other complex saved searches. Select Yes to ensure that the system attempts to use sub-selects before using temporary tables. Using temporary tables often negatively effects performance.
Note that if this global variable is set to No, then the Force use sub-selects rather than temp tables for complex filters global variable has no effect, regardless of its value. If this global variable is set to Yes, then the value of the Force use sub-selects rather than temp tables for complex filters global variable takes effect.
Default Value: Yes
Recommended Values: Due to the potential performance impact of using temporary tables, we recommend keeping this global variable set to Yes.
Location: Power User Interface
Use subtype distinction in attached email fields (strict_subtype_email_fields_mode)
Name: strict_subtype_email_fields_mode
Description: Defines whether email templates can store field selections across subtables. If this variable is set to Yes, email templates can store fields per subtable. If No, selected fields are propagated across the parent table and subtables. This variable has no effect on single-level tables. If you change this value, make sure you modify any email templates on multi-level tables.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Use subtype distinction in attached MS Teams fields (strict_subtype_ms_teams_fields_mode)
Name: strict_subtype_ms_teams_fields_mode
Description: Defines whether Microsoft Teams templates can store field selections across subtables. If this variable is set to Yes, Teams templates can store fields per subtable. If No, selected fields are propagated across the parent table and subtables. This variable has no effect on single-level tables. If you change this value, make sure you modify any Teams templates on multi-level tables.
Default Value: No
Allowed Values: Yes, No
Location: Power User Interface
Web Tracking Entry URL (web_tracking_entry_point_url)
Name: web_tracking_entry_point_url
Description: Defines the location of a special page on the web site that is used as an entry point when a user clicks a link from a marketing email sent by the Agiloft system. When a user clicks on a marketing campaign link, they are brought briefly to this page before continuing to the linked page. This entry point can be used to auto-register a user for web-tracking. Additionally, it can be used to track the efficacy of an email campaign by recording the fact the user was led to the webpage through a marketing email.
Default Value: blank
Location: Power User Interface
Multi-Level Global Variables
The following list contains all of the global variables that exist in both the Admin Console and the Power User Interface. To access global variables in the Admin Console, go to General > Variables. To access global variables in the Power User Interface, go to Setup > System > Manage Global Variables.
Action Button Edits (action_button_edits)
Name: action_button_edits
Description: Determines whether an option appears on the Permissions tab when creating or editing an Action Button field that can allow groups to execute actions for any record in which the action button is visible to them, regardless of whether they have permissions to edit the record.
Default Value: Yes
Allowed Values: Yes, No
Location: Admin Console, Power User Interface
Agiloft Services API endpoint version in request payload (aws_agiloft_api_endpoint_request_version)
Name: aws_agiloft_api_endpoint_request_version
Description: The Agiloft Amazon API endpoint version for requests.
Default Value: v0
Location: Admin Console, Power User Interface
Agiloft Services API Gateway Stage (aws_agiloft_api_gw_stage)
Name: aws_agiloft_api_gw_stage
Description: The Amazon API Gateway Stage name. This is a logical reference to the lifecycle state of your API, such as staging, test, or prod. For more information, see Amazon's documentation on API stages.
Allowed Values: prod, staging, test, or a custom name
Default Value: prod
Location: Admin Console, Power User Interface
Agiloft Services API Gateway URL (aws_agiloft_api_gw_url)
Name: aws_agiloft_api_gw_url
Description: A template that defines the Agiloft Amazon API Gateway URL. This value is set automatically and should not need to be edited. The template includes a {region} placeholder, which the system automatically replaces with the AWS Region value from Setup > Integration > Agiloft Platform Services Configuration.
Default Value: https://agiloft-api-gw-{region}.agiloft.com
Location: Admin Console, Power User Interface
Always Show Action Button in Views (action_button_permission_check_on_execute)
Name: action_button_permission_check_on_execute
Description: Controls how action button permissions are evaluated when an action button is included in a View. If this variable is set to Yes, action buttons are shown in the table view whenever the user has View permission to the button, even if the user doesn't have Edit permission to the record. If it is set to No, buttons are shown only when the user has Edit permission to the record, or when the global variable Action Button Edits == Yes and the action button permission "Allow these groups to execute actions for any record in which the action button is visible to them, from edit or view mode" includes one of the user's groups. The advantage of setting it to Yes is performance. Depending on permission settings it can take a long time to find out what records the user is allowed to view. The advantage of setting it to No is that it avoids the possibility of the user clicking the button, just to get an error message saying that he is not allowed to edit the record.
Default Value: Yes
Allowed Values: Yes, No
Location: Admin Console, Power User Interface
BeyondTrust Host Names or IP Addresses (hosts_allowed_to_send_bomgar_events)
Name: hosts_allowed_to_send_bomgar_events
Description: Integration with BeyondTrust was deprecated in Release 25.1. This variable is not functional in 25.1 and later releases.
Default Value: blank
Location: Admin Console, Power User Interface
Cancel URL (cancelurl)
Name: cancelurl
Description: Defines the default URL that appears after users cancel out of a record if they logged in through a hotlink. If this value is not defined, the default value is the URL defined in the Exit URL global variable.
For more information, see Hyperlinks in Emails.
Default Value: blank
Location: Admin Console, Power User Interface
Cognizer ICA Base URL (cognizer_ica_base_url)
Name: cognizer_ica_base_url
Description: Cognizer ICA Base URL
Default Value: https://ica.ap.genius.agiloft.com
Location: Admin Console, Power User Interface
Concurrent OCR Number (concurrent_ocr_number)
Name: concurrent_ocr_number
Description: Sets a limit to the number of PDFs that can be processed with OCR simultaneously.
Default Value: 6
Allowed Values: An integer from 1 - 32
Location: Admin Console, Power User Interface
Displaying Time Zone Label next to field (timezone_label_display)
Name: timezone_label_display
Description: Determines when the system shows the Time Zone label next to a time-related field. The available choices are:
- Always Display Time Zones
- Display Time Zones only for fields not in KB Time
- Never Display Time Zones
Default Value: Display Time Zones only for fields not in KB Time
Location: Admin Console, Power User Interface
DocuSign API Version (docusign_api_version)
Name: docusign_api_version
Description: Defines the DocuSign API version.
Default Value: v2.1
Allowed Values: v2, v2.1
Location: Admin Console, Power User Interface
Embedded Search Results (Embedded_Search_Results)
Name: Embedded_Search_Results
Description: Determines what algorithm is used to sort Embedded Search Results fields. Possible values are:
- One Step: The system uses a standard database to obtain sorted results.
- Two Step: The system selects records and then sorts them accordingly. If the number of results is less than 500, this approach quickly delivers results. However, if the number of results is large, this approach can be very slow. Additionally, this requires the use of temporary tables.
- Base on View: The system dynamically selects either the One Step or Two Step approach. If the number of results is more than the number allowed to be displayed in the view, the system uses One Step. If the number is less, the system uses Two Step.
- Based on Embedded_Search_Results_Size variable (NUMBER): The system dynamically selects either the One Step or Two Step approach. If the number of results is more than the number specified in the Embedded Search Results Size global variable, the system uses One Step. If the number is less, the system uses Two Step.
Note that the system recognizes instances in which the variable is not set or is set to an invalid value as Base on View.
If you do not want your system to use temporary tables, this variable must be set to One Step and both the Force use sub-selects rather than temp tables for complex filters and the Use sub-selects rather than temp tables global variables must be set to Yes.
Default Value: One Step
Location: Admin Console, Power User Interface
Embedded Search Results Size (Embedded_Search_Results_Size)
Name: Embedded_Search_Results_Size
Description: Defines the number of results the system uses in the Based on Embedded_Search_Results_Size (NUMBER) option of the Embedded Search Results global variable. Enter any number between 0 and 10000.
Default Value: 1000
Allowed Values: An integer from 0 - 10000
Location: Admin Console, Power User Interface
Error URL (errorurl)
Name: errorurl
Description: Determines where the system directs users if they encounter an error while attempting to log in to Agiloft through a hyperlink. For more information, see Hyperlinks.
Default Value: blank
Allowed Values: A valid URL
Location: Admin Console, Power User Interface
Exit URL (exiturl)
Name: exiturl
Description: Determines where the system directs users when they:
- Click the Log Out link to log out of Agiloft.
- Click Finish or Close after editing or viewing a record through a hyperlink. For information, see Hyperlinks.
This URL can be overridden by parameters in the custom login block or hyperlink. For more information, see:
- How do Users Access the System? for creating custom login blocks.
- Hyperlinks for creating and using custom hyperlinks.
Default Value: /login.jsp
Recommended Values: In conjunction with the Login URL global variable, define this global variable to ensure that users never see the default system login screen.
Location: Admin Console, Power User Interface
Fixer.io Service Access Key (fixerioaccesskey)
Name: fixerioaccesskey
Description: This global variable contains a Fixer.io API key that is used by the rateOfExchange and convertCurrencyfunctions to provide foreign exchange rates and currency conversion. By default, this global variable contains a free Fixer.io key that allows 100 calls per month. If you need to use this API more frequently, purchase a new key and enter it here. For more information, see Currency conversion.
Location: Admin Console, Power User Interface
FTS Response Time (averageftsresponsetimelimit)
Name: averageftsresponsetimelimit
Description: Determines the number of seconds that Agiloft gives for FTS (Full Text Search) to respond to a query from SQL. After this time limit, FTS returns all records that match the search. Effectively, this global variable restricts the number of returned records by restricting the number of records that FTS is able to search before presenting records.
Default Value: 2
Recommended Values: In most cases, this global variable should only be altered by developers. It is intended for very slow machines or KBs with very large FTS-indexed tables.
Location: Admin Console, Power User Interface
GDrive Agiloft folder name (gdrive_agiloft_folder_name)
Name: gdrive_agiloft_folder_name
Description: For integrations with the Google Drive and Docs applications, this variable defines the name of the folder on Google Drive where Agiloft opens attached documents for editing. The folder is created automatically during the integration setup. For more information, see Agiloft Google Drive Integration.
Default Value: agiloft_documents
Allowed Values: text
Location: Admin Console, Power User Interface
Hotlink Server Root URL (hotlinkServerRoot)
Name: hotlinkServerRoot
Description: Defines the URL that is prefixed to email hotlinks. For more information, see Hyperlinks in Emails. This variable is also used in company branding from a hosted server and to address non-standard installation scenarios. Note that this URL should not include a trailing slash (/) at the end.
Default Value: The URL of the server that the system detects as its host.
Recommended Values: Because the default value is correct in almost all cases, it should not be necessary to set this variable unless DNS is misconfigured or the application is told that it is listening on the wrong port. For example, the application might be told it is listening to HTTP rather than HTTPS (or vice versa).
Location: Admin Console, Power User Interface
Hotlink Type (hotlinktype)
Name: hotlinktype
Description: Defines the type of login URL to use in system-generated email hotlinks: STANDARD, CAS, OTHER_SSO, SAML20, or OAUTH20. When the value is STANDARD, all email hotlinks go to the standard login page, login.jsp. If the value is SAML20, for example, all email hotlinks go to the SAML login page, samlssologin.jsp.
Based on a user's login method, Agiloft automatically manages which hotlink URL they receive in email. Each time a user logs in, the system sets a hidden SSO Authentication Method field in the user's record. If a user logs in with a standard username and password, the value is STANDARD. If a user logs in with SAML 2.0 SSO, for example, the value is SAML20. The value of SSO Authentication Method supersedes the Hotlink Type variable setting. For this reason, we don't recommend changing Hotlink Type unless instructed to do so by Agiloft Support.
Default Value: STANDARD
Recommended Values: We don't recommend changing this value unless otherwise instructed by Agiloft Support.
Location: Admin Console, Power User Interface
LF Auto Display Type Limit (lf_auto_limit)
Name: lf_auto_limit
Description: Specifies the limit for the number of linked source field records that are displayed as a list when the display type is Auto. When the limit is exceeded, an input box with lookup is used instead of a list. For more information, see the Display section of Link to Selected Fields from Other Table.
Default Value: 100
Allowed Values: integer
Location: Admin Console, Power User Interface
LF List Maximum Size (lf_list_limit)
Name: lf_list_limit
Description: Specifies the limit for the number of linked source field records that are displayed as a list when the display type is List of values; when exceeded, an input box with lookup is used instead of a list. For more information, see the Display section of Link to Selected Fields from Other Table.
Default Value: 200
Allowed Values: integer
Location: Admin Console, Power User Interface
LF Propagation Delay (lf_propagation_delay)
Name: lf_propagation_delay
Description: Specifies the delay (in milliseconds) before asynchronous propagation of linked source fields gets triggered. Setting a delay helps alleviate load on the server if there are run-time activities active, like backup processes or report generation. For servers with a high number of CPUs, this delay might not be necessary. If your server has many CPUs allocated, you can set this to 0 to remove the delay.
Default Value: 1000
Allowed Values: integer
Location: Admin Console, Power User Interface
List of fields from 'contact' table/subtable to be used in SAML configuration (default_contact_fields_samlconfig)
Name: default_contact_fields_samlconfig
Description: Defines, in a comma separated list, the field names from the People table (or any subtables) that are available to map to SAML attributes in the User Field(s) Mapping tab of the SAML Configuration wizard. For example: title, first_name, last_name, email, direct_phone, cell_phone.
For more information about configuring SAML SSO, refer to SAML 2.0 SSO.
Default Value: By default, there are no values listed in this global variable and all of the field names of a user's record which can be mapped to SAML attributes are shown.
Recommended Values: Be sure to use the field names and not the field labels.
Location: Admin Console, Power User Interface
Location of external Perl directory (externalperllocation)
Name: externalperllocation
Description: If you would like to use your own Perl distribution with scripts in place of the default distribution, use this variable to define the location of your preferred perl.exe. For example, you might set it to c:\Perl64\bin. For more information, see Perl based Scripts.
Default Value: blank
Location: Admin Console, Power User Interface
Location of external Python directory (externalpythonlocation)
Name: externalpythonlocation
Description: If you would like to use your own Python distribution with scripts in place of the default distribution, use this variable to define the location of your preferred python.exe. For example, you might set it to c:\Python34. For more information, see Python Scripts.
Default Value: blank
Location: Admin Console, Power User Interface
Manual License Request URL (manual_license_request_url)
Name: manual_license_request_url
Description: Defines the URL to which users are forwarded once they request a license.
Default Value: http://www.agiloft.com/license.htm
Location: Admin Console, Power User Interface
Max Rule Records Limit (rules_rec_limit)
Name: rules_rec_limit
Description: Defines the maximum number of records on which a rule can run. For example, imagine that this global variable is set to 100,000. If a rule matches with 157,045 records, it only runs on the first 100,000.
Default Value: 100000
Location: Admin Console, Power User Interface
Max Rule Records Warning (rules_warn_limit)
Name: rules_warn_limit
Description: If a rule matches with more records than the number defined in this global variable, a warning appears.
Default Value: 100000
Allowed Values: integer
Location: Admin Console, Power User Interface
Maximum Column Length (max_column_length_per_row)
Name: max_column_length_per_row
Description: When displaying the content of a long varchar column in an HTML report, the system retrieves a substring of the value because the view width on the column in the report is typically narrower than the column's contents. This variable defines the limit on the length of the substring. The limit takes effect only when the column's value is longer than the width of the display field. For example, if the width is set to 2 rows and 70 characters, the substring length is calculated with the following function: max($max_column_length_per_row, 2*70). If this variable is set to a non-integer value, substring mode is disabled, and the system retrieves the column's full value.
Default Value: 128
Allowed Values: integer or short text
Location: Admin Console, Power User Interface
Maximum number of failed records in time-based rule (time_based_rule_max_error_records)
Name: time_based_rule_max_error_records
Description: The number of errors that can occur while running a time-based rule before the system stops processing the rule and displays an error.
Default Value: 1000
Allowed Values: An integer from 1 - 1000
Location: Admin Console, Power User Interface
Maximum Text Field Size in the Database (max_text_field_size_in_db)
Name: max_text_field_size_in_db
Description: Defines the maximum number of characters Agiloft is able to store in the database text fields when serializing complex structures.
Default Value: 16777216
Allowed Values: integer
Location: Admin Console, Power User Interface
Number of retries (time_based_rule_retries_on_lock_error)
Name: time_based_rule_retries_on_lock_error
Description: In case the system hits a record lock or deadlock when running a time-based rule, this variable defines the number of retries to perform per record.
Default Value: 1
Allowed Values: An integer from 0 - 10
Location: Admin Console, Power User Interface
Power User Title (staff_title)
Name: staff_title
Description: Defines the text that appears as the title in the browser tab when logged in to the Power User Interface.
Default Value: Agiloft Contract Lifecycle Management
Location: Admin Console, Power User Interface
Prefer fat, rather than thin indexes (PreferFatIndex)
Name: PreferFatIndex
Description: Determines whether fat indexes are preferred over thin indexes in a situation where there is more than one appropriate covering index. Fat indexes are faster but use more memory while thin indexes are slower and use less memory.
This global variable is for MySQL only.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console, Power User Interface
Prefer USE INDEX hint, rather than no hints (UseIndex)
Name: UseIndex
Description: Controls whether the Agiloft optimizer is on or off. If set to Yes, the Agiloft optimizer searches for an appropriate covering index and forces the use of that index, rather than letting MySQL use its own query optimizer/execution paths. Additionally, the Agiloft optimizer would create indexes for field(s) if a query is run that could have been optimized with such an index. Note that this global variable is for MySQL only.
Default Value: No
Recommended Values: It is recommended that you keep this global variable set to No because some queries may be rare and, as such, don't warrant the creation of an index for a single run. For optimized performance, it is best to create indexes for those fields that are used most often in a query.
Location: Admin Console, Power User Interface
Product Name (product_name)
Name: product_name
Description: Defines the name used for branding. Any value you enter in this global variable replaces “Agiloft” anywhere that it is hard-coded into the interface. Note that customizing this global variable does not complete all of the changes you need to make to brand your system. For information about changing the logo or the text that appears as the title in the browser tab refer to the Power User Look and Feel page or Staff Title global variable, respectively.
Default Value: Agiloft
Location: Admin Console, Power User Interface
Product Short Name (shortproductname)
Name: shortproductname
Description: Defines a short name used for branding. Any value you enter in this global variable replaces “Agiloft” anywhere that it is hard coded into the interface. Note that customizing this global variable does not complete all of the changes you need to make to brand your system. For information about changing the logo or the text that appears as the title in the browser tab refer to the Power User Look and Feel page.
Default Value: Agiloft
Location: Admin Console, Power User Interface
Product website (product_site)
Name: product_site
Description: Defines the URL used for any references to the product website made in the Help manual. This global variable may be set to any URL.
Default Value: agiloft.com
Location: Admin Console, Power User Interface
PSPDFkitKey (pspdfkit_license)
Name: pspdfkit_license
Description: This supplies the license key for PSPDFKit, which is used by the document viewer to display text files in Agiloft. In most cases, this key is generated automatically, and this variable does not need to be edited.
Default Value: Auto-generated license key
Location: Admin Console, Power User Interface
Records per Transaction (rule_records_per_transaction)
Name: rule_records_per_transaction
Description: Defines how many records a time-based/summary rule may process in a single transaction. Any records remaining over the value defined in this global variable are processed consecutively in new transactions.
Default Value: 15
Allowed Values: An integer from 1 - 100
Location: Admin Console, Power User Interface
Revindex Optimization Period (AllowableOptimizeTablePeriod)
Name: AllowableOptimizeTablePeriod
Description: Defines the time of day (in hours) when the full-text search indexes are automatically optimized. For example, 22-05 means the optimization task runs between 10PM and 5AM.
This allows you to schedule the optimization during nights or weekends and prevents production servers from slowing down during business hours.
Default Value: 22-05
Location: Admin Console, Power User Interface
Salesforce Authorize URL (sf_authorize_url)
Name: sf_authorize_url
Description: Sets the Salesforce OAuth authorization URL. Change login to test when integrating with a sandbox environment.
Default Value: https://login.salesforce.com/services/oauth2/authorize
Location: Admin Console, Power User Interface
Salesforce Token URL (sf_token_url)
Name: sf_token_url
Description: Sets the Salesforce OAuth token URL. Change login to test when integrating with a sandbox environment.
Default Value: https://login.salesforce.com/services/oauth2/token
Location: Admin Console, Power User Interface
Text auto completion (AutoCompletion)
Name: AutoCompletion
Description: Determines whether text auto completion is allowed. Select No to turn off this feature.
Default Value: Yes
Recommended Values: In most systems, text auto completion can be kept on with no drawbacks. However, in situations where an extremely large number of records may elicit auto completion, it can slow down the system to an unacceptable degree and should be turned off.
Location: Admin Console, Power User Interface
Threads: Run Rule In Background (async_rule_threads)
Name: async_rule_threads
Description: Sets how many threads can run concurrently for processing asynchronous rules, or rules running in the background, in a KB. If this variable is set in both the KB and the admin console, the smaller vlaue is used.
Default Value: 1
Allowed Values: An integer from 1 - 8
Location: Admin Console, Power User Interface
Time Zone of date/time values (date_time_display)
Name: date_time_display
Description: Determines the time zone that is used to display date/time values. The following are the possible options:
- KB time: uses the time zone set for the KB in Setup > System > Set KnowledgeBase Time
- Browser time: uses the time zone of the user's browser
- User time: uses the time zone set in the user record for the current user
Your selection for this global variable is the default time zone when creating a date/time field. You can override this time zone on a field-by-field basis.
Default Value: KB time
Recommended Values: Browser time zone is the best option when you want users to see the time in their own time zone (regardless of whether they are traveling or in their normal time zone) without doing any setup.
Location: Admin Console, Power User Interface
Timeout: Script timeout (time_based_rule_script_timeout)
Name: time_based_rule_script_timeout
Description: Defines the amount of time (in seconds) that the script action of a time-based rule is allowed to work before the it times out.
Default Value: 1800
Allowed Values: integer
Location: Admin Console, Power User Interface
Timeout: Disconnect Due to Inactivity (disconnect_timeout)
Name: disconnect_timeout
Description: Defines the amount of time (in minutes) that users can be idle before they are automatically disconnected.
Default Value: 390
Recommended Values: Generally speaking, we do not recommend setting this below 20–30 minutes because it can cause frustration when users leave their stations for a short break and come back to find that their work is lost.
Location: Admin Console, Power User Interface
Timeout: Overriden Seance Expiration Period (minimum_overriden_timeout)
Name: minimum_overriden_timeout
Description: Defines the amount of time (in minutes) after which an overridden (internal) seance is timed out.
Default Value: 0
Recommended Values: It is strongly recommended that you do not change this variable unless explicitly asked to do so by Agiloft Support.
Location: Admin Console, Power User Interface
Timeout: Record Lock Expiration Time (lock_expiration_time)
Name: lock_expiration_time
Description: Defines the amount of time (in minutes) that must pass before a record that's locked for editing becomes unlocked.
For example, if the record lock expiration is set to 30 minutes and User A is still editing the record after 35 minutes but hasn't saved, User B may open and edit the record. During this time, it appears to User A that they can continue making changes to the record. However, if User A then tries to save the record while User B is editing it, User A receives an error message and any changes they've made since last saving are lost. If User A is still editing the record after 35 minutes but no other users have opened the record for editing, User A can still save the record and keep their changes.
Default Value: 60
Recommended Values: Do not set this global variable to a value smaller than the maximum amount of time that users generally take to edit a record. This helps prevent the possibility of two users editing a record simultaneously and accidentally overwriting edits or triggering rules.
The appropriate value depends on the type of records most commonly being edited. For a support ticket, the record probably doesn’t need to be open for longer than 30 minutes. However, contract record editing takes much longer, and it is important that users do not lose valuable work by having somebody else work on a record and unknowingly overwrite their edits. We recommend carefully considering user preferences before adjusting this setting.
Location: Admin Console, Power User Interface
Timeout: Warn Record Lock Expires (lock_expiration_warn)
Name: lock_expiration_warn
Description: Defines the number of minutes before a record lock times out that the system notifies users that their lock is about to expire. This global variable works in conjunction with the Timeout:Record Lock Expiration Time global variable. For example, if Timeout:Record Lock Expiration Time is set to 60 and this global variable is set to 10, users are notified after editing a record for 50 minutes that their record lock expires in 10 minutes (amounting to 60 minutes total of editing). A value of 0 provides no warning to users.
Default Value: 0
Allowed Values: integer
Location: Admin Console, Power User Interface
Timeout: Warning Period (warning_timeout)
Name: warning_timeout
Description: Defines the number of minutes from being automatically disconnected due to inactivity that users receive a warning. This global variable works in conjunction with the Timeout:Disconnect Due to Inactivity global variable. For example, if Timeout:Disconnect Due to Inactivity is set to 30 and this global variable is set to 10, users are notified after being idle for 20 minutes and are disconnected in another 10 minutes (amounting to 30 minutes total of inactivity). A value of 0 provides no warning to users.
Default Value: 30
Allowed Values: integer
Location: Admin Console, Power User Interface
Update Changed Fields Only (record_update_changed_fields_only)
Name: record_update_changed_fields_only
Description: Determines whether saving a record updates all field values or only the field values that were changed. This can be useful in situations where concurrent modifications unintentionally overwrite earlier changes due to timing or automation.
Default Value: No
Recommended Values: Yes, No
Location: Admin Console, Power User Interface
Web Services Delay (WSDelay)
Name: WSDelay
Description: Defines a delay (in milliseconds) inserted after each REST/SOAP web services operation has completed. A delay can ensure that the rules and other system functionality invoked by each operation are allowed enough time and resources to complete. This helps prevent a misconfigured Web Service or REST program from overwhelming the server with requests.
Default Value: 1000
Allowed Values: integer
Location: Admin Console, Power User Interface
Admin Console Specific Global Variables
The following list describes the global variables that exist only in the Admin Console. To access global variables in the Admin Console, go to General > Variables.
The Admin Console is only available on dedicated or on-premise servers.
ACAO application ID (acao_msgraph_app_id)
Name: acao_msgraph_app_id
Description: The Microsoft Graph Application (client) ID for the Agiloft Contract Assistant for Outlook client application.
Default Value: blank
Allowed Values: short text
Location: Admin Console
ACAO application secret (acao_msgraph_app_secret)
Name: acao_msgraph_app_secret
Description: The Microsoft Graph Client secret for the Agiloft Contract Assistant for Outlook client application.
Default Value: blank
Allowed Values: short text
Location: Admin Console
Agiloft BOT Proxy KB Login (agiloft_bot_proxy_kb_login)
Name: agiloft_bot_proxy_kb_login
Description: The login name for the Agiloft Bot Proxy KB.
Default Value: ProxyKBUser
Location: Admin Console
Agiloft BOT Proxy KB Name (agiloft_bot_proxy_kb_name)
Name: agiloft_bot_proxy_kb_name
Description: The name of the Agiloft Bot Proxy KB.
Default Value: Bot Proxy
Location: Admin Console
Agiloft BOT Proxy KB Oauth Table Name (agiloft_bot_proxy_kb_table)
Name: agiloft_bot_proxy_kb_table
Description: The name of the OAuth configuration table in the Agiloft Bot Proxy KB.
Default Value: oauth_configuration
Location: Admin Console
Agiloft BOT Proxy KB Password (agiloft_bot_proxy_kb_psw)
Name: agiloft_bot_proxy_kb_psw
Description: The password for the Agiloft Bot Proxy KB login.
Location: Admin Console
Agiloft BOT Proxy KB URL (agiloft_bot_proxy_kb_url)
Name: agiloft_bot_proxy_kb_url
Description: The URL for the Agiloft Bot Proxy server.
Default Value: https://prod77-nsc.agiloft.com
Location: Admin Console
Agiloft OAuth 2.0 Workato Connector Provider (workato_agiloft_connector_provider)
Name: workato_agiloft_connector_provider
Description: The provider information to use to automatically connect the Agiloft OAuth 2.0 Workato connector.
Default Value: blank
Allowed Values: text
Location: Admin Console
Agiloft Services API request timeout (aws_agiloft_api_request_timeout)
Name: aws_agiloft_api_request_timeout
Description: Defines the number of minutes to wait before timing out an Agiloft Services API request.
Default Value: 10
Allowed Values: integer
Location: Admin Console
Allow Export and Import to use the TMP directory from KB (allow_exportimport_via_temp)
Name: allow_exportimport_via_temp
Description: Determines whether import and export actions can use the server's /tmp directory for storing import and export files. Enabling this variable makes the /tmp directory accessible to all KBs on the server, which is useful if you want to export data from one KB and import it into another. However, before enabling this feature, consider the data security implications of making the directory accessible to all KBs on the server.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console
Allow KB admins to export their KB (allow_admin_kb_export_run)
Name: allow_admin_kb_export_run
Description: Determines whether admins can run a KB export. If set to No, admins no longer have access to the Agiloft Data Format option in the Export wizard.
Default Value: Yes
Allowed Values: Yes, No
Location: Admin Console
Analyze table start protection period of system inactivity (AnalyzeProtectionInactivitySeconds)
Name: AnalyzeProtectionInactivitySeconds
Description: Defines the number of seconds of inactivity that the system waits before beginning automatic table analysis. This global variable works in conjunction with the Analyze Table Frequency and Analyze Tables Period global variables to determine when automatic table analysis occurs. By default, automatic table analysis occurs once a week between 11 pm and 4 am after a period of 180 seconds of system inactivity.
Default Value: 180
Allowed Values: integer
Location: Admin Console
Auto Delete Time for Temporary Files (temp_files_auto_delete_time)
Name: temp_files_auto_delete_time
Description: Defines the schedule (in number of hours) for automatically deleting files and subdirectories in the /tmp directory on the Agiloft server. By default, files and sub directories are deleted every 48 hours. If you set this variable to 0 or less, the contents of /tmp will not be deleted.
Default Value: 48
Allowed Values: integer
Location: Admin Console
Backup Active KBs Only (only_backup_active_kbs)
Name: only_backup_active_kbs
Description: Determines whether only those KBs in which someone has logged in within the past 24 hours are backed up. For more information, see Backup a Knowledgebase.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console
Bug Reports URL (bug_report_destination)
Name: bug_report_destination
Description: Defines the URL to which users are redirected to submit a support ticket when they encounter a bug within the Agiloft system.
Default Value: https://support.agiloft.com/gui2/login.jsp
Recommended Values: Change this value to the URL of your support system if you would like your organization to receive support tickets for bugs.
Location: Admin Console
Chat Refresh Rate (max_chat_refresh)
Name: max_chat_refresh
Description: Defines the minimum number of seconds (in other words, the maximum frequency) that can be chosen for a team in the Message Refresh Rate field of the Teams Wizard. This field determines how often Agiloft checks for new chat requests. The smallest functioning value is 2 seconds. For more information about configuring the Chat feature, see Chat.
Default Value: 10
Recommended Values: If you decide to enable chat, we recommend configuring this global variable. By setting a lower number, administrators can configure teams to receive new chat requests more often and prevent situations in which end-users leave a chat before a team member is notified of a new chat request.
Location: Admin Console
Cut table view text fields (cut_view_data)
Name: cut_view_data
Description: Defines the maximum size (in kilobytes) of text values to display in a table view. Values that exceed this limit are trimmed in the view. Setting this value to 0 disables the size limit for views.
Default Value: 32
Allowed Values: integer
Location: Admin Console
Delete Records Transaction Time (delete_records_transaction_time)
Name: delete_records_transaction_time
Description: The amount of time (in seconds) to spend running each delete records transaction.
Default Value: 30
Allowed Values: integer
Location: Admin Console
DocuSign Demo RSA Private Key file path (docusign_demo_rsa_private_key_file)
Name: docusign_demo_rsa_private_key_file
Description: Lists the name of the DocuSign demo account RSA private key file in the Agiloft/data/admin/docusign directory.
Default Value: demoRSAKey.txt
Allowed Values: text
Location: Admin Console
DocuSign Integration Key (default_docusign_integration_key)
Name: default_docusign_integration_key
Description: Lists the default DocuSign integration key.
Location: Admin Console
DocuSign Production RSA Private Key file path (docusign_production_rsa_private_key_file)
Name: docusign_production_rsa_private_key_file
Description: Lists the name of the DocuSign production account RSA private key file in the Agiloft/data/admin/docusign directory.
Default Value: productionRSAKey.txt
Allowed Values: text
Location: Admin Console
Embed Workato base URL (workato_base_direct_link)
Name: workato_base_direct_link
Description: Defines the base URL for Workato Embedded. The URL depends on the location (US, EU, JP, SG, or AU) of the Workato data center for the Agiloft server.
Default Value: https://app.workato.com
Allowed Values: URL
Location: Admin Console
Full Tables Access (full_tables_access)
Name: full_tables_access
Description: Protects sensitive tables, such as Communications, People, and other tables, from deletion. If set to Yes, an admin could delete these integral tables.
Default Value: No
Recommended Values: This global variable is for development purposes only. Do not enable it.
Location: Admin Console
LF Propagation Threads (lf_propagation_threads)
Name: lf_propagation_threads
Description: Optimizes linked field processing by allowing multiple propagation threads.
Default Value: 2
Allowed Values: An integer from 1 -8
Location: Admin Console
Max amount of unique user emails generated per time (max_amount_of_user_emails_per_time)
Name: max_amount_of_user_emails_per_time
Description: Defines the maximum number of unique emails to send as part of one transaction. This variable takes effect when an email with a very large number of unique recipients is sent. If the number of recipients exceeds this value, the remaining recipient emails will be sent in subsequent transactions, typically in one-minute intervals.
Default Value: 250
Allowed Values: integer
Location: Admin Console
Max History Read Size (maximum_history_records_asstring)
Name: maximum_history_records_asstring
Description: Defines the maximum number of records that the history field can include when displaying records as a string.
Default Value: 25
Allowed Values: integer
Location: Admin Console
Max History Size (max_history_entries_per_record)
Name: max_history_entries_per_record
Description: Defines the maximum number of changes that may be made to a record by timer-based background rules before additional changes do not create History records. When this number is exceeded, the update is still valid, but simply is not reflected in History. This prevents the KB from exhausting disk space as a result of misconfigured rules that frequently update records.
Enter a negative number as a value to ensure that History entries are created no matter how many changes are made by background rules.
Default Value: 100
Allowed Values: integer
Location: Admin Console
Maximal length of lexicon word (max_word_length_to_fts_index)
Name: max_word_length_to_fts_index
Description: Defines the maximum character length of words that can be indexed for full text search. Words that have more than this number of characters are excluded from the full text search index.
Default Value: 21
Allowed Values: An integer from 0 - 50
Location: Admin Console
Maximal number of temporary tables (max_number_of_temptables)
Name: max_number_of_temptables
Description: Determines the maximum number of temporary tables allowed within the system. This reduces the required disk space for those organizations that use temporary tables. If you do not use temporary tables, this global variable has no effect. For information about disabling temporary tables, see the Use sub-selects rather than temp tables global variable.
Default Value: 10000
Allowed Values: integer
Location: Admin Console
Maximum Concurrent Backups (maximum_concurrent_backups)
Name: maximum_concurrent_backups
Description: Determines the maximum number of simultaneously running backups allowed at any one time.
Default Value: 4
Location: Admin Console
Maximum Inactivity Timeout Value (max_disconnect_timeout)
Name: max_disconnect_timeout
Description: Defines the maximum number of minutes allowed for the KB-level disconnect timeout setting. If a KB administrator tries to set the disconnect_timeout global variable to a value higher than the setting of max_disconnect_timeout, the system shows a warning and does not allow the update.
Default Value: 390
Allowed Values: integer
Location: Admin Console
Maximum Nested Calls (maximum_nested_action_calls)
Name: maximum_nested_action_calls
Description: Defines the maximum number of nested calls allowed in conditional actions.
Default Value: 5
Location: Admin Console
Maximum number of Chinese Word Segmenter objects in the system (ChineseWordSegmenter_pool_size)
Name: ChineseWordSegmenter_pool_size
Description: Determines the number of CWS processes that can run simultaneously on the server. If you need full-text searching over Chinese words, set a number between 1 and 10; higher values are more resource intensive but speed up text processing. Note that, even if this variable is set between 1 and 10, you also need to set the Enable Chinese Word Segmenter global variable to Yes for each knowledgebase where you want to enable it. However, even if Enable Chinese Word Segmenter is set to Yes, if you set this variable to 0, you disable CWS on this server.
Default Value: 1
Location: Admin Console
Maximum Report Size (max_report_size)
Name: max_report_size
Description: Defines the maximum report size (in megabytes) allowed in the system.
While preparing a report, the system uses the size of the first 100 rows rendered in the HTML report to approximate the size of the resulting file. When the estimated size reaches 90% of the value specified in this global variable, the system shows only 25 rows (and any summary values) within each remaining grouping of the report. Please note that even though the number of rows in each remaining grouping is reduced, the summary values still reflect the entire grouping. When the estimated size reaches 100% of the specified value, all further rows are omitted and the report only shows the summary lines for each remaining grouping.
Setting this value too large can lead to Out of Memory errors.
Default Value: 10
Location: Admin Console
Maximum XLS Size To Export (max_excel_export_size)
Name: max_excel_export_size
Description: Defines the maximum size (in megabytes) of the Excel file created during export. Once the system reaches the defined limit, it stops writing information into the file.
Due to the fact that it allows a more memory efficient export, this global variable has no effect if you plan to use the .xlsx format in Excel 2007 or later.
Default Value: 200
Recommended Values: If this global variable applies to you, you should not set a large number. Because .xls files are loaded in memory during creation, a large export can cause an Out of Memory error that crashes the system.
Location: Admin Console
Maximum XLS Size To Import (max_excel_import_size)
Name: max_excel_import_size
Description: Defines the maximum size (in megabytes) of Excel file that you may use to import information. Due to the fact that it allows a more memory efficient import, this global variable has no effect if you plan to use the .xlsx format in Excel 2007 or later.
Default Value: 50
Recommended Values: If this global variable applies to you, you should not set a large number. Because .xls files are loaded in memory during import, a large import can cause an Out of Memory error that crashes the system.
Location: Admin Console
Max Timer Rules per KB (max_timer_rules_per_kb)
Name: max_timer_rules_per_kb
Description: Determines the maximum number of timer and summary-based rules allowed to run in a KB at any one time. Rules run sequentially when they are not allowed to run simultaneously.
Default Value: 1
Recommended Values: If you only have one KB, it is best to set this global variable to a value between 3 and 6. In general, you should not set this global variable to a high value or the occasional spike of timer-based rules can slow the system.
Location: Admin Console
MSTeams Bot Proxy REST-API URL (msteams_bot_proxy_rest_api_url)
Name: msteams_bot_proxy_rest_api_url
Description: The URL for the Microsoft Teams Bot Proxy REST API.
Default Value: https://prod77-nsc.agiloft.com/ui/bot-notifications/
Location: Admin Console
Origin URL (workato_embedded_origin_url)
Name: workato_embedded_origin_url
Description: The Workato Embedded origin URL that is used to created JWT tokens.
Default Value: blank
Location: Admin Console
Pendo Integration Key (pendo_integration_key)
Name: pendo_integration_key
Description: The Pendo.io integration key. The key is set automatically, and this variable does not need to be edited.
Default Value: System set
Location: Admin Console
Pool size of additional concurrent FTS calls for auto-completion (Max_Concurrent_FTS_Calls)
Name: Max_Concurrent_FTS_Calls
Description: Defines the size of the shared pool of additional full-text search (FTS) calls available for auto-completion.
Every auto completion starts one FTS call and can also use any of the additional FTS calls shared within the pool. By running calls simultaneously, you can increase auto-completion speed. Any integer between 3 and 1000 is valid. Note that the Text auto completion global variable must be set to "Yes" for auto-completion to work.
Default Value: 20
Location: Admin Console
Report Frequency (report_frequency)
Name: report_frequency
Description: Determines the minimum number of minutes that can be used in the "Every __ minutes" option in the Report Wizard. If the user tries to save a schedule with a lower number of minutes, the system displays the following error message: "The minimum interval for which reports can be scheduled is $report_frequency minutes."
Default Value: 20
Allowed Values: integer
Location: Admin Console
Retain Performance Data Period (retain_performance_data)
Name: retain_performance_data
Description: Determines how many days GUI performance data is retained. This global variable is applicable only if the Save Performance Data global variable is set to Yes.
Default Value: 7
Allowed Values: integer
Location: Admin Console
Revindex Threads Limit (RevindexThreadsLimit)
Name: RevindexThreadsLimit
Description: Limits the number of threads allowed to index KB content at any one time. Because Agiloft starts one dedicated revindex execution thread per KB, you can use this global variable to tune performance on servers that host multiple knowledgebases.
Default Value: CPU number + 1
Location: Admin Console
Salesforce Max Threads Adm (SF_max_admin)
Name: SF_max_admin
Description: This variable sets the maximum number of threads that can be used to sync with Salesforce. A high number will result in faster synchronization but impose a greater burden on interactive performance. The recommended range is 1 to 16, depending upon the number of CPU’s and amount of RAM on the machine. At least 48G RAM is required for a value of 16.
Default Value: 2
Allowed Values: An integer from 1 - 32
Location: Admin Console
Save Performance Data (save_performance_data)
Name: save_performance_data
Description: Controls whether performance data is saved. Select Yes to save performance data.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console
SCCM Max Threads Adm (sccm_max_admin)
Name: sccm_max_admin
Description: Sets the maximum number of threads to use to sync with Microsoft System Center Configuration Manager (SCCM). A higher number of threads results in faster synchronization but slows down interactive performance. We recommend a range of 1 to 16, depending upon the number of CPU and amount of RAM on the server. At least 48G RAM is required for a value of 16.
Default Value: 2
Allowed Values: An integer from 1 - 32
Location: Admin Console
Security: Check iframe origin (check_iframe_origin)
Name: check_iframe_origin
Description: Determines whether the system requires that KB usage occurs only in an iframe, or an embedded web page, that has the same origin as the KB. If this global variable is set to No, any origin is allowed. If you are using a third-party or external API that displays information in the End User Interface, this variable should be set to Yes.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console
Security: Collect System Data on Error (collect_system_information_on_sod)
Name: collect_system_information_on_sod
Description: Determines whether to collect and include system information, such as the OS version and IP address, in the data that appears on the automatic bug report screen (SoD). Select Yes to collect and include this information.
Default Value: No
Recommended Values: For optimum security, the recommended value is No.
Location: Admin Console
Security: Days to continue support of old key (days_to_support_rc4_key)
Name: days_to_support_rc4_key
Description: Defines the number of days to continue to support old RC4 key based decryption for hotlinks that were generated before the RSA migration.
Default Value: 31
Allowed Values: integer
Location: Admin Console
Security: Default Password (default_password)
Name: default_password
Description: Specifies the default password provided on the login screen so that an administrator can login immediately after installing the product.
Default Value: blank
Location: Admin Console
Security: Disable CSRF_NONCE (disable_csrf_nonce)
Name: disable_csrf_nonce
Description: Determines whether CSRF_NONCE is disabled.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console
Security: Include Wildfly Logs to SoD (include_jboss_log_file_with_sod)
Name: include_jboss_log_file_with_sod
Description: Determines whether to include the Wildfly log files on the automatic bug report screen that appears if the system terminates unexpectedly ("Screen of Death" or "SOD"). If set to Yes, the Wildfly log files are included with the information sent to the ticket from the bug report screen. Note that these files may contain data about other KBs on the server, so this variable should be set to No on high security servers or servers with multiple KBs.
Default Value: Yes
Recommended Values: Wildfly log files may contain data about other KBs on the server, so this global variable should be set to No on high security servers or servers with multiple KBs.
Location: Admin Console
Security: Show KB Names (show_kb_names)
Name: show_kb_names
Description: Determines whether the generic login page shows a dropdown list of KB names. If set to No, the KB list on the /gui2 login page is hidden, and users need to manually enter the desired KB name.
Default Value: No
Recommended Values: For optimal security, this variable should generally be set to No.
Location: Admin Console
Security: Web domains where Agiloft can be embedded (check_iframe_origin_extra)
Name: check_iframe_origin_extra
Description: Lists the web domains where Agiloft is allowed to be embedded, such *.office365.com for the Agiloft Contract Assistant for Word.
Default Value: blank
Location: Admin Console
Server URL for Pendo (pendoserverroot)
Name: pendoserverroot
Description: The root URL used to form the Pendo Account ID. It defaults to the URL of the server domain name and is usually correct. It should only be necessary to edit this variable if DNS is misconfigured.
Default Value: URL for the server domain name
Location: Admin Console
Specify character(s) that will replace spaces in KB names while configuring SAML Identity Provider (custom_space_encoding_in_saml_sso)
Name: custom_space_encoding_in_saml_sso
Description: Defines a custom encoding character (or a sequence of characters) that is used during SAML IdP configuration for Assertion URL. Normally, there is no need to set this global variable if the SAML IdPs used by the KBs on your server support space encoding correctly. As an exception, ADFS2.0 and ADFS 3.0 have known issues supporting space encoding.
Default Value: __
Recommended Values: It is extremely important that you use an uncommon sequence of characters to provide the encoding. For example, you might use two consecutive underscores (__). To be absolutely certain, check that the sequence of characters you enter are not contained in any of the KB names hosted on this server.
Location: Admin Console
String Option Behavior (string_search_options)
Name: string_search_options
Description: Defines the behavior of strings entered in the Quick Search box. These are the possible choices:
- Reset after each search: Strings entered in the Quick Search box are reset after each search.
- Remember: Strings entered in the Quick Search box are remembered after a search.
- Forbid: Entering strings in the Quick Search box is forbidden.
Default Value: Reset after each search
Location: Admin Console
Tesseract instances max number (ocr_tesseract_max_instances)
Name: ocr_tesseract_max_instances
Description: Sets the maximum number of simultaneous Tesseract instances to prevent overloading server with OCR.
Default Value: 8
Allowed Values: An integer from 1 - 128
Location: Admin Console
Timeout: Avoid touching retriever within the range of the value of seconds at user inactivity (RetrieverTouchTimeout)
Name: RetrieverTouchTimeout
Description: Defines the frequency (in seconds) at which the system is able to call retriever.touch. This global variable only applies if the Try to keep retriever at memory global variable is set to Yes.
Default Value: 300
Allowed Values: integer
Location: Admin Console
Try to keep retriever at memory (KeepActiveRetrieverAtMemory)
Name: KeepActiveRetrieverAtMemory
Description: Determines whether the system avoids delays by keeping table view data in memory during periods of user inactivity. Select Yes to keep this data in memory during user inactivity. If you select Yes, the system uses the Timeout:Avoid touching retriever withing the range of the value of seconds at user inactivity global variable to determine how often the system can call retriever.touch.
Default Value: No
Allowed Values: Yes, No
Location: Admin Console
Usage Tracking Key (pendo_key)
Name: pendo_key
Description: A Pendo.io key for usage tracking integration.
Default Value: System set
Location: Admin Console
Workato Agiloft Manifest ID (workato_agiloft_manifest_id)
Name: workato_agiloft_manifest_id
Description: The ID of Agiloft manifest that will be dynamically exported and imported for each KB.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Agiloft package direct download link (workato_agiloft_package_link)
Name: workato_agiloft_package_link
Description: The public direct download URL for the Agiloft package that will be imported to each KB.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato callback URL for Agiloft OAuth 2.0 (workato_agiloft_oauth_callback_url)
Name: workato_agiloft_oauth_callback_url
Description: The Workato callback URL where Agiloft sends the OAuth 2.0 authorization code.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Embedded API base URL (workato_embedded_api_url)
Name: workato_embedded_api_url
Description: The base URL for the Workato Embedded API.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Embedded API token (workato_embedded_api_token)
Name: workato_embedded_api_token
Description: The token used to call the Workato Embedded API.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Embedded RSA private key file in PKCS8 format (workato_embedded_rsa_private_key_file)
Name: workato_embedded_rsa_private_key_file
Description: This RSA private key used to create Workato JWT tokens.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Embedded user email (workato_embedded_user_email)
Name: workato_embedded_user_email
Description:
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Embedded user token (workato_embedded_user_token)
Name: workato_embedded_user_token
Description: The email addressed used to the Workato Embedded API.
Default Value: blank
Allowed Values: text
Location: Admin Console
Workato Embedded Vendor API key (workato_embedded_vendor_api_key)
Name: workato_embedded_vendor_api_key
Description: The vendor API key used to create Workato JWT tokens.
Default Value: blank
Allowed Values: text
Location: Admin Console
Yes/No option for restart recipes while import (workato_restart_recipes_while_import)
Name: workato_restart_recipes_while_import
Description: Defines whether or not to restart running recipes during import.
Default Value: blank
Allowed Values: Yes, No
Location: Admin Console