The following lists detail all of the global variables. For general information about how global variables work, refer to the Variables page.
Some global variables have been relocated to the Security wizard.
Power-User Specific Global Variables List
| Anchor | ||||
|---|---|---|---|---|
|
The following list contains all of the global variables that exist only in the Power-User Interface. To access global variables within the Power-User Interface, navigate to Setup > System > Manage Global Variables.
| Expando |
|---|
Name: field_visibility_in_views
Description: 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.
Type: Choice
Allowed Values: Yes, No
Units:
Default Value: Yes
| Expando |
|---|
...
Description: Defines whether charts shown on the dashboard should be forced to use JavaScript rendering, even if they were not configured to use JavaScript in their setup options. If this variable is set to Yes, the chart will still display charts still display on the dashboard in the non-interactive format if the "Use JavaScript Charts" option has not been selected in its Output format.
...
| Note |
|---|
This variable only affects the display of charts on the dashboard. Other outputs such as email distribution will display in the non-interactive format if they they have not been configured to use JavaScript charts. |
...
Description: Defines the time of day (in hours) in which background services are permitted to automatically perform table analysis. For example, a value of "23-04" means between 11pm 11 pm and 4am4 am. Note that this global variable works in conjunction with the Analyze Table Frequency and Analyze table start protection period of system inactivity 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.
...
Description: Used to integrate with a Centralized Authentication Server (CAS). Defines the URL to which the
| Companyname |
|---|
...
Description: Controls the frequency (in minutes) in which that the system checks for inbound emails.
...
Name: custom_saml_enc_key_cipher_transform
Description: SAML SSO Messages messages sent to
| Companyname |
|---|
| Companyname |
|---|
...
Location: Power-User Interface
| Expando |
|---|
Name: mail_smtp_custom_options
Description: Enter Java Mail additional SMTP Configuration Properties (see here) in Java property format (name=value). They are applied over
| Companyname |
|---|
Type: Text
Allowed Values: Any well-formed value
Units:
Default Value:
| Expando |
|---|
...
Note that if the system detects date strings that do not fit the specified format, it will automatically switch switches from day/month to month/day parsing as needed.
For more information about record importation or importing data or email parsing, refer to the following topics:
Default Value: DMY
...
Description: Determines whether the email marketing functionality is disabled. Select Yes to disable the functionality. For more information see: , see Email Marketing.
Default Value: No
...
Description: Determines whether
| Companyname |
|---|
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.
...
Description: Defines the maximum number of days that
| Companyname |
|---|
For more information about configuring the email SMTP server, see: see Configure the Email SMTP Server.
...
Description: Determines whether the system creates a Communication record even if an email fails to send due to the fact 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
| Companyname |
|---|
| Companyname |
|---|
...
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: Hyperlinks see Hyperlinks in 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.
...
Recommended Values: Set this variable to ‘Yes’ Yes to enable CWS if you need full-text searching over Chinese words.
...
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
...
Description: Determines whether Hotkeys (also called keyboard shortcuts) are enabled. Select No to disable Hotkeys. For more information about hotkeys, refer to the see Keyboard Shortcuts topic.
Default Value: Yes
Recommended Values:
...
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, refer to the see List of Data Types topic.
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.
...
Name: enduser_title
Description: Defines Defines the strings that appear 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:
...
Description: Defines the text that appears in the header to the left of the welcome message and to the right of the search box.
Default Value:
...
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: 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: 128
Recommended Values: It is recommended to have We recommend having hotlinks between 128 and 255 characters in length.
...
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 will attempt 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 about configuring the email SMTP server, see: see Configure the Email SMTP Server.
...
For more information about inbound emails, see: see Inbound Email Accounts.
Default Value: 50
...
Location: Power-User Interface
| Expando |
|---|
...
Iterative resolving variables and formulas in the email body
Name: keepiterative_slashemail_inbody_escapedformula_dollar_signresolver
Description: Determines whether the system keeps a backward slash (\) inserted into a print template before a dollar sign ($) after formula processing.
Normally when putting dollar signs into a print template to format values in a number field, the dollar sign will be eliminated, as it is expected to be part of a formula. One workaround is to put a backward slash (\) in front of the dollar sign. This will retain the $ sign in the output of the template (but remove the slash). This variable, if set to Yes, will not remove the slash from the output. The result:
...
Value
...
Result
...
No
...
\$25,000 - result: $25,000
...
Yes
...
\$25,000 - result: \$25,000
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 ValueDefault value: No
Recommended Values:
Location: Power-User Interface Interface
| Expando |
|---|
...
Keep slash prior escaped dollar sign
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
Name: ldap_read_timeout
Description: Changes the timeout for running queries via Active Directory; for example if the LDAP Filter uses a complex search that runs over the 10 second default timeout restriction.
Allowed Values: Any integer
keep_slash_in_escaped_dollar_sign
Description: Determines whether the system keeps a backward slash (\) inserted into a print 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: NoDefault Value: 10 seconds
Recommended Values:
Location: Power-User InterfaceInterface
| Expando |
|---|
...
Layouts in EUI
Name: LoginURL eui_layout
Description: Determines the location to which the system directs users when they are logged out automatically from
| Companyname |
|---|
This URL can be overridden by parameters in a custom login block or hyperlink. For more information see:
- How do Users Access the System? -about creating custom login blocks.
- Hyperlinks-about 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
| Expando |
|---|
Name: max_size_of_email_attachments_in_kbytes
Description: Defines the maximum size of attachments (in kilobytes) that
| Companyname |
|---|
Default Value: 7500
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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.
Allowed Values: Any integer
Default Value: 10 seconds
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
Name: LoginURL
Description: Determines the location to which the system directs users when they are logged out automatically from
| Companyname |
|---|
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
| Expando |
|---|
Name: max_size_of_email_attachments_in_kbytes
Description: Defines the maximum size of attachments (in kilobytes) that
| Companyname |
|---|
Default Value: 7500
Recommended Values: There are two things to consider if configuring this global variable: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 will not successfully cannot successfully send if its overall size (body and attachments) exceeds the limits set by your SMTP.
- Allowing
to send very large files can lead to slower performance.Companyname
...
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 will not successfully cannot successfully send if its overall size (body and attachments) exceeds the limits set by your SMTP.
- Allowing
to send very large emails can lead to slower performance.Companyname
Location: Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
...
Description: Defines the maximum number of large files attached to a record that the system can fulltext full-text index. Once this limit is reached, fulltext full-text indexing stops for all remaining large files. For fulltext 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.
...
Description: Defines the maximum archive size (in kilobytes) that the system can extract files from for fulltext full-text indexing.
Default Value: 200
...
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 x kilobytes of the file will be indexed are indexed with a "strings" extracting algorithm (like "strings" unix utility).
Default Value: 102410240
Recommended Values: Dangerous if too high.
...
Name: ocr_threads_max_number
Description: If OCR is performed on many documents are OCR'd 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.
...
Location: Power-User Interface
| Expando |
|---|
...
Open PDF in Browser
Name: restrict open_standardpdf_login_for_sso_usersin_browser
Description: Determines whether to restrict standard login/password-based access to those users who have been authenticated by SSOPDFs are opened in the browser. If set to Yes, PDFs are opened in a new browser tab. If set to No, PDFs are downloaded to the user's desktop and then opened, unless otherwise configured in the browser settings.
Default Value: YesNo
Recommended Values:
Location: Power-User Interface Interface
| Expando |
|---|
...
Power User Title
Name: saml_req_enc_digest_algostaff_title
Description: Defines the text that appears as the title in the browser tab when logged in to the Power-User Interface.
Defines the encryption algorithm for SAML Authentication requests. Typically SHA1 or SHA256.
Default Value:
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
...
SAML Request secure Hash Algorithm
Name: ssoendpoint saml_req_enc_digest_algo
Description: This global variable is used to allow the ability to use an encrypted email hotlink to connect to a custom web SSO application. It stores the URL for the custom web SSO application. When this variable has a value, hotlinks included in emails do not include the login/password for authentication, but rather redirect to the defined authentication server to allow the user to be authenticated and logged inDefines the encryption algorithm for SAML Authentication requests. Typically SHA1 or SHA256.
Default Value:
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
...
Set Creation Date on Record Saving
Name: allowed_referers creation_date_on_save
Description: Defines a comma separated list of host names that are allowed as referrers to your server. A value of “*” allows any host name to act as referrers to this server.
Default Value: *
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
Name: hotlink_master_password
Description: Defines the master password used for checking cookies for those users who selected to save login credentials for generated hotlinks.
Default Value:
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
Recommended Values: For most situations, the default value of the variable should be changed.Recommended Values:
Location: Power-User Interface
| Expando |
|---|
...
Name: inbounds_process_strange_replaysName: print_template_allow_scripts
Description: Determines whether Javacript scripts are allowed in Print Templatesinbound accounts process replies sent from other tables. Select Yes to allow scriptsenable processing replies from other tables. This may result in inbound accounts processing strange replies.
Default Value: No
Recommended Values:
Location: Power-User Interface Interface
| Expando |
|---|
...
Show action buttons at the bottom of the record
Name: widgets_allow_script show_action_buttons_bottom_row
Description: Determines whether the system allows scripting in widgets on the home page. Select No to disable scripting and help protect users from malicious attacks (XSS, XSRF, etc). This ensures that only safe HTML is allowed. If set to Yes, then the action buttons like Save, Edit, and Cancel are also visible at the bottom of form.
Default Value: No
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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: YesNo
Recommended Values:value: Due to the potential impact, we recommend that you do not remove these characters.
Location: Power-User Interface
...
Interface
| Expando |
|---|
...
Style preference for paragraphs in Printed Document
Name: ResetPasswordErrorMessage printtemplatestylepreference
Description: Defines the custom message that appears when an error occurs during password reset if the Security:Informative Password Messages global variable set to Yes.
Default Value:
Recommended Values: Either leave this variable unset or use a message that does not provide any security information. For example "Invalid login/password combination, please contact your administrator"
Location: Power-User Interface
...
| Expando |
|---|
...
Name: informative_password_messages
Description: Defines whether diagnostic messages in password-related functions can contain the account name. Additionally, if set to Yes, you can use the Security:Custom message for "Reset Password" error global variable to define a custom error message.
Default Value: No
Recommendation: For optimal security, this variable should generally be set to No.
Location: Power-User Interface
| Expando |
|---|
Name: trusted_zones
Description: Specifies a comma or CR character-separated list of addresses for net resources (such as hyperlinks, images, embedded objects, etc) from which HTML code in the system is allowed to refer. You can use this to help protect user data from malicious attacks such as XSS or XSRF attacks.
Example Values:
...
Value
...
Behavior
...
*.agiloft.com, /
...
Users can refer to agiloft.com domain, its subdomains and the server host, without defining its name.
...
*, /
...
Users can refer to any domain in the net and the server host.
...
/
...
References to net resources are disabled.
...
NULL
...
Only references to the current host are enabled (e.g. /home.jsp).
...
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
Name: async_rule_transaction_timeout
Description: Rules run in the background will time out if working for more than X seconds.
Default Value: 14400
Recommended Values:
Default Value: / *
Recommended Values: For optimal security, this global variable should generally be set to /, *.YOUR_COMPANY.COM.
Location: Power-User Interface
| Expando |
|---|
...
Timeout: Table Search Time
Name: creation table_datesearch_on_savetimeout
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 SLA, 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
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
Recommended Values:Recommended Values: For most situations, the default value of the variable should be changed.
Location: Power-User Interface
| Expando |
|---|
...
Timeout: Wait to Run Rule In Background
Name: inbounds async_rule_processrun_strangewait_replaystimeout
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 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: No500
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
...
Treat message/rfc822 email parts as attachments
Name: show attach_action_buttons_bottom_rowDescription: 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 bodyIf set to Yes, then the action buttons like Save, Edit, Cancel are also visible at the bottom of form.
Default Value: No
Recommended Values:
Location: Power-User InterfaceInterface
| Expando |
|---|
...
Update already generated Email hotlinks when accessed by user(s)
Name: staff_title updateEmailHotlinks
Description: Defines the text that appears as the title in the browser tab when logged in to the Power-User (Staff) interface.
Default Value:
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.Recommended Values:
Location: Power-User Interface
| Expando |
|---|
...
Use AltChunk while running a Print Action
Name: strip_non_printable_characters applyAltChunkAutoNum
Description: Determines whether the system removes all non-printable characters from all text fields. Select Yes to remove these charactersprocesses HTML fields as altchunks in Microsoft Word while running a Print action.
If you select Yes, this could have an impact when using hidden tags in html fields for processing.
Default Value: No
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 policyRecommended value: Due to the potential impact, we recommend that you do not remove these characters.
Location: Power-User Interface
| Expando |
|---|
...
Use loginless user during email processing
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), while preserving bold, italic, and underlines. Here is the same template with the variable set this way - note that the bold and underlining are retained, but color and other font formatting is lost:
use_login_less_users_in_email_processing
Description: If a user who does not have an
| Companyname |
|---|
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 Inbound Email Accounts.
Default Value: NoDefault Value: printtemplate
Recommended Values:
Location: Power-User Interface Interface
| Expando |
|---|
...
Use sub-selects rather than temp tables
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 the Direct File Edit page.
Default Value: 1440
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
Name: record_update_timeout
Description: Defines the maximum amount of time (in seconds) that can be spent on record creation/update at the server. If an update takes longer than the specified amount of time, the transaction fails and is rolled back.
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
| Expando |
|---|
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
| Companyname |
|---|
Default Value:Default Value: 600
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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.
Multi-Level Global Variables List
| Anchor | ||||
|---|---|---|---|---|
|
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 within the Admin Console, navigate to General > Variables. To access global variables within the Power-User Interface, navigate to Setup > System > Manage Global Variables.
Note that unless otherwise indicated, the value defined within the Power-User Interface for any given global variable in a specific KB takes precedence over the value defined for that variable within the Admin Console. On the other hand, if a variable is not set in a particular KB, then the value defined in the Admin Console takes effect. This allows you to set server-wide behavior while also maintaining flexibility for each KB.
| Expando |
|---|
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: YesDefault Value: No
Recommended Values:
Location: Power Admin Console, Power-User Interface Interface
| Expando |
|---|
...
BeyondTrust Host Names or IP Addresses
Name: Hosts_Allowed_To_Send_Bomgar_Events
Description: Defines a comma separated list of BeyondTrust Host Names or IP Addresses that are authorized to send Session events to your
| Companyname |
|---|
| Companyname |
|---|
For more information, see Bomgar Remote Support Integration
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 will change for users after email hotlinks are generated, set this global variable to Yes.
Location: Power Admin Console, Power-User Interface
| Expando |
|---|
...
Cancel URL
Name: applyAltChunkAutoNum cancelurl
Description: Determines whether the system processes HTML fields as altchunks in Microsoft Word while running a Print Action. 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 EmailsIf 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 in 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
| Expando |
|---|
Name: use_login_less_users_in_email_processing
Description: If a user who does not have an
| Companyname |
|---|
Default Value: No
Recommended Values:
Location: Power-User Interface
| Expando |
|---|
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.
Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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 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.
and the Use sub-selects rather than temp tables global variables must be set to Yes.
Default Value: One Step
Recommended Values:
Location: Admin Console, PowerLocation: Power-User Interface
| Expando |
|---|
...
Embedded Search Results Size
Name: web Embedded_trackingSearch_entryResults_point_urlSize
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
| Companyname |
|---|
Default Value: 1000Default Value:
Recommended Values:
Location: Power Admin Console, Power-User Interface
Multi-Level Global Variables List
...
Interface
| Expando |
|---|
Name: errorurl
Description: Determines the location to which the system directs users if they encounter an error while attempting to log in to
| Companyname |
|---|
Default Value:
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: exiturl
Description: Determines the location to which the system directs users when they:
- Click the Log Out link to log out of
.Companyname - Click Finish or Close after editing or viewing a record through a hyperlink. For information, see Hyperlinks in Emails.
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
| Expando |
|---|
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 1000 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.
...
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 within the Admin Console, navigate to General > Variables. To access global variables within the Power-User Interface, navigate to Setup > System > Manage Global Variables.
Note that unless otherwise indicated, the value defined within the Power-User Interface for any given global variable in a specific KB takes precedence over the value defined for that variable within the Admin Console. On the other hand, if a variable is not set in a particular KB, then the value defined in the Admin Console takes effect. This allows you to set server-wide behavior while also maintaining flexibility for each KB.
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: Hosts_Allowed_To_Send_Bomgar_Events
Description: Defines a comma separated list of Bomgar Host Names or IP Addresses that are authorized to send Session events to your
| Companyname |
|---|
| Companyname |
|---|
For more information, see Bomgar Remote Support Integration.
Default Value:
Recommended Values:
Location: Admin Admin Console, Power Power-User Interface
| Expando |
|---|
...
FTS Response Time
Name: cancelurl averageftsresponsetimelimit
Description: Defines the default URL that appears after users cancel out of a record if they logged in through a hotlink. Note that, 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:
Determines the number of seconds that
| Companyname |
|---|
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 lage FTS-indexed tables.Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
...
Hotlink Server Root URL
Name: timezone_label_display hotlinkServerRoot
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
Recommended Values:
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.
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, Location: Admin Console, Power-User Interface
| Expando |
|---|
...
LF Auto Display Type Limit
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 very 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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
LF Auto Display Type 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 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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: lf_propagation_delay
Description: Specifies the delay (in milliseconds) before asynchronous propagation of linked source fields gets triggered.
Default Value: 1000
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: default_contact_fields_samlconfig
Description: Defines, in a comma separated list, the field names from the Contact table (or any subtables) that are available for a user 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.Recommended Values:
Location: Admin Console, Power-User Interface Interface
| Expando |
|---|
...
Location of external Perl directory
Name: errorurl externalperllocation
Description: Determines the location to which the system directs users if they encounter an error while attempting to log in to
| Companyname |
|---|
Default Value:
Recommended Values:
Location: Admin Console, Power-User InterfaceInterface
| Expando |
|---|
...
Location of external Python directory
Name: exiturl externalpythonlocation
Description: Determines the location to which the system directs users when they:
- Click the Log Out link to log out of
.Companyname - Click Finish or Close after editing or viewing a record through a hyperlink. For information, see Hyperlinks in Emails.
This URL can be overridden by parameters in the custom login block or hyperlink. For more information, see:
- How do Users Access the System?: This discusses creating custom login blocks.
- Hyperlinks: This discusses creating and using custom hyperlinks.
Default Value: /login.jsp
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:
Recommended Values: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
| Expando |
|---|
...
Manual License Request URL
Name: fixerioaccesskey manual_license_request_url
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 1000 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.
Defines the URL to which users are forwarded once they request a license.
Default Value: http://www.agiloft.com/license.htmDefault Value:
Recommended Values:
Location:Admin Admin Console, PowerPower-User InterfaceInterface
| Expando |
|---|
...
Max Rule Records Limit
Name: averageftsresponsetimelimit rules_rec_limit
Description: Determines Defines the maximum number of seconds that
| Companyname |
|---|
Default Value: 2100000
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 lage FTS-indexed tables.
Location: Admin Console, Power-User InterfaceInterface
| Expando |
|---|
...
Max Rule Records Warning
Name: hotlinkServerRoot rules_warn_limit
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.
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
| Expando |
|---|
Name: LF Auto Display Type Limit
Description: Specifies the limit for the number of linked source field records that will be displayed as a list when the display type is Auto; when exceeded, an input box with lookup is used instead of a list. For more information, see the Display topic of the Linked Fields Wizard page.
Default Value: 100
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: lf_list_limit
Description: Specifies the limit for the number of linked source field records that will be 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 topic of the Linked Fields Wizard page.
Default Value: 200
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: lf_propagation_delay
Description: Specifies the delay (in milliseconds) before asynchronous propagation of linked source fields gets triggered.
Default Value: 1000
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: default_contact_fields_samlconfig
Description: Defines, in a comma separated list, the field names from the Contact table (or any subtables) that are available for a user 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
| Expando |
|---|
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:
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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:
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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 will only run on the first 100,000.
Default Value: 100000
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: max_column_length_per_row
Description:
Default Value: 128
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: max_text_field_size_in_db
Description: Defines the maximum number of characters
| Companyname |
|---|
Default Value: 16777216
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: UseIndex
Description: This global variables controls whether the
| Companyname |
|---|
| Companyname |
|---|
| Companyname |
|---|
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
| Expando |
|---|
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.
Note that this global variable is for MySQL only.
Default Value: No
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: product_name
Description: Defines the name used for branding. Any value you enter in this global variable will replace “Agiloft” anywhere that it is hardcoded 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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: shortproductname
Description: Defines a short name used for branding. Any value you enter in this global variable will replace “EW” 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: EW
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
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 will run 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
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: Allowable_Redirection_Hosts
Description: Defines the host URLs to which the system allows redirects. This helps guard against XLS attacks. Multiple hosts may be specified, delimited by spaces, comma or semi-colons.
To allow any host enter a value of *.
Default Value: *
Recommended Values: This global variable should generally be set to a value such as *.YOUR_COMPANY_NAME.COM, *.SERVER_URL.COM. For example, *.widget.com, *.widget.enterprisewizard.com *.widget.agiloft.com.
Note that this global variable restricts what values will work as ExitURLs. If you use hotlinks that specify ExitURLs, add them to the list of values entered here.
Location: Admin Console, Power-User Interface
...
If a rule matches with more records than the number defined in this global variable, a warning appears.
Default Value: 100000
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: max_column_length_per_row
Description:
Default Value: 128
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
Name: max_text_field_size_in_db
Description: Defines the maximum number of characters
| Companyname |
|---|
Default Value: 16777216
Recommended Values:
...
| Expando |
|---|
...
Name: require_matching_cookie_and_seance
Description: Determines whether the system requires that the session ID matches the cookie associated with it. If you select Yes and the session ID does not match the cookie associated to that session when the user first logged in, the connection is rejected. This guards against a hacker who can see the user's browser from manually entering the URL.
Default Value: No
Recommended Values: For optimal security, this global variable should be set to All_Users. Note that some browser settings or firewalls may prevent cookies from being used. In that case, you can either set this global variable to No and enable the Security:Check client IP global variable or, if your Admin or Power Users are not affect by the issue, you can enter a value such as Admin_Users or Staff_Users for more security.
Location: Admin Console, Power-User Interface
...
| Expando |
|---|
...
Name: require_ip_check
Description: Determines whether the system checks that all requests are made from the same IP address as the IP address used when the session first started. This helps prevent a hacker who can see the URL/session ID on your PC from initiating a session on another machine.
Note that this feature causes the user to be logged out if they access the system from an ISP or through a gateway that assigns a dynamically changing IP address.
Additionally, this method is not as secure as using Security:Check Session Match because if both PC's are accessing the server through the same NAT or Proxy servers, their IP addresses will seem to be the same.
Default Value: No
Recommended Values: This variable should generally be set to No because stronger security is available using the Security:Check Session Match global variable. This option provides for those rare installations that block the use of cookies and, therefore, the use of the Security:Check Session Match global variable.
Location: Admin Console, Power-User Interface
...
| Expando |
|---|
Name: UseIndex
Description: This global variables controls whether the
| Companyname |
|---|
| Companyname |
|---|
| Companyname |
|---|
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
...
| Expando |
|---|
...
Name: rest_ip_blacklist
Description: Defines a comma separated blacklist of IP addresses. Any IP address defined in this global variable is unable to access the system via the REST interface. You may enter IPv4, IPv6, and IP address ranges. For example, 10.168.6.102, 10.169.7.132-10.169.7.150
Note that server-wide settings take precedence over specific KB settings.
Default Value:
Recommended Values: If values are set for the Security:REST IP Whitelist global variable, it is generally not necessary to set values for Security:REST IP Blacklist. However, Security:REST IP Blacklist is useful if you allow API access from a constantly changing set of IP addresses that do not live within well-defined ranges but want to block access from other ranges, such as those of foreign countries.
Location: Admin Console, Power-User Interface
...
Interface
| Expando |
|---|
...
Prefer fat, rather than thin indexes
Name: rest_ip_whitelist
Description: Defines a comma separated whitelist of IP addresses. The system allows any IP address defined in this global variable to access the system via the REST interface. If a whitelist is defined, all other IP's are automatically blocked. You may enter IPv4, IPv6, and IP address ranges. For example, 10.168.6.102, 10.169.7.132-10.169.7.150.
Note that KB specific settings take precedence over server-wide settings.
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.
Note that this global variable is for MySQL only.
Default Value: No
Recommended Values:Recommended Values: For optimal security, set this global variable to the value of the machines from which your REST scripts are running. You may also enter 127.0.0.1 to block external access entirely.
Location: Admin Console, Power-User InterfaceInterface
| Expando |
|---|
...
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
Recommended Values:
Name: soap_ip_blacklist
Description: Defines a comma separated blacklist of IP addresses. Any IP address defined in this global variable is unable to access the system via the SOAP interface. You may enter IPv4, IPv6, and IP address ranges. For example, 10.168.6.102, 10.169.7.132-10.169.7.150
Note that server-wide settings take precedence over specific KB settings.
Recommended Values: If values are set for the Security:SOAP IP Whitelist global variable, it is generally not necessary to set values for Security:SOAP IP Blacklist. However, Security:SOAP IP Blacklist is useful if you allow API access from a constantly changing set of IP addresses that do not live within well-defined ranges but want to block access from other ranges, such as those of foreign countries.
Location: Admin Console, Power-User Interface
...
| Expando |
|---|
...
Product Short Name
Name: soap_ip_whitelist
Description: Defines a comma separated whitelist of IP addresses. The system allows any IP addresses defined in this global variable to access the system via the SOAP interface. If a whitelist is defined, all other IP addresses are automatically blocked. You may enter IPv4, IPv6, and IP address ranges. For example, 10.168.6.102, 10.169.7.132-10.169.7.150.
Note that KB specific settings take precedence over server-wide settings.
Recommendation: For optimal security, set this global variable to the value of the machines from which your SOAP scripts are running. You may also enter 127.0.0.1 to block external access entirely.
shortproductname
Description: Defines a short name used for branding. Any value you enter in this global variable replaces “EW” 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: EW
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
...
Product website
Name: show_stack_trace_button_on_sod product_site
Description: Determines whether the stack trace button appears on the SoD screen. Select No to prevent users from seeing the stack trace informationDefines 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: Noagiloft.com
Recommended Values: For added security, this global variable should generally be set to No.
Location: Admin Console, Power-User Interface
| Expando |
|---|
...
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
Name: ws_anti_sql_injection
Description: Determines whether anti SQL injection features are enabled. Select No to disable these features.
Default Value: Yes15
Recommended Values:
Location: Admin Console, Power-User Interface
| Expando |
|---|
...
Revindex Optimization Period
Name: ws_verbose_error_messagesDescription: Determines whether SOAP and REST calls produce verbose error messages for debugging purposes. Select Yes to enable these verbose error messages 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: No22-05
Recommended Values: Keep set to No in production environments.
Location: Admin Console, Power-User InterfaceInterface
| Expando |
|---|
...
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
...
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
...
Description: Defines the amount of time (in minutes) that users can be idle before they are automatically disconnected.
Default Value: 390
Recommended Values:
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
...
Name: lock_expiration_time
Description: Defines Defines the amount of time (in minutes) after which an edit lock on a record expires.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 changesWhen a record is opened by a user, it is locked to prevent simultaneous or conflicting edits. If it is not closed or saved by the user, the system automatically unlocks the record after the amount of time specified in this global variable.
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 rulesthe 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
...
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 mins minutes that their record lock expires in 10 minutes (i.e. 60 mins amounting to 60 minutes total of editing). A value of 0 provides no warning to users.
...
Description: Defines the number of minutes warning that a user is given before automatically being 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 mins minutes and are disconnected in another 10 mins (i.e. 30 mins minutes (amounting to 30 minutes total of inactivity). A value of 0 provides no warning to users.
...
Location: Admin Console, Power-User Interface
Admin Console-
...
Specific Global Variables
The following list contains all of the global variables that exist only in the Admin Console. Due to their potential to cause performance issues on a shared server, these Admin Console-specific global variables are only available for customers installed on dedicated or on-premise servers. To access global variables within the Admin Console, navigate to General > Variables.customers installed on dedicated or on-premise servers. To access global variables within the Admin Console, navigate to General > Variables.
| Expando |
|---|
Name: allow_admin_kb_export_run
Description: Determines whether KB admins can run a KB export. If set to No, admins no longer have access to the Agiloft option on the Data Format tab of the Export wizard.
Default Value: Yes
Recommended Values:
Location: Admin Console
| Expando |
|---|
...
Description: Defines the number of seconds of inactivity that the system waits before beginning automatic table analysis. Note that this 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.
...
Description: Determines whether only those KBs in which someone has logged in within the past 24 hours are backed up. For more information see: , see Backup a Knowledgebase.
Default Value: No
...
Description: Defines the URL to which users are redirected to submit a support ticket when they encounter a bug within the
| Companyname |
|---|
...
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
| Expando |
|---|
Name: check_iframe_origin
Description: Disables
| Companyname |
|---|
| Companyname |
|---|
Default Value: No
Recommended Values:
Location: Admin Console
| Expando |
|---|
...
Description: Protects sensitive Agiloft tables (like All Communications, Contacts, etc) from deletion. If set to Yes, then an admin can delete these integral tablessuch as All Communications, People, and others) from deletion. If set to Yes, then an admin can delete these integral tables.
Default Value: No
Recommended Values: This global variable is for development purposes only. Do not activate it.
Location: Admin Console
| Expando |
|---|
Name: lf_propagation_threads
Description: Optimizes linked field processing by allowing multiple propagation threads.
Default Value: 2
Recommended Values:
Location: Admin Console
| Expando |
|---|
Name: max_disconnect_timeout
Description: Defines the maximum allowed value 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: No390 minutes
Recommended Values: This global variable is for development purposes only. Do not activate it.
Location: Admin Console
| Expando |
|---|
...
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.
...
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 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.
...
Recommended Values:
Location: Admin Console
| Expando |
|---|
...
Maximum number of temporary tables.
Name: max_number_of_temptables
...
Because Agiloft starts one dedicated revindex execution thread per KB, you can use this global variable to tune performance on servers that host multiple KnowledgeBasesknowledgebases.
Default Value: CPU number + 1
...
Name: check_iframe_origin
Description: Determines whether the system requires that KB usage occurs only in an iframe of a page , 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 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
Recommended Values:
...
Recommended Values: For optimum security, the recommended value is No.
Location: Admin Console
| Expando |
|---|
...
Name: days_to_support_rc4_key
Description: Defines the number of days to continue the support of old keys.
Default
...
Recommended Values:
Location: Admin Console
| Expando |
|---|
Name: default_password
...
Default Value: __
Recommended Values: Note that it 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 any of the KB names hosted on this server.
...
Default Value: Reset after each search
Recommended Values:
Location: Admin Console
| Expando |
|---|
Name: ocr_tesseract_max_instances
Description: Sets the maximum number of simultaneous Tesseract instances to prevent overloading server with OCR.
Default Value: 8
Recommended Values:
Location: Admin Console
| Anchor | ||||
|---|---|---|---|---|
|
| Expando |
|---|
...
within the range of the value of seconds at user inactivity
Name: RetrieverTouchTimeout
...