Property Information

JConsole is the Java Monitoring and Management Console used to define and manage the various properties for Financial Reporting and the applications that run with it, across multiple servers. The JConsole executable (Jconsole.exe) is located in the bin directory of the Java Development kit (JDK) — <install dir>/jdk. When you select Attributes on the MBeans tab, you can view and set the following properties and values:

You can run the Financial Reporting Configuration properties under theHyperion Home\product/financialreporting\bin directory using FRConfig.cmd (or FRConfig.sh for non window). Double click the command to launch JConsole and connect to and modify the Financial Reporting MBean values. Also, not the following:

you do not need to restart all the services after changing print server and scheduler server. However:

Table 1. 

NameDefault ValueDescription

AllowCellTextAsAnnotations

falseThis is an Annotations–related setting. Cell text for Oracle Hyperion Financial Management and Oracle Hyperion Planning can be exposed as Annotations. A report designer can enable the display of the Cell text as Annotations for a given report. A “true” means that the report designer can set a property to show the appropriate cell text as Annotations.
AllowDocumentAttachmentAsAnnotationsfalseThis is an Annotations–related setting. LROs for Oracle Hyperion Essbase, Cell Documents for Oracle Hyperion Financial Management and Document Attachments for Oracle Hyperion Planning can be exposed as Annotations. A report designer can enable the display of these as Annotations for a given report. A “true” means that the report designer can set a property to show the appropriate document Attachment as Annotations.

AllowPlanningUnitAnnotationsAsAnnotations

falseThis is an Annotations–related setting. Planning Unit Annotations (PUA) for Oracle Hyperion Planning can be exposed as Annotations. This option determines whether a report designer can enable showing of the PUA as Annotations for a given report. A “true” means that the report designer can set a property to show the appropriate PUA as Annotations.

AttachedFileMaxSize

 

BaseFRWebApp

 

BaseFRWebApp

BaseWebApp

 This reflects the URL link to the Workspace web application.

BaseWebContext

WorkspaceThis reflects the context for the Workspace web application

BatchBurstingThreads

10The number of parallel threads that a particular Scheduled Job will spawn to handle the scenario where a batch is being burst.

BookTOCPrintTemplate

BookTOCPrintTemplate=${oracle.instance}/bin/toc-template.rtf This is for the print engine which uses BI Publishers FO processor. The property specifies the location of the RTF template file which is used when generating the Book TOC using the new print engine.

CacheADMConnectionBasedOnSession

trueUse this property to enable caching of ADM connection (for connecting to Essbase, planning and HFM) in a connection pool for each user session.

CachePDFForSnapshots

false

Specify whether all snapshots and snapshot books produced by the scheduler generate and cache PDFs in Workspace. This will improve initial PDF retrieval times for snapshots for web viewers.

Note:

This will require additional space in EPM Workspace.

Note:

Regardless of this setting, PDFs are cached in Oracle Hyperion Enterprise Performance Management Workspace after the first request for a snapshot or snapshot book in PDF format. The default is “false”. Valid values are “true” and “false” (case sensitive).

Categories

 

For Annotations, specify the annotation categories.

ChangeExtensions

 This property allows you to change extensions of the files attached to an email sent as a result of Scheduled Job execution. This is because some extensions are not allowed for attachments to emails by certain companies. The extension is changed to the value specified.

Each property is separated by comma, and each property is specified as Prop1=value1, prop2=value2

ChartPlottingIgnores

 

Controls how charts treat #MISSING, #ERROR and #ZERO values. This needs to be a comma-delimited list of the possible values which are “error”, “missing” and “zero” in any order. These are case-insensitive. Leaving this blank will treat all values as Zeroes

ClassicPrintServerPrinterMask

HRPrinter#Specify the printer name mask (note that # is dynamically replaced by the print server). The install creates printers HRPrinter1-5 by default. Edit HRCreatePrinters.ini and run HRCreatePrinters.exe in financialreporting\bin to create printers with a different name.

ClassicPrintServerPrinterPool

5Specify the number of printers available for PDF output. By default the install creates 5 printers. Additional printers can be created by editing HRCreatePrinters.ini and running HRCreatePrinters.exe in financialreporting\bin.

CleanUpThreadDelay

300000

Specify the frequency (in milliseconds) at which the MinimumConnectionInactiveTime cleanup thread runs. The default is to check for inactive connections every 300000 milliseconds (5 minutes).

ClientSystemProperties

 

The syntax should be:FolderLabel1=FolderPath1,FolderLabel2=FolderPath2, and so on.

Each property is separated by comma, and each property is specified as Prop1=value1, prop2=value2

DbConnRetryInterval

 

In Annoationss, if you have a database rack and failover happens, how long, in milliseconds, do you want to wait for a successful attempt to the database.

DbMaxConnectAttempts

 

In Annoationss, if you have a database rack and failover happens, how many retries to connect should be made.

DiscManMappingToolWSDL

 

Read only. Identifies the WSDL path for Oracle Hyperion Disclosure Management.

DiscManSessionWSDL

 

Read only. Identifies the WSDL path for Oracle Hyperion Disclosure Management.

DisplayDatasourceInFlatList

falseThis property lets you enable to present all data sources used in a particular Report or Book in a flat list in the Preview User POV Dialog.

DisplayFilterBySecurity

TrueThis property allow users to change the FilterBySecurity settings in the web. When set to “false”, users cannot change the FilterBySecurity options, and cannot see members to which they lack access. When set to “true”, users can change the FilterBySecurity settings on the web and can see members to which they lack access. The default is “true”.

EnableSMTPServerAuthentication

FalseThis property enables use of the SMTP server to authenticate for sending emails from the Scheduler.

EntityCurrency

USD=$,Euro=€

Oracle Hyperion Financial Management entity currency. You can specify a value to be used instead of an Entity Currency code when shown by the <<HFMCurrency()>> text function in a report. For example: if the HFMCurrency function would return "USD", you can specify that it show the symbol "$"

Note:

Non-ascii characters must be specified as unicode encoded strings ( \u20ac).

Each property is separated by comma, and each property is specified as Prop1=value1, prop2=value2

EssbaseJAPIServer

Localhost

When using 3 Tier APS mode to access Essbase, specify the APS Server machine name.

EssbaseUseMDX

trueThis ensures that the query language to access Analytic Services (Essbase Analytic and/or Enterprise Analytic) is MDX.

ExportExcelUseRawNumbers

falseExport to Microsoft Excel without scaling.

ExportFolders

 

Specifies the folder locations when exporting and deploying a book as html.

The syntax should be:FolderLabel1=FolderPath1,FolderLabel2=FolderPath2, and so on.

Example: export1=e:\\exportfolder1,export2=e:\\exportfolder2

FollowedUrlPrefixList

 This is a semicolon-delimited list of URLs from where HTML content will be fetched and included in the Budget Book if it refers to it.

GsmServers

 

Specify the foundation server for Annotations.

HRWebHtmlLocation

 Specify the location where the Financial Reporting web Application will temporarily store temporary interactive web files. The default location for EPM is ${EPM_ORACLE_INSTANCE}/products/financialreporting/temp/","java.lang.String"

HRWebKeepAliveInterval

1Specify, in minutes, the frequency at which the web Application Server sends replies back to the browser client. This is useful if http traffic passes through a proxy server that imposes timeouts. The default is 1 minute

HRWebStaticHTMLLocation

 Specify the location where the Financial Reporting web Application will temporarily store static html files. The default location for EPM is ${EPM_ORACLE_INSTANCE}/products/financialreporting/temp/","java.lang.String

HTTPProxyHost

 Proxy server hostname for any http connections required by Financial Reporting Books.

HTTPProxyPort

 Proxy server Port number for any HTTP connections required by Financial Reporting Books.

HasEntityCurrencyMappings

falseFinancial Management entity currency. If you are going to define entity currency "mappings", then set the HasEntityCurrencyMappings to true.

HssLocation

 Read Only. EPM Mode only: This specifies the location of the Hyperion Shared Services Server.

HtmlFormat

0

Specify the html format of HTML generated by the scheduler:

  • 0 — generic HTML with images in a subdirectory .

  • 1 — mhtml format with embedded images. (works only with Internet Explorer), extension of file will be .mht).

  • 2 — Mozilla compatible single file with imbedded images. (works only with Netscape, Mozilla, and Firefox ).

InstalledDir

${home.reports.lib}

Specify the location where the FR Scheduler Server will persist its state in scheduler.xml. The default is ${home.reports.lib}.

MaxEmailAttachmentSize

0

Specify the maximum attachment size for emails. Any value 0 or less means no limit for attachments. The value should be specified in terms of KBs (kilobytes). The following example sets maximum attachment size to 128 KB: AttachmentSize = 128. The default is 0.

MaxExpandAllCount

 

In Member Selection, the maximum items to display when clicking "Expand All".

MaxImportFileSize

0

Specify the maximum allowed file size for Financial Reporting Import functionality. If the size of a zip file is less than maximum allowed, but it contains a file with actual size more than the limit, then the import will fail. This value is specified in terms of KBs. By default there is no limit on size of file allowed to import. For example: MaxImportFileSize=1000 This will limit import file size to 1MB. This means, importing any file (zip or otherwise) with size more than 1MB will fail. Also, even if the zip file size is less than 1MB but actual size of a compressed file in zip is more than 1MB, then the import will fail.

MaxPortUsage

0This specifies the upper threshold for number of Ports used by the windows system after which the report queries will start queuing up till some of these get released. A value of “0” means that no limit will be imposed

MaxSearchResult

50This limits the maximum number of members that will be returned as a result of a search query in member selection UI.

MaximumCalculationIterations

5

Report Server Calculation Setting. Specify the maximum number of calculation iterations for all grids and cells. During the calculation process of a grid, it may be necessary to evaluate a cell multiple times due to reference precedence. This mostly occurs in grids with references to other grids. If there are no circular references and calculation cells are retuning Error, increasing the value may resolve the problem. The default is 5.

Note:

Making the number very high may degrade grid execution performance.

MemberSelectionDoInitialSearch

false

If this value is true, the member selector searches for the member that was previously selected and expands the tree appropriately to where it is located.

MemberSelectionRowsPerPage

20

Number of rows returned per page as a result of the member selection search query. Only standard values of 5, 10, 20 ,50, 100, 250, and 500 are recommended to be used for this property under MBeans.

MinimumConnectionInactiveTime

300000

Connection Manager Setting. The Connection Manager is a sub-component of the Report Server, web Application and Financial Reporting Studio. The lifetime of a data source connection is determined by MinimumConnectionInactiveTime. Specify the minimum time (in milliseconds) before an inactive data source connection is closed by the MinimumConnectionInactiveTime cleanup thread. The default is to close connections that have remained inactive for 300000 milliseconds (5 minutes).

MissingValuesAreZeroInFormulasInHFM

True

Report Server calculation setting. For Financial Management data sources, whether to treat Missing values as zero in formula calculations.

  • A value of false means that Missing values are not the same as zero values in formula calculations,

  • a value of true means that Missing values are treated as a value of zero in formula calculations

Note:

this property is only effective for Oracle Hyperion Financial Management data sources

NumberDecimalPlacesForZero

2Specify how many decimal places a number has to have before it is considered a zero (0). The default is 2.

NumberDecimalPlacesForZeroInSuppression

5NumDecimalPlacesForZeroInSuppression is used only when you doing Conditional Suppression and Conditional Format against ‘Zero’. The value of NumDecimalPlacesForZeroInSuppression will determine how many digits to the right of the decimal place are evaluated when determining if a numeric value is zero in conditional suppression and conditional formatting. When you do conditional suppression/format against a ‘Value’ of ‘0’, the comparison is to compare the value to absolute zero (0). The default for this property is 5. For example, using the default property of 5 for NumDecimalPlacesForZeroInSuppression: If a value is 0.00001 it would not be considered zero; a value of 0.000001 would be considered zero.

OBIEEServer

 

Location used when adding OBIEE server for Book integration.

PassCSSTokenToHssEssDriver

  

PDFRootDir

${EPM_ORACLE_INSTANCE}/products/financialreporting/temp/PDFOutput/

Specify the location where the Financial Reporting Print Server will temporarily store PDF files.

PUASeparator

(Empty default)

Planning Unit Annotation Separator.

This entry is used for separating the Planning Unit Annotations. Below, are two examples of PUASeparator entry. The first example uses underscore as a separator. You can also specify UNICODE characters in the form of \uXXXX. The second example shows this. \u2014 is actually UNICODE hex-number for Em-Dash Character. To quickly get the UNICODE hex-number of a character, open the "Character Map" utility of Windows by selecting Accessories, and then System Tools. Click the character you want to see and the UNICODE number appears on the lower left in U+XXXX format. If no PUASeparator is specified, the default is the Em-Dash (—).

PassCSSTokenToHssEssDriver

True

Specify whether an underlying Data Source should be passed CSS Tokens. You should not change this setting unless there are specific reasons which cause issues with the current settings. When there are no property file entries the token will be passed to the data source for user validation.

PrintServerResultCacheTime

6000000Specify the time (in milliseconds) that completed Reports, Snapshots, Books, and Snapshot books will remain on the Printserver (for generating PDF or printing) before they are removed. (The period of time before which uncollected, or "orphaned", results are deleted) The default is to remove results that run longer than 6000000 milliseconds

PrintServerResultsCleanUpThreadDelay

36000000Specify the frequency (in milliseconds) at which the PrintServerResultCacheTime cleanup thread runs. Setting this too low could cause running requests to be terminated and removed. The default is to check for uncollected results every 36000000 milliseconds (10 hours).

PrintServers

 Comma separated list of print servers available to the report server in the ‘server:port’ format. For example: printserver1:10999, printserver2:10999.

PrintingMaxThreads

10Specify the maximum number of threads created for Printing/generating PDF’s at any time. The default is based on the number of CPUs in the host machine - 5 threads per CPU. 1 CPU -> 5 threads , 2 CPU's -> 10 threads, 3 CPU's -> 15 threads, 4 or more CPUs -> 20 threads Specifying 0 will allow an unlimited number of threads to be created

RemoteAdmServer

null

Identifies a remote server from which data source is accessed.

RMIClientSocketFactory

 This provides an option to override the Client Side Socket Factory implementation used for RMI. By default we use a custom client socket factory for RMI.

RMIPortRangeLower

 This specifies the starting port number that Financial Reporting could use for its RMI communication. It is usually recommended to set this when using Firewalls.

RMIPortRangeUpper

 This specifies the upper Port number that Financial Reporting could use for its RMI communication. When configured with Firewalls a RMIPortRangeLower and RMIPortRangeUpper can be specified to limit the number of ports that could be used by RMI.

RMIServerSocketFactory

The default factory implementation as shipped with JDK is used.This provides an option to override the Server Side Socket Factory implementation used for RMI.

RegisteredRelatedContentURLs

null

The default Related Content provider.

The format of the value is:

Product/server name/url

Where Product is the product name, server name is the server location and url is the provider url.

RelatedContentAliases

(The default is empty string)These are aliases for the related content server and ports used in the product. They are extremely useful for migration purpose.

RelatedContentURLs

(The default is empty string)These are the URLs for the specifying the related content.

RelativeRelatedContentServers

(The default is empty string)It allows specifying the RelatedContent servers in a relative manner. It is useful when doing the SSL offloading.

ReportServerMaxThreads

5

Specify the maximum number of threads created for running reports at any time. The default is based on the number of CPUs in the host machine - 5 threads per CPU.

  • 1 CPU = 5 threads

  • 2 CPUs = 10 threads

  • 3 CPUs = 15 threads

  • 4 or more CPUs = 20 threads

  • Specifying 0 allows an unlimited number of threads to be created.

ReportServerReportCacheTime

72000000

Specify the time (in milliseconds) that completed Reports, Snapshots, Books, and Snapshot books will remain on the Report Server before they are removed. (The period of time before which uncollected, or "orphaned", results are deleted. A result may become orphaned, for example, if a user requests a report, then closes his web browser before the report finishes running.) The default is to remove results that run longer than 72000000 milliseconds (20 hours).

ReportServerReportCleanUpThreadDelay

36000000

Specify the frequency (in milliseconds) at which the ReportServerReportCacheTime cleanup thread runs. Setting this too low could cause running requests to be terminated and removed. The default is to check for uncollected results every 36000000 milliseconds (10 hours).

ReportServerWaitCount

 

In Scheduler, specify how many attempts to connect to the report server.

ReportServerWaitDelay

 

Specify how long, in second, to wait before scheduler tries to reconnect to report server.

RowsPerPage

 

An Annotations Manager preference. Specifies how may rows per page to display.

SMTPMailServer

 Read Only. The SMTP mail server that gets used for sending emails from Scheduler.

SMTPPort

 Port of the SMTP server used for sending emails from scheduler.

SMTPServerPassword

 The password for accessing the SMTP server if it is password protected.

SMPTServerUserID

 The user ID for accessing the SMTP server if it is protected.

SSASImpersonate

falseAllows impersonation of windows user to access SSAS data source. A “true” means that you want to connect to the SSAS data source as the currently logged in windows user If set to false, then it will use the passed credentials.

Note:

Financial Reporting does not use SSAS data source in this release.

ScheduledBatchCacheTime

0

Configuration setting for the Financial Reporting Scheduler Server. Specify the time in milliseconds to retain completed batch results. For example, to delete batch results older than 5 days specify 432000000 milliseconds. The ScheduledBatchCleanUpThreadDelay property must be set to a value greater than 0 to enable this cleanup option. Pending batches will not be removed. The default is 0 milliseconds which means that batch results will not be removed.

ScheduledBatchCleanUpThreadDelay

0

Specify how often the scheduler should check for batch results to remove (in milliseconds). For example, to check every 24 hours specify 86400000 milliseconds as the value. The default is 0 milliseconds which means that the scheduler will not remove batch results.

SchedulerServer

 This specifies the configured scheduler server name

SchedulerTemplateLocation

${EPM_ORACLE_INSTANCE}/products/financialreporting/data/SchedulerTemplate

Configuration setting for the FR Scheduler Server. Specify the location where the FR Scheduler Server will get template files. The default is

SchedulerOutputLocation

SchedulerOutputLocation,PropType.NORMAL,"${EPM_ORACLE_INSTANCE}/FinancialReporting/data/SchedulerOutput/","java.lang.String"

The location where the context of resulting files for batch execution is stored

SortUsesJavaCollator

TrueThis exposes the choice for not using the default Java collator for sorting purposes.

StellentServer

 This specifies the Oracle Universal Content Management server name. This is useful if the content for Oracle Universal Content Management is added to Financial Reporting Book as an external content.

StudioInstallerLocation

 

Read Only. The location for the Studio Installer. When HRStudioRetrieve.jsp is called, this is the location from which it serves up the Studio MSI (Windows installer).

SystemMode

 Read Only. Show Fusion applications or no Fusion applications.

TextPrintTemplate

 

Specify the full path to a Microsoft Word document that will be used as a template for text file printing. This is used by cell documents in a report and external content in a book. The default location and name for the file is C:/Hyperion/products/financialreporting/install/scripts/../../bin/FR_TextTemplate.doc.

UrlLaunchMode

post,yahoo.com|google.com

A regular expression used to determine exceptions. The value contains two components; the first componenet is the type used for launching URLs. The second component is a regular expression to identify exceptions to how the URL should be launched.

Specifies the type of HTTP request made for related content links and exceptions. The first value is the default and should be “post” or “get”. The second value should be any exception which should not use that type of request.

Note:

The default is "Post" except when Google or Yahoo.

UseEssbaseEDS

true

To use the Analytic Provider Services (APS) driver instead of the native ADM driver, specify UseEssbaseEDS=true. If using APS remote mode, uncomment the EssbaseEDSSErver property and specify your APS server name as its value:

UseEssbaseEDS=false

EssbaseEDSServer=

EssbaseEDSDriver=HssEdsDriver

XBRLCtxManagerFilePath

null

Specify the location of the XBRL Context Manager file.

XBRLSchemaFileLocation

<HYPERION_HOME>products/financialreporting/install/scripts/../../bin/XBRLSchemaMgr.xml

This is the root folder of the XBRL files that will be scanned by FR. Any taxonomies that are located here will be parsed.

XBRLSchemaFilePath

<HYPERION_HOME>products/financialreporting/install/scripts/../../common/xbrlfiles

The location of the XBRLSchemaMgr.xml which maintains information about the parsed taxonomies located in “XBRLSchemaFileLocation”.

XBRLShowOrphanedItems

falseIf this flag is set to “true” then if a taxonomy element does not have any parent or does not appear in the presentation linkbase, do not display it. If “false” Then display the taxonomy item every time.

XBRLUseDefinitionLinkBase

falseIf this flag is set to “true” and there are no presentation linkbase, then it will use the definition linkbase.

XBRLUnitManagerFilePath

null

Specify the location of the XBRL Unit Manager file.

ZipEmbedded

TrueThis option allows zipping up of the files when “export to HTML” option is chosen as an output type for a Scheduled Job

com.hyperion.pbm.general.ColorTheme

null

Specify the default color theme across the product.

com.hyperion.reporting.HRPrefs.Units

inches

Specify a default user preference value for ruler unit. Value can be either:

  • Inches

  • Centimeters

com.hyperion.reporting.HPrefs.colorcontrast

false

A high-contrast color mode available for accessibility. This option is supported only on the same platforms on which Screen Readers are supported.

com.hyperion.reporting.HPrefs.country

US

Specify a default user preference value for user's country. Value can be any ISO country code for supported country.

com.hyperion.reporting.HRPrefs.dateformat

null

Specify the default date format across the product.

com.hyperion.reporting.HRPrefs.decimalsymbol

,

Specify a default user preference value for decimal symbol. Value can be , (comma). or _ (underscore)

com.hyperion.reporting.HRPrefs.digitgroup

,

Specify a default user preference value for digit grouping. Value can be , (comma). or _ (underscore).

com.hyperion.reporting.HRPrefs.footnote_param

Title & Detail & Category & Author & Date & Description & Attachments & Replies:All

In Annotations, specify default print options such as title, category, author, descriptions and attachment.

com.hyperion.reporting.HRPrefs.filter_by_security

false

Allows you to filter member selection based on Planning security.

com.hyperion.reporting.HRPrefs.glcolor

#000000

Specify a default user preference value for grid line color. Value is in the format of #RRGGBB where RR is hex value for red, GG is hex value for green and BB is blue as specified by HTML specifications.

com.hyperion.reporting.HRPrefs.glsnap

true

Specify a default user preference value for grid line snapping. Value can be either true or false.

com.hyperion.reporting.HRPrefs.glspacing

null

Iin Oracle Hyperion Financial Reporting studio, specify the backgroung default spacing between guidlines.

com.hyperion.reporting.HRPrefs.glstyle

dot

Specify a default user preference value for grid line style. Value can be either line or dot.

com.hyperion.reporting.HRPrefs.HelpUserTrainingUri

 

Read Only. An administriative setting in Workspace to enable UPK (User Productivity Kit ).

com.hyperion.reporting.HRPrefs.language

EN

Specify a default user preference value for user's language. Value can be any ISO language code for supported languages.

com.hyperion.reporting.HRPrefs.locationuserpov

above

Specify a default user preference value for location of User POV bar. Value can be either above or viewpane.

com.hyperion.reporting.HRPrefs.merge_equal_prompts

true

Specify the default behavior for users who have not explicitly set the "Merge Equivalent Prompts" setting in Web User Preferences. A value of true means equivalent Prompts will be merged, a value of false means equivalent Prompts will not be merged.

com.hyperion.reporting.HRPrefs.office_format

Office2002

Specify a default user preference value for MS Office version. Value can be either Office2000 or Office2002.

com.hyperion.reporting.HRPrefs.previewuserpov

false

Specify a default user preference value for showing Preview User POV dialog. Value can be true or false. Value of true will display Preview User POV dialog whereas false will not.

com.hyperion.reporting.HRPrefs.viewtype

html

Specify a default user preference value for view type. Value can be html or pdf

com.hyperion.reporting.HRPrefs.xbrlenabled

false

Specify a default user preference value for XBRL enabled. Value can be either true or false.

BaseConfigServlet

/browse/configURL

Specify the location of the Main Configuration servlet path.