Appendix A: The Server Configuration File
During installation, you may want to make configuration changes that determine the behavior of Longview Data Server. Typically, you configure your Data Server using Longview Server Manager; however, because you have not yet installed Longview client components, you must use the manual configuration file provided by Longview.
Note: You may need to revisit the manual configuration file during implementation or during regular system maintenance.
For information on recommended configuration settings, see Updating the Longview Data Server configuration file.
To configure your Longview Data Server:
-
Navigate to your server machine Data Server working directory. For example,
E:\Longview\DataServers\LongviewDEV.
- Copy the existing lvsrvr.cfg file and save it with a new name.
- Open the lvsrvr.cfg file in your preferred text editor.
Caution: Incorrectly modifying some parameters may result in not being able to start your server or may prevent features from functioning. Use with caution.
- Review the parameters.
General server parameters
Parameter | Value |
---|---|
SERVER_TYPE |
This parameter is populated by the server installer and specifies the type of server selected during installation.
|
SERVER_NAME |
This parameter is populated by the server installer and specifies the name of the Data Server (Longview System ID or LID). |
WORK_DIRECTORY |
This parameter is populated by the server installer and specifies the location in which the servers are started, and in which the Data Server Log file (lv_dataserver.log) is saved. This path must be enclosed in double quotation marks. The default path is "C:\Longview\DataServers\LID" where LID is the Longview Identifier for the system. |
Application Logic Switches
Parameter | Value |
---|---|
ACCOUNTING_NDD |
Specify whether to use N-Dimensional Distribution.
The default value for this parameter is FALSE. |
ACCOUNTING_PAC |
Specify whether to use Period Activity Calculation (PAC) logic.
The default value for this parameter is FALSE. |
ACCOUNTING_REC |
Specify whether to use Retained Earnings Calculation (REC) logic.
The default value for this parameter is FALSE. |
ACCOUNTING_TRN |
Specify whether to use data translation.
The default value for this parameter is FALSE. |
ACCOUNTING_YTD |
Specify whether to use accounting year-to-date (YTD) logic.
The default value for this parameter is FALSE. |
DO_ELIMINATIONS |
Specify whether to use the Elimination Server.
The default value for this parameter is FALSE. |
USE_DATA_CACHE |
Specify whether to use this feature.
The default value for this parameter is FALSE. |
USE_AGENT_DATA_CACHE |
Specify whether to store the data cache for agents and web agents in RAM.
The default value for this parameter is FALSE. |
USE_JOURNAL_ENTRIES |
Specify whether to use the Journal Entry Server.
If the value of DO_ELIMINATIONS is TRUE, the value for this parameter must also be TRUE. The default value for this parameter is FALSE. |
USE_MODEL |
Specify whether to use server model rules.
The default value for this parameter is TRUE. |
USE_QUERY_RULES |
Specify whether to use query rules.
The default value for this parameter is TRUE. |
USE_ROLLUP_RULES |
Specify whether to use Rollup rules.
The default value for this parameter is TRUE. |
USE_VALIDATION |
Specify whether to use validation rules.
The default value for this parameter is TRUE. |
USE_TRN_ROUNDING |
Specify whether to use translation rounding.
The default value for this parameter is FALSE. |
USE_RDBMS_TEMPTABLES |
This parameter applies to systems with Oracle databases only. Specify whether the system uses Oracle Global Temporary temp tables.
The default value for this parameter is FALSE. |
USE_GRID_PROCESSING |
Specify whether to use grid processing when running restatements.
The default value for this parameter is FALSE. |
GRID_PROCESSING_TYPE |
If USE_GRID_SERVER is TRUE, specify the type of grid processing to use.
The default value for this parameter is LVGRID |
USE_FILE_ATTACHMENT |
Specifies whether to enable file attachments for Data Grids.
The default value for this parameter is TRUE. Note: This must be set to TRUE if using the HTML5 Dashboard Designer. |
USE_MEMORY_CACHE |
Specify whether to enable caching data in memory if the MemoryCacheSizes.txt file is present in the location specified by the MEMORY_CACHE_LOCATION parameter. Note: Longview recommends caching data in memory only as part of a full-system performance strategy. Review Caching data in memory in the Longview Server Manager Guide before implementing this feature.
The default value for this parameter is FALSE. |
USE_FLOWS |
Specify whether the FLOWS dimension is in use in the system.
The default value for this parameter is FALSE. |
USE_WORKFLOW |
Specify whether to enable Longview Workflow.
The default value for this parameter is FALSE. |
USE_JE_WORKFLOW |
Specify whether users receive emails notifying them of journal entry activity.
The default value for this parameter is FALSE. |
USE_EVENT_RULES |
Specify whether to enable Event-based rules in the system.
The default value for this parameter is TRUE. |
DELTA_MATH_LOGIC |
Specify whether the system uses deltas when processing math logic to eliminate rounding errors caused by using the delta values for math processing.
The default value for this parameter is TRUE. |
ROLLUP_RULES_METHOD |
Specify the rollup rule method, in conjunction with the USE_ROLLUP_RULES parameter.
The default value for this parameter is EXCLUSION. |
USE_SESSION_LOCKS |
Specifies whether to use session-based locking for Application Framework.
The default value for this parameter is TRUE. |
USE_DATA_AUDIT_TRAIL |
Specify whether Data Audit Trail is enabled in this system. Data Audit Trail is used to query the database for records of what values in the database have been changed and by which users and to export those records to a text file. For more information, see the Longview Application Administrator Guide.
If you are installing Longview Tax, set this parameter to TRUE. The default value for this parameter is FALSE. |
USE_DATA_AREA_MONITORING |
Specify whether to track and store batch and event activity for a given data area.
The default value for this parameter is FALSE |
USE_METADATA_AUDIT_TRAIL |
Specify whether Metadata Audit Trail is enabled in this system. Metadata Audit Trail captures metadata changes in the system, such as user and group maintenance, symbol maintenance and attribute maintenance. The changes are stored in the LV_AUDIT_METADATA table. This table can grow, and it is recommended that this table is archived occasionally.
The default value for this parameter is FALSE. |
USE_DATA_EVENT_SEQUENCING |
Specify whether to use sequencing for events. If you use data event sequencing, the DEFAULT_ACTIONS_TIME_INTERVAL parameter is ignored.
The default value for this parameter is FALSE |
General System Parameters
Parameter | Value |
---|---|
DATABASE_DBO |
This parameter is populated by the server installer and specifies the name of the DBO of the Data Server database. |
DATABASE_PWD |
This parameter is populated by the server installer and specifies the password for the DBO of the Data Server database. |
DATABASE_HOST |
This parameter is populated by the server installer and specifies the host name. Host names can be a maximum length of 23 characters. |
DATABASE_SERVER |
Identifies the name of the server on which the database is hosted. The maximum length for this parameter is 253 characters. If this parameter is not set, the default is "localhost". |
DATABASE_PORT |
Specify the port through which the Longview Data Server connects to the database. This parameter applies to PostgreSQL environments only. If this parameter is not set, the default value is 5432. |
DATABASE_NAME |
Specify the name of the database for PostgreSQL environments. By default, this value is blank and must be updated to specify the target PostgreSQL database. |
LISTENER_PORT |
This parameter is populated by the server installer and specifies the port number used by the Listener (client port). |
WEB_LISTENER_PORT |
Specify the port through which the Longview web application connects to the database. The default value for this parameter is one less than the value of the port used by the Server Administrator. |
GRID_LISTENER_PORT |
Specify the GRID_LISTENER_PORT number when the Grid processing type is LVGRID. |
WEB_AGENT_PROTOCOL |
Specifies protocol used between the web server and the web agent:
The default value for this parameter is IPC. |
SMTP_SERVER |
If you are using email notification, specify the name of the SMTP server. |
COMPRESS_WEB_CONTENT |
Specify whether to use gzip standard compression whenever applicable.
The default value for this parameter is TRUE. |
USE_THIRD-PARTY_AUTH |
Specifies whether to enable third-party web authentication.
The default value for this parameter is FALSE. Note: Users select Single Sign-On (Web) when signing on. |
THIRD-PARTY_HTTP_VARIABLE |
Specify the HTTP variable used for third-party web authentication (valid only if USE_THIRDPARTY_AUTH is set to TRUE). The default value for this parameter is LONGVIEW_SSO_USER. |
GRID_SERVICE_NAME |
Specify the name for the grid service when the Grid-processing type is DATASYNAPSE |
WRITER_ASYNC_IO |
Specify whether to enable asynchronous IO for your grid environment when the value of WRITER_SERVER_RAM is a positive integer.
The default value for this parameter is TRUE. |
APPLICATION_SERVER |
Specify the host name or address of the Data Server that the Longview Smart Client or Longview Tax should connect to. The GetSessionInfo web action returns this parameter to the Longview Smart Client or to Longview Tax. The maximum length for this parameter is 253 characters. |
WEB_SERVER |
Specify the host name or address of the Web Server that the Longview Smart Client or Longview Tax should connect to. The maximum length for this parameter is 253 characters. |
CLIENT_HTTP_PROXY |
Specify the secure listener port URL (HttpProxyServerListenerPortURL) for your HTTP Proxy Server. For example, https://srvr1201sql01:8080/listenerportproxy/. If you specify a value for this parameter, connections between Longview Application Framework, Longview Apps, and Longview Tax can use a secure HTTP proxy connection. For information on installing the HTTP Proxy Server, see Installing Longview HTTP Proxy Server. |
ADMIN_HTTP_PROXY |
Specify the secure admin port URL (HttpProxyServerAdminPortURL) for your HTTP Proxy Server. For example, "https://srvr1201sql01:8080/adminportproxy/". |
LOCAL_ADMIN_GROUP |
Specify the name of a Windows local group to use to stop and start the Longview Servers. If the group name contains a space, it must be enclosed in double quotes. Note: Local Admin Group will not work with a Windows default local group. |
ALTERNATE_SYSTEM_LANGUAGE |
Specifies the alternate language to use in your system.
The default value for this parameter is FR. |
SSO_SERVICE_URL |
Specify the url to the Longview SSO Web Service. The url will either be setup for saml or openid. For example:
|
File Location
Parameter | Value |
---|---|
DOCUMENTATION_LOCATION |
Specify the location of the documentation folder. This path must be enclosed in double quotation marks. The default value for this parameter is "C:\Longview\DataServers\LID\docs" where LID is the Longview Identifier for the system. |
HELPFILE_LOCATION |
Specify the location of the help files folder. This path must be enclosed in double quotation marks. The default value for this parameter is "C:\Longview\DataServers\LID\helpfiles" where LID is the Longview Identifier for the system. |
JAVA_FILENAME |
Specifies the name of the zip file containing the Java JDK. Note: The file must exist in the Longview Data Server\software folder in zip file format. Example: "openjdk-16_windows-x64_bin.zip" |
TEMPORARY_FILES |
Specify the location in which all temporary files are saved. This path must be enclosed in double quotation marks. The recalculation uses this folder to create files that are needed for submissions, dynamic rollups, and calculations. Once the process completes successfully, these files are deleted. The default value for this parameter is "C:\Longview\DataServers\LID\tmp" where LID is the Longview Identifier for the system. |
WEB_SERVER_BRIDGE |
Specify the path for the cgi or dll file serving as the communication bridge between the web server and Longview Data Server. This path must be relative to the document root configured for the web server and must be enclosed in double quotation marks. This value is used when resolving the WEBBRIDGE token in web content delivered to a user. Therefore, if it is not specified correctly, your web application will not work correctly. The default value for this parameter is "/cgibin/LID/lvweb.cgi" where LID is the Longview Identifier for the system. |
WEB_SIGNOFF_PAGE |
Specify the default sign off page when the user connects through the web interface. If this parameter does not start with http://, the Sign on window appears again. The default value for this parameter is lvwebsignon.ksp. |
APPLICATION |
Specify the location of the Application Framework binaries used for data events and model/procedure links. This path must be enclosed in double quotation marks. The default value for this parameter is "C:\Longview\DataServers\LID\lvaf" where LID is the Longview Identifier for the system. |
EVENTS_LOG_FILES_LOCATION |
Specify the location where log files generated for Events are stored. This path must be enclosed in double quotation marks. If you do not specify a value for this parameter, the Events tool does not display the Log Files column, which provides users with links to open log files. |
EVENTS_ERROR_FILES_LOCATION |
Specify the location where error files generated for Events are stored. This path must be enclosed in double quotation marks. If you do not specify a value for this parameter, the Events tool does not display the Error Files column, which provides users with links to open error files. |
EVENTS_HISTORY_FILES_LOCATION |
Specify the location where history files generated for Events are stored. This path must be enclosed in double quotation marks. If you do not specify a value for this parameter, the Events tool does not display the History Files column, which provides users with links to open history files. |
PASSWORD_DICTIONARY_LOCATION |
This parameter applies only if PASSWORD_COMPLEXITY is set to TRUE. Specify the location where the dictionary files are stored. This path must be enclosed in double quotation marks. Dictionary files are text files that contain strings of characters that cannot be used in passwords if PASSWORD_COMPLEXITY is set to TRUE. Examples of strings commonly not allowed in passwords include “abc”, “password”, or your company name. If you do not specify a value for this parameter, passwords are not restricted by the strings in the dictionary files. The following rules apply to dictionary files:
Dictionary files adhere to the following naming convention: password_dictionary_FileName.txt Note: File extensions other than .txt can be used. For example, password_dictionary_LVWords.dct is a valid dictionary file name. |
MEMORY_CACHE_LOCATION |
This parameter applies only when USE_MEMORY_CACHE is set to TRUE. Specify the location of the Memory Cache folder containing the memory block files for caching data in memory. The default value for this parameter is the Data Server working directory, such as "C:\Longview\DataServers\LID" where LID is the Longview Identifier for the system. Note: The location must be a path local to the server machine; do not specify a network drive. |
METADATA_AUDITTRAIL_LOGFILES_LOCATION |
This parameter applies only when USE_METADATA_AUDIT_TRAIL is set to TRUE. Specify the location where log files generated for Metadata Audit Reset operations are stored. If you do not specify a value for this parameter, a log file will not be generated when a Metadata Audit Reset operation is performed. |
FILES_CUSTOM_ROOT_PATH |
This parameter specifies the location of where custom code files will be stored. For example: web, templates and applications) Note: This parameter is required to be set on new installs. |
System Maximums
Parameter | Value |
---|---|
ELIM_QUEUE_MAX |
Specify the maximum number of entries in the Elimination queue. This number can range from 32 to 100000000. If you have a high volume of submissions, you’ll need to make the value large enough to handle the backlog, although you need to remember that each leaf table can be handled by only one Submission Server at a time. The default value for this parameter is 500. |
MATH_QUEUE_MAX |
Specify the maximum number of entries in the Math queue. This number can range from 32 to 100000000. The value for MATH_QUEUE_MAX does not change with changes in the MATH_POOL value. For example, if you specify 500 for MATH_QUEUE_MAX, then regardless of the number of Math Servers running (MATH_POOL), there will be one queue with a maximum of 500 entries. If the queue becomes full, the 501st job returns an error. Use the following factors to calculate the optimum size of the math queue:
If you have a high volume of submissions, you’ll need to make the value large enough to handle the backlog, although you need to remember that each leaf table can only be handled by one Submission Server at a time. The default value for this parameter is 10000. |
MAX_DATA_LOCKS |
Specify the maximum number of data locks allowed in the database. This number can range from 100 to 100000000. The default value for this parameter is 500. |
MAX_MATH_ITERATIONS |
Specify the maximum number of math iterations. This number can range from 100 to 100000000. The default value for this parameter is 500. |
MAX_SCHEDULE_LOCKS |
Specify the maximum number of Schedule locks. This number can range from 100 to 100000000. The default value for this parameter is 100. |
MAX_SCHEDULES |
Specify the maximum number of Schedules allowed. This number can range from 1 to 5000. The default value for this parameter is 100. |
MAX_HOMEPAGE_LOCKS |
Specify the maximum number of home page locks. This number can range from 1 to 1024. The default value for this parameter is 1024. |
MAX_WEBPANELS_LOCKS |
Specify the maximum number of web panel locks. This number can range from 1 to 4096. The default value for this parameter is 1024. |
MAX_SESSIONS |
Specify the maximum number of sessions allowed at one time. This number can range from 8 to 100000000. The default value for this parameter is 2000. |
SUBMISSION_QUEUE_MAX |
Specify the maximum number of entries in the Submission queue. This number can range from 32 to 100000000. If you have a high volume of submissions, you will need to make this value large enough to handle the backlog, considering that each leaf table can be handled by only one Submission Server at a time. The default value for this parameter is 500. |
WRITER_QUEUE_MAX |
Specify the maximum number of entries in the Writer queue. This number can range from 32 to 100000000. If you have a high volume of submissions, you will need to make this value large enough to handle the volume of jobs. The recalculation also uses the writer queue, so this number should consider the volume required by the recalculation. The default value for this parameter is 50000. |
EVENT_QUEUE_MAX |
Specify the size of the queue to be used by the Model Server in processing Event messages. This number can range from 32 to 100000000. The default value for this parameter is 5000. |
GRID_CURSORS_MAX |
Specify the maximum number of grid cursors. This number can range from 1 to 12. The default value for this parameter is 4. |
GRID_OUTPUT_MAX_THREADS |
Specify the maximum number of grid output threads. This number can range from 1 to 80. The default value for this parameter is 5. |
MAX_FILE_ATTACHMENT_SIZE |
This parameter applies only if USE_FILE_ATTACHMENT is set to TRUE. Specify the maximum file size, in megabytes, for file attachments. This number can range from 5 to 25. If this setting is greater than the maxAllowedContentLength attribute in your IIS web.config file, the IIS setting is used. The default value for this parameter is 20. |
MAX_PERSISTENT_EVENTRULES |
Specify the maximum number of event rules that can be set as persistent. This number can range from 0 to 999. For more information on persistent event rules, see the Longview Application Administrator Guide. Note: Setting event rules as persistent increases memory consumption on the data server. If you do not want to use this feature, set this parameter to 0. The default value for this parameter is 999. |
MAX_DATA_EVENT_ITERATION_TIME |
Specify the maximum time, in the format mm:ss, that the Management Server will wait for the current iteration to complete before starting the next iteration. The minimum value allowed for this parameter is 00:01 and the maximum is 1440 minutes (one day). The default value for this parameter is 2:00. |
DATA_CACHE_COMPRESSSION_LEVEL |
Specify the compression level to use when generating data cache files. This number can range from 1 to 9; where 1 corresponds to the best speed and 9 corresponds to the best compression. The default value for this parameter is 6. |
Query Tuning
Parameter | Value |
---|---|
DATA_FETCH_SIZE |
Specify the fetch size for datalink queries. This number can range from 1000 to 32000. A larger fetch size results in a better compression rate, and therefore better datalink performance, especially over slow networks. However, more memory is consumed by agents during large datalinks. The default value for this parameter is 32000. |
STRING_DATA_FETCH_SIZE |
Specify the maximum size of string data that can be returned in a query. This number can range from 1000 to 16000. The default value for this parameter is 2500. |
RANGE_CONVERSION_LIMIT |
Specify the number of dimensions to which range conversion logic applies.
Range conversion logic is used to optimize the SQL statements generated when querying data from the database. The logic considers converting one dimension's query constraint to a parameter and repeatedly re-executing the statement with different parameter values, as this can be more efficient than a BETWEEN clause, which can sometimes return extra data that needs to be discarded. This parameter determines the maximum number of dimensions to consider (in index order) for the use of range conversion logic. The default value for this parameter is 0. |
RANGE_CONVERSION_MAX |
Specify the maximum number of symbols (from 1 to 32000) to allow when considering the use of range conversion logic for a dimension. Range conversion logic is used to optimize the SQL statements generated when querying data from the database. The logic considers converting one dimension's query constraint to a parameter and repeatedly re-executing the statement with different parameter values, as this can be more efficient than a BETWEEN clause, which can sometimes return extra data that needs to be discarded. This parameter determines the maximum number of symbols to allow in a dimension being considered for range conversion (and therefore the maximum number of re-executions of the statement). The default value for this parameter is 32000. |
IN_CLAUSE_MAX |
Specify the maximum number of symbols (from 1 to 32000) to allow when considering the use of an IN clause for a dimension. Range conversion logic is used to optimize the SQL statements generated when querying data from the database. The logic considers converting one dimension's query constraint to an IN clause explicitly listing the individual symbols requested, as this can be more efficient than a BETWEEN clause, which can sometimes return extra data that needs to be discarded. This parameter determines the maximum number of symbols to allow in an IN clause. The default value for this parameter is 10. |
GATHER_ORACLE_STATISTICS |
This parameter applies only to Oracle systems. Specify whether Oracle database statistics are gathered automatically on the temporary tables after they are created.
The default value for this parameter is FALSE. |
MAX_QUERY_RULE_DATA |
Specify the maximum number of Query Rule Records allowed in a single query. This number can range from 0 to 1000000000. The value 0 specifies that an unlimited number of Query Rule Records are allowed. The default value for this parameter is 0. |
Submission Tuning
Parameter | Value |
---|---|
WRITER_BATCH_SIZE |
Specify the batch size. This number can range from 500 to 1000000000. When the value of WRITER_BATCH_SIZE is reached, the writer transfers data from the temp table to the destination table. The higher this value, the better the throughput of the writer. However, there may be a penalty in the size of database temp space, rollback, and so on. The default value for this parameter is 50000. |
WRITER_HASH_VALUE |
Specify the number of jobs in which to divide a Writer job destined for one table, so that multiple writers can work on them concurrently. This number can range from 1 to 256. It is faster to have many processes updating one table in parallel than to have just one process update the table with all records sequentially. The default value for this parameter is 1. |
TEMP_BATCH_SIZE |
Specify the batch size when inserting records into temporary tables during submissions. This number can range from 200 to 1000000000. The higher this value, the better the throughput. However, there may be a penalty in terms of the amount of memory required. The default value for this parameter is 500. |
Restatement/Import/Export Parameters
Parameter | Value |
---|---|
COMPRESS_TEMP_FILES |
Specify whether to compress temp files.
The default value for this parameter is TRUE. |
EXTERNAL_LOAD |
Specify whether a partition recalculation, restatement, or import should expect an external load to occur (for example, piped loading during a recalculation).
The default value for this parameter is FALSE. |
JE_RECALC_FETCH_SIZE |
Specify the fetch size used by the Journal Entry Server during journal entry recalculations. This number can range from 1000 to 128000. A larger fetch size results in faster recalculations but consumes more memory. The default value for this parameter is 25000. |
MAX_EXPORT_FILE_SIZE |
Specify the maximum size of any export file in kilobytes. This number can range from 1024 to 2097151. The default value for this parameter is 2097151. |
RECALC_FILE_DELIMITER |
This parameter applies only if RECALC_FILE_TYPE is set to DELIMITEDASCII. Specify the character used as a delimiter in the ASCII file created during a partition recalculation.
The default value for this parameter is {. |
RECALC_FILE_TYPE |
Specifies the type of output file a partition recalculation creates.
The default value for this parameter is BINARY. |
RECALC_FILES |
Identifies the location where all files created during a restatement or a recalculation are saved. This folder also contains the export files created when you export server data. When you import server data from another environment, the export files used for the import should be saved to this folder. For more information on exporting and importing server data, see the Longview Server Manager Guide. This path must be enclosed in double quotation marks. If you are using a tiered system (the application server and database server are on separate host machines) with SQL Server, you must set this parameter to the following network share value: "\\AppServer\ShareName\Path", where
For more information on tiered systems, see “Preparing for a tiered system”. The default value for this parameter is "C:\Longview\DataServers\LID\recalc" where LID is the Longview Identifier for the system. |
RECALC_HASH_DIMENSION |
Specify the dimension to be used to split up the leaf records into smaller jobs (hashing).
Sometimes this choice results in unbalanced performance, which can be detected by noting the last message from each Math Server during a recalculation or restatement. If some Math Servers complete long before others, the jobs are not balanced. If so, select a dimension in which the data is evenly distributed. Avoid specifying dimensions with single symbols that contain large percentages of data. The default value for this parameter is AUTO. |
RECALC_HASH_VALUE |
Specify the number of jobs in a group, using hashing logic. If this value is greater than 1, the system subdivides Math Server jobs during a partition recalculation. This number can range from 1 to 256. For example, if this value is specified as 5, the recalculation divides the number of rows in the leaf tables into 5 sections to do the rollup, contributing to performance gains. Increase this value to create more jobs with each containing fewer records and to help balance the Math Servers, as described in RECALC_HASH_DIMENSION. You may have to test this value when running your restatement to find the optimal value. The default value for this parameter is 32. |
System Policies
Parameter | Value |
---|---|
AGENT_IDLE_TIMEOUT |
Specify the time-out period (the number of minutes to wait if the agent is inactive, before releasing the agent). This number can range from 1 to 1440. This parameter applies to Longview Application Framework as well as Longview Tax and Longview Smart Client. The default value for this parameter is 120. |
WEB_IDLE_TIMEOUT |
Specifies the time-out period (the number of minutes to wait if the web agent is inactive, before releasing the web agent). This number can range from 1 to 1440. This parameter applies to Longview Dashboard sessions. The default value for this parameter is 120. |
WEB_IDLE_TIMEOUT_WARNING |
Specify the number of minutes before timeout to send a warning to the user. This number can range from 2 to 1440. This value must be less than the value set for WEB_IDLE_TIMEOUT. The default value for this parameter is 10. |
LISTENER_ASSIGNMENT_TIMEOUT |
Specify the number of seconds that listener server will wait for an agent/web agent to accept a RCP connect request. If timeout occurs, listener will try the next agent/web agent to accept the request. This number can range from 0 to 120. If this parameter is set to 0, it will wait for agent/web agent's reply infinitely. The default value for this parameter is 30. |
WEB_VIEWACTION_TIMEOUT |
Specify the number of minutes that a web request can run before it is terminated. This number can range from 0 to 1440. If this parameter is set to 0, web requests can run for an unlimited amount of time. The default value for this parameter is 0. |
CLIENT_KEEPALIVE_TIME |
Specify the number of minutes a client socket waits after data is last sent before sending a TCP keepalive packet to the data server to verify that the connection is still available. This number can range from 0 to 1440. If this parameter is set to 0, client sockets do not send TCP keepalive packets. Currently, this parameter applies to the following client components with or without using Longview HTTP Proxy:
The default value for this parameter is 0. |
DOCUMENTATION_DEPLOYMENT |
Specify where, or if, documentation is deployed.
The default value for this parameter is CLIENT. |
HELPFILE_DEPLOYMENT |
Specify where, or if, help files are deployed.
The default value for this parameter is CLIENT |
LV_IDENTIFIER_POLICY |
Specify whether the system should enforce that the Client LID matches the Server LID specified during installation.
The default value for this parameter is ENFORCE |
ON_ERROR |
Specify how system responds to a data submission error.
The default value for this parameter is WARNING |
SERVER_TIMEOUT |
Specify the time-out period (number of minutes to wait for a response before timing out on server start up or shut down). This number can range from 1 to 120. The default value for this parameter is 2. |
PASSWORD_COMPLEXITY |
Specify whether the system enforces password complexity.
Regardless of the setting for PASSWORD_COMPLEXITY, passwords cannot contain any of the following characters — double quotation marks ( " ), pipes ( | ), dollar sign ($), square brackets ( [ ), ( ] ) or spaces ( ). The default value for this parameter is TRUE. If this parameter is set to TRUE, a password must meet all the following restrictions:
For example, the password for user ‘Jean-Paul’ cannot contain the strings ‘jean’ or ‘paul’ but can contain ‘pau’.
|
PASSWORD_MINIMUM_LENGTH |
Specify the minimum length for passwords, in number of characters. This number can range from 1 to 63. Note: If you set PASSWORD_COMPLEXITY to TRUE, avoid setting this parameter to a value of 3 or less. Since password complexity restrictions require that passwords must contain at least one character from four different categories, passwords that are three or less characters in length will not be permitted. The default value for this parameter is 8. |
PASSWORD_EXPIRY |
Specify the number of days until a password expires. This number can range from 1 to 10000. The default value for this parameter is 30. |
PASSWORD_EXPIRY_WARNING |
Specify the number of days before the value set in PASSWORD_EXPIRY to send a password expiry warning. This number can range from 1 to 10000. For example, if PASSWORD_EXPIRY is set to 30, and PASSWORD_EXPIRY_WARNING is set to 5, a password expiry warning is sent to the user on the twenty-fifth day (five days before the value set in PASSWORD_EXPIRY). The default value for this parameter is 5. |
PASSWORD_FORCECHANGE |
Specify whether to enforce password changes.
The default value for this parameter is TRUE. |
PASSWORD_DAYS_BEFORE_REUSE |
Specify the number of days, after a password is set or reset, until it can be reused. This number can range from 0 to 3650. A password cannot be reused until both the number of days set by this parameter and the number of changes set in PASSWORD_CHANGES_BEFORE_REUSE have been exceeded. The default value for this parameter is 1. |
PASSWORD_CHANGES_BEFORE_REUSE |
Specify the number of password changes that must occur before a password can be reused. This number can range from 0 to 1000. A password cannot be reused until both the number of days set in PASSWORD_DAYS_BEFORE_REUSE and the number of changes has been exceeded. The default value for this parameter is 1. |
PASSWORD_FAIL_ATTEMPTS |
Specify the number of times a user can enter an incorrect password before they are locked out of the system. This number can range from 0 to 100. The default value for this parameter is 3. |
ACCOUNT_LOCK_TIME |
Specifies the time interval, in minutes, between when an account is locked (due to repeated failed password attempts, exceeding the number set in PASSWORD_FAIL_ATTEMPTS), and when the account is unlocked. This number can range 0 to 1440. If this parameter is set to 0, the account is locked until the administrator resets the password. The default value for this parameter is 10. |
ENABLE_PASSWORD_RESET |
Specifies whether users can reset their passwords from the Longview Dashboard web Sign On dialog.
The default value for this parameter is FALSE. Note: For users to reset their passwords from the web Sign On dialog, they must have a unique email address as specified in their user settings. For more information, see the Longview Application Administrator Guide or the Longview Tax Administrator’s Guide. |
PASSWORD_RESET_EMAIL_ADDRESS |
This parameter applies only if ENABLE_PASSWORD_RESET is set to TRUE. Specify the email address that the password reset link is sent from when users reset their passwords from the web Sign On dialog. This parameter must be enclosed in double quotation marks. |
PASSWORD_RESET_EMAIL_DESCRIPTION |
This parameter applies only if ENABLE_PASSWORD_RESET is set to TRUE. Specify a description for the email address that the password reset link is sent from when users reset their passwords from the web Sign On dialog. This parameter must be enclosed in double quotation marks. |
PASSWORD_RESET_TIME_LIMIT |
This parameter applies only if ENABLE_PASSWORD_RESET is set to TRUE. Specifies the time, in minutes, before the password reset link expires. The password reset link is provided when users reset their password from the web Sign On dialog. This number can range from 0 to 1440. The default value for this parameter is 60. |
WEB_IP_SECURITY |
Specify whether to validate a web session ID against the user’s IP address for each web action. If you are using Longview HTTP Proxy Server, or any other proxy server, you must set this value to FALSE.
The default value for this parameter is FALSE. |
WEB_COOKIE_SECURITY |
Specify whether cookies are used to pass the web session ID and its key information. When this parameter is set to TRUE, the user’s browser must allow cookies.
The default value for this parameter is TRUE. |
TICKET_SECURITY |
Specify whether Ticket Security is enabled. Ticket Security refers to using a single-use ticket when launching Longview components via URL links.
The default value for this parameter is FALSE. Note: If this parameter is set to TRUE:
If you are using out-of-box functionality, no other changes are required. However, if you have custom links in the Analytic homepage or legacy Dashboard which launch Longview components, then these links must be updated to work with the new feature. For more information, contact Longview Support Services. |
TICKET_TIMEOUT |
Specify the number of minutes that a ticket is valid when launching Longview components via URL links. This number can range from 2 to 10. The default value for this parameter is 2. |
WEB_HTTPS |
Specify whether Secure and HttpOnly attributes are added to the cookie header. When this parameter is set to TRUE, the Web Server uses Secure Sockets Layer (SSL).
The default value for this parameter is TRUE. The WEB_COOKIE_SECURITY and WEB_HTTPS parameters behave together in the following ways:
|
DEFAULT_ACTIONS_TIME_INTERVAL |
This parameter applies only if USE_DATA_EVENT_SEQUENCING is FALSE. Specify the minimum amount of time that must pass before the same Event action may be triggered again. The format for this value is mm:ss, where mm is the number of minutes, and ss is the number of seconds. The seconds value is optional. The minimum value for this parameter is 0 minutes, and the maximum is a combined value of 1440 minutes (one day). The default value for this parameter is 0:05. |
DATABASE_RECONNECT_TIMEOUT |
This parameter applies to SQL servers only. This parameter, set in minutes, causes the server to check the connection each time it attempts to communicate with the database, and to reconnect if necessary. This number can range from 0 to 60. If the connection fails during a SQL operation, a regular error message is returned, and the submission does not complete. The server tries to reconnect in the next operation. Reconnection attempts occur every five seconds for the duration of the time period (in minutes) defined by this parameter. The default value for this parameter is 10. |
DATABASE_INITIATION_TIMEOUT |
Specify, in minutes, the amount of time during which the server attempts to connect to the database if the first attempt to connect failed. This number can range from 0 to 60. The server attempts to reconnect every five seconds until the value set is exceeded. The default value for this parameter is 10. |
DATA_AREA_MONITORING_DIMENSIONS |
This parameter applies only if USE_DATA_AREA_MONITORING is set to TRUE. Specify the dimensions for which to enable data area monitoring. Separate multiple dimensions with a comma. Spaces are not supported. For example, Accounts,Entities,TimePer. |
DATA_AREA_STATUS_DIMENSION |
This parameter applies only if USE_DATA_AREA_MONITORING is set to TRUE. Specify the dimension for which to enable data area status tracking. The dimension must be included in those specified for DATA_AREA_MONITORING_DIMENSIONS. For example, Entities. If you do not specify a dimension for this parameter, data area status is not tracked. |
USE_HTML5_DASHBOARD |
Specify whether the HTML dashboard is used.
The default for this parameter is TRUE. |
AUTO_ARCHIVE_LOG_SIZE |
Specify the size in MB the lv_dataserver.log file can reach before it gets auto archived. The range is 0 to 400 MB. When set to 0 the lv_dataserver.log will not auto archive. The default value is 50 MB. |
Diagnostics
Parameter | Value |
---|---|
ENABLE_WEB_TRACE |
Specify whether to enable web trace, using one of the following options:
The default value for this parameter is FALSE. |
WEB_TRACE_FILE_LOCATION |
Specifies the path to where the trace file is stored, which must be on the web server. The trace file contains data that may help in debugging web connection problems. For more information, consult Support Services at Longview. This field is valid only when ENABLE_WEB_TRACE is set to TRUE. Specify the full path name of the output trace file. This path must be enclosed in double quotation marks. The default location |
DIAGNOSTIC_SERVICE_TRACKING |
Specify whether to include diagnostic service tracking information in the Longview Data Server Log (lv_dataserver.log).
The default value for this parameter is FALSE. |
DIAGNOSTIC_SERVICE_DETAIL |
Specify whether to include diagnostic service detail information in the Longview Data Server Log (lv_dataserver.log).
The default value for this parameter is FALSE. |
DIAGNOSTIC_SERVICE_LOGGING |
Specify whether to track and log service activity information.
The default value for this parameter is FALSE. |
DIAGNOSTIC_QUERY_STATISTICS |
Specify whether to include query statistic information in the Longview Data Server Log (lv_dataserver.log).
The default value for this parameter is FALSE. |
DIAGNOSTIC_QUERY_LOGGING |
Specify whether to log query information.
The default value for this parameter is FALSE. |
DIAGNOSTIC_RDBMS_LOGGING |
Specify whether to track and log RDBMS information.
The default value for this parameter is FALSE. |
DIAGNOSTIC_EVENT_PROFILING |
Specify whether to output event profiling for diagnostic purposes. If this parameter is set to TRUE, profiling for each event is enabled and output to two files:
Specify one of the following:
The default value for this parameter is FALSE. |
Partitioning
Parameter | Value |
---|---|
PARTITION_PARENT |
This parameter applies only to partitioned systems. Specify whether the data tables are partitioned for parent data.
The default value for this parameter is FALSE. |
PARTITION_LEAF_CALCULATED |
This parameter applies only to partitioned systems. Specify whether the data tables are partitioned for leaf and calculated data.
The default value for this parameter is FALSE. |
Memory Configuration
Parameter | Value |
---|---|
DATA_CACHE_RAM |
Specify the amount of RAM (in KB) reserved in the KSA for data cache files. This value can range from 1024 to 100000000. Increase this value to allocate more memory to this cache. Memory is allocated only if the value of USE_DATA_CACHE is TRUE. The size of this cache affects performance of queries when using data cache files. The default value for this parameter is 102400. |
HIER_SERVER_RAM |
Specify the amount of RAM (in KB) reserved in the KSA for the Management Server. This number can range from 1024 to 1245184. This parameter depends on the number of symbols and parent/child relationships. To identify the minimum amount, see the Longview Data Server Log (lv_dataserver.log) after the Management Server has started. It must be higher than the minimum amount required, or the servers will not start. It should also be high enough to allow for expected growth in the size of the hierarchy; however, setting this value excessively high is not an effective use of memory. This value does not affect performance. The default value for this parameter is 10240. |
MATH_NDD_RAM |
This parameter applies only if ACCOUNTING_NDD is set to TRUE. Specify the amount of RAM (in KB) reserved in the KSA for N-Dimensional Distribution (NDD). This parameter can range from 1024 to 2048000. This parameter depends on the number of symbols configured for NDD. The default value for this parameter is 1024. |
MATH_SERVER_RAM |
Specify the maximum amount of RAM (in KB) to be used by each Math Server in the Math Server pool. This value can range from 1024 to 2097151. The optimal value suggested by Longview is 262144. Once the Math Server pool reaches that memory for a job, it transfers the data to the writer pool. Leave enough memory available for operating system overhead and the RDBMS (if it resides on the same machine). To calculate the total possible memory consumption during a restatement or recalculation, multiply this number by the MATH_POOL value. To speed up math operations (rollup, accounting, restatement, and model), you can increase this value to increase the overlap percentage, resulting in fewer redundant writes to the database tables. Increasing this value also helps to reduce temporary disk space usage. However, you will need to ensure that your system has enough memory to support the value you specify. The default value for this parameter is 102400. |
MATH_TRN_RAM |
This parameter applies only if ACCOUNTING_TRN is set to TRUE. Specify the amount of RAM (in KB) reserved in the KSA for translation logic. This value can range from 1024 to 1024000 and depends on the number of different translation rates used. The default value for this parameter is 10240. |
MODEL_SERVER_RAM |
This parameter applies only if USE_MODELS is set to TRUE. Specify the amount of RAM (in KB) reserved in the KSA for the Model Server. This value can range from 1024 to 102400 and depends on the number and complexity of server rules. The default value for this parameter is 10240. |
WRITER_SERVER_RAM |
This parameter applies only if WRITER_ASYNC_IO is set to TRUE. Specify the amount of RAM (in KB) reserved for the writers. This value can range from 102400 to 2097151. The default value for this parameter is 102400. |
Scaling
Note: Scaling is not currently supported.
Parameter | Value |
---|---|
CONTROLLER_HOST |
Enter the name of the controller host. |
CONTROLLER_PORT |
Enter the port used by the controller. |
CONTROLLER_URL |
Enter the URL of the controller. |
USE_ENGINES_RECALCMATH |
Specify whether this controller is used for math recalculation jobs.
The default for this parameter is FALSE. |
USE_ENGINES_EVENTS |
Specify whether this controller is used for eventprocessing.
The default for this parameter is FALSE. |
Pooling
Parameter | Value |
---|---|
AGENT_POOL |
Specify the number of agents required to handle client connections from the Longview components. This value can range from 0 to 250. If you specify a value of 0 (in other words, a dedicated server) the system uses one agent for each connection, rather than using a pool of agents. The default value for this parameter is 10. |
WEB_AGENT_POOL |
Specify the number of web agent workers to handle client connections from Longview Dashboard. This value can range from 0 to 250. The default value for this parameter is 10. |
JE_WORKERS |
This parameter applies only if USE_JOURNAL_ENTRIES is set to TRUE. Specify the number of workers in the journal entry (JE) pool. This value can range from 1 to 100. If the journal entry portion of a recalculation or restatement runs too slowly, you can increase this value to attempt to improve performance. The default value for this parameter is 1. |
MATH_POOL |
Specify the number of Math Servers required to handle math logic. This number can range from 1 to 100000 and indicates the number of CPUs on the server machine. Longview suggests that you set this value to the total number of CPUs on the server machine for optimal performance. The recalculation or restatement attempts to take full advantage of all available math Servers in the pool. If the math portion of a recalculation or restatement runs too slowly, increase this value. Remember, however, that increasing this number beyond the numbers of CPUs in your system will have less impact and may even slow it down. The default value for this parameter is 1. |
SUBMISSION_POOL |
Specify the number of Submission Servers required to handle data submissions. This number can range from 1 to 100000. The default value for this parameter is 2. |
WRITER_POOL |
Specify the number of Writer Servers required to handle data written to database. This value can range from 1 to 100000. You can increase this value if your system is partitioned at the leaf level. The recalculation takes full advantage of all available writers in the pool. The writers are responsible for merging and sorting temporary files created by the Math Server, then loading the result into a data table. You can set this parameter to a value as large as possible without causing disk bottlenecks on the server machine. In practice, many data tables may be small, with only a few large ones. In this case, the recalculation will likely not benefit from a WRITER_POOL value larger than the number of large data tables (since these are the loads likely to take the longest, any additional writers will be idle). Increasing this parameter causes more concurrent table loads to occur during a recalculation or restatement. Increase this value to keep as many disks and controllers as possible utilized. The default value for this parameter is 2. |
MAX_ACTIVE_DATA_EVENTS |
Specify the maximum number of active data events to allow in an event sequence iteration. This number can range from 0 to 999. The default value for this parameter is 999. |