Show TOC

Environment ParametersLocate this document in the navigation structure

Use

Environment parameters allow you to customize the settings that apply across an environment.

Prerequisites

You have Environment task security rights to view and change environment parameters.

Features

The parameters that require a value contain Required in the Type column. Parameters that do not require a value contain Optional in the Type column. If an environment parameter is required, you can leave it blank to accept the default, but if you delete the parameter, the system may not work correctly. If an environment parameter is optional, you can leave it blank or delete it.

The following table describes the parameters you can set:

Type

Key ID

Description

Optional

ALLOW_EXTENSIONS

The file extensions the system allows users to upload by. The default values are: .HTM, TXT, TMP, ESF, XLTM.

Optional

ALLOW_FILE_SIZE

The maximum file size the system permits users to upload. A warning message appears if the file size exceeds the parameter value when you upload a file.

The default value is 100 MB.

This parameter is used:

  • When posting documents in the Documents view

  • When sending data

System

ALLOW_SSO_HTTP

Allows single sign-on for HTTP.

Optional

APPROVALSTATUSMAIL

Defines whether owners and managers receive an e-mail when there is a change to an assigned work status.

Theis parameter has the following possible values:

  • Yes: Send e-mail

  • N/A: Do not send e-mail

The following SMTP environment parameters must be set up as well to use e-mail notifications in the system: SMTPAUTH, SMTPPASSWORD, SMTPPORT, SMTPSERVER, and SMTPUSER.

Optional

APPROVALSTATUSMSG

Allows you to define a custom e-mail message that is sent to the owners and managers of a work status when a work status code is changed. The message is applicable to all models in the environment.

You can customize the message using the following variables:

  • %USER% - ID of user who changed this status

  • %STA% - Work status

  • %OWNER% - Entity owner

  • %TIME% - Time of change

Example

You can create a message such as "This is to inform you that %USER% has updated the work status on %TIME%".

The text of the e-mail can be a maximum of 255 characters. There is no need for quotes or brackets around parameters.

Required

AVAILABLEFLAG

Controls whether the system is offline or not. Yes means the system is online and available for sending data to the database. You can take the system offline by changing the value to No.

This parameter is used in the EPM add-in for Microsoft Office - Save Data, DM Imports

Required

AVAILABLEMSG

The message that displays to users who try to access an environment that is offline ( AVAILABLEFLAG = No).

The default value is "Current Environment status is not available"

Example

The message could be "The system is temporarily unavailable due to scheduled maintenance. Try again later."

This parameter is used in the EPM add-in for Microsoft Office - Save Data, DM-Import.

Optional

BPFSTEP_COMPLETE_MSG

Determines the content of the message that is displayed when a Business Process Flow step is completed.

The default message is:

[%BPF_STEP_NAME%] step of [%BPF_NAME%] has been completed by %USER_NAME%.

This parameter is used in Administration Client - Manage Business Process Flows.

Optional

CLR_COMMENTS_HISTORY

Deletes all comment history and retains only the latest comment; used in Add Comments and View Comments. Historical comments are removed after applying the parameter.

Valid Values: 0 saves the historical comments; 1 deletes the historical comments and retains the latest comment only.

The default value is 0.

Optional

COMMENT_MAX_LENGTH

Supports the customized length of comments in Add Comments and View Comments. If you set a smaller value than the current value, newly input values do not conform to the eComments length and the previous value still applies, even though the setting has been successfully updated on the Environment Parameters page. Therefore, the new setting should be larger than the previous value.

The default value is 256. You can input integers between 256 and 4,000.

Optional

DEFAULT_EXTENSIONS

The system allows the default file type even if you do not set this parameter. The default file extensions are hard-coded internally.

The file extensions the system allows users to upload by default:

XLS, XLT, DOC, DOT, PPT, POT, XML, MHT, MHTML, HTM, HTML, XLSX, XLTX, XLSM, XLSB, ZIP, PDF, PPTX, PPTM, POTX, POTM, DOCX, DOCM, DOTX, DOTM, CDM, TDM, PNG, GIF, JPG, CSS, MRC.

See ALLOW_EXTENSIONS above.

Users can change the value.

This parameter is used in:

  • Posting documents in the Document view

  • Sending Data, DM-Import

Optional

JREPORTZOOM

This parameter allows you to set the default zoom magnification value on HTML journal reports.

We recommend that you set the value to 75%.

Required

MaxSystemReportQuerySize

Used for system reports. Specifies the maximum query size in cells (prior to zero compression) before the system asks the user to continue or cancel the query.

Required

MaxWebReportQuerySize

Used for Web reports. Specifies the maximum query size in cells (prior to zero compression) before the system asks the user to continue or cancel the query.

Required MEMBERSHEET_VERSION Determines whether you use the .xls Excel workbook type or .xlsx Excel workbook type for the dimension member sheet. The default value is 2007, which uses the .xlsx workbook type. You can change it to 2003 to use an Excel 2003 workbook. However, when you change it to 2003, you must run Export Dimension in the Administration client for all of the dimensions. When you change the value from 2003 to 2007, however, you do not have to run Export Dimension because the Administration client converts it automatically.

Optional

SESSIONTIME

Defines the session time (in minutes) for the Who's Online feature.

The default value is 3000 minutes.

Required

SMTPAUTH

The authentication method of the SMTP server.

This setting does not change the method on the SMTP server, but must match the type of authentication enabled on it. Failure to set this appropriately can result in errors from the e-mail server.

The default value is: 1.

Possible values for this parameter are:

  • 0 = Anonymous

  • 1 = Basic

  • 2 = NTLM

This parameter is used:

  • When posting documents, Work status, Alert

  • EPM add-in for Microsoft Office - Distribution

Optional

SMTPPASSWORD

The password for the user name defined as the SMTPUSER.

This parameter is Optional except when SMTPAUTH is "1" (basic), this parameter is Required

The default value is blank.

The user can enter the SMTP password.

This parameter is used:

  • When posting documents, Work status

  • EPM add-in for Microsoft Office - Distribution

Required

SMTPPORT

Port number for your SMTP e-mail server.

The default is port 25, the default SMTP server port number.

The user can enter the port number.

This parameter is used:

  • When posting documents, Work status

  • EPM add-in for Microsoft Office - Distribution

Required

SMTPSERVER

The name or TCP/IP address of the SMTP e-mail server the system uses to send e-mail.

The default value is blank.

The user can input the SMTP Server name or TCP/IP address.

This parameter is used:

  • When posting documents, Work status, Alert

  • EPM add-in for Microsoft Office - Distribution

Required

SMTPSSL

The parameter indicates whether SMTP is using Secure Sockets Layer (SSL) or not.

  • 1 = use SSL

  • 0 (default) = do not use SSL

Required

SMTPUSER

The user name from which e-mail from the system originates.

The default value is blank.

The user can input the User name.

This parameter is used:

  • When posting documents, Work status, Alert

  • EPM add-in for Microsoft Office - Distribution

Required

SYSTEM_LANGUAGE

This parameter indicates what language is used for system messages and logs.

All messages coming from the server are localized by the client's language, but there are two areas where messages and logs are written in the language of this parameter: logic logs and the Data Manager package log viewer.

Optional WS_CHECKNOOWNERDIM

Use this parameter to validate combinations of work status settings for all child members of the selected members, which are included in dimensions that have a work state set to "Yes" in order to see the possible statuses when changing work status.

To get the new status for the work status, when working from the bottom up, the system has to validate other combinations of the work status setting for all child members of the selected members of dimensions that have a work status set to "Yes". When, however, the dimensions have a large number of members, performance can be affected. Normally, the system deos not validate other combinations of work status settings of all child members and validates only the selected member. If you need to obtain the accurate status for selected members regardless of performance, set this parameter.

The value is not case-sensitive. When changing work status, if this parameter is not set, the system validates just the status of the selected member.

Valid values are:
  • [all] - Validate other combinations of work status settings for all child members that are included in dimensions that have a work state set to Yes.
  • Dimension name - Validate other combinations of work status settings for all child members of the dimensions that are inserted as values. If the system needs to validate multiple dimensions, separate them with a comma, such as "time,category".
Activities

To update the value of a parameter, start the Administration Client, and select the environment name at the top of the navigation pane, then select Start of the navigation path Additional Tasks Next navigation step Set Environment Parameters End of the navigation path. Modify the parameters, as desired, and then click Update.

To add a new parameter (you can add any 'optional' parameter if it is not already displayed), add a new row, enter the parameter name, then enter the desired value.