A Property Information
JConsole is the Java Monitoring and Management Console used to define and manage the various properties for Oracle Hyperion 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 properties and values.
You can run the Financial Reporting Configuration properties under the Oracle Home\product\financialreporting\bin directory using FRConfig.cmd (or FRConfig.sh for platforms other than Microsoft Windows). Double-click the command to launch JConsole, and then connect to and modify the Financial Reporting MBean values.
Note the following:
- The command file is only available on the web application server.
- The web application does not need to be running.
- After making changes, restart all services.
- You do not need to restart all the services after changing print server and scheduler server.
Table A-1 Properties
| Name | Default Value | Description |
|---|---|---|
| AllowCellTextAsAnnotations | false | Display cell text for Oracle Hyperion Financial Management and Oracle Hyperion Planning as annotations in a report. |
| AllowDocumentAttachmentAsAnnotations | false | Display LROs for Oracle Essbase, Cell Documents for Financial Management, and Document Attachments for Planning as annotations in a report. |
| AllowPlanningUnitAnnotationsAsAnnotations | false | Display Planning Unit Annotations (PUA) for Planning as annotations in a report. |
| AttachedFileMaxSize | ||
| BaseConfigServlet |
/browse/configURL
|
Location of the main configuration servlet path |
| BaseFRWebApp | Display the base Financial Reporting web application in a report. | |
| BaseWebApp | URL link to the EPM Workspace web application | |
| BaseWebContext | Workspace | Context for the EPM Workspace web application |
| BatchBurstingThreads | 10 | Number of parallel threads that a scheduled job will spawn when a batch is burst |
| BookTOCPrintTemplate |
BookTOCPrintTemplate=${oracle.instance}/bin/toc-template.rtf
|
Location of the RTF template file used when generating the book Table of Contents using the print engine that uses BI Publisher’s FO processor. |
| CacheADMConnectionBasedOnSession | true | Caches the ADM connection (for connecting to Essbase, Planning and Financial Management) in a connection pool for each user session. |
| CachePDFForSnapshots | false | Whether snapshots and snapshot books produced by the scheduler generate and cache PDFs in EPM Workspace. This improves PDF retrieval times for snapshots for Web viewers.
Notes:
|
| Categories | Annotation categories | |
| ChangeExtensions |
Change extensions of files attached to an email sent as a result of Scheduled Job execution. This is because some companies do not allow extensions for attachments to emails. 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 | How charts treat #MISSING, #ERROR and #ZERO values. Must be a comma-delimited list of the possible values which are "error", "missing" and "zero" in any order. The values are case-insensitive. If left blank, all values are treated as zeroes. | |
| ClassicPrintServerPrinterMask | HRPrinter# | Printer name mask (note that # is dynamically replaced by the print server). The install creates printers HRPrinter1-5 by default. To create printers with a different name, edit HRCreatePrinters.ini and run HRCreatePrinters.exe in financialreporting\bin.
|
| ClassicPrintServerPrinterPool | 5 | Number of printers available for PDF output. By default, the install creates five printers. To create additional printers, edit HRCreatePrinters.ini and run HRCreatePrinters.exe in financialreporting\bin. |
| CleanUpThreadDelay | 300000 | 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 |
|
| com.hyperion.pbm.general.ColorTheme | null | Color theme across the product |
| com.hyperion.reporting.HRPrefs.Units | inches | Value for ruler (inches or centimeters) |
| com.hyperion.reporting.HPrefs.colorcontrast | false | High-contrast color mode for accessibility. Supported only on the same platforms on which screen readers are supported. |
| com.hyperion.reporting.HPrefs.country | US | ISO country code for supported country |
| com.hyperion.reporting.HRPrefs.dateformat | null | Date format across the product |
| com.hyperion.reporting.HRPrefs.decimalsymbol | , | Value for a decimal symbol. Value can be comma ( , ). or underscore ( _ ). |
| com.hyperion.reporting.HRPrefs.digitgroup | , | 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, default print options such as title, category, author, descriptions and attachment. |
| com.hyperion.reporting.HRPrefs.filter_by_security | false | Filters member selection based on Oracle Hyperion Planning security |
| com.hyperion.reporting.HRPrefs.glcolor | #000000 |
Grid line color Enter the value 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. |
| com.hyperion.reporting.HRPrefs.glsnap | true | Whether to enable grid line snapping |
| com.hyperion.reporting.HRPrefs.glspacing | null | Background spacing between guidelines in Oracle Hyperion Financial Reporting Studio |
| com.hyperion.reporting.HRPrefs.glstyle | dot | Grid line style. Value can be either line or dot. |
| com.hyperion.reporting.HRPrefs.HelpUserTrainingUri | Read Only. Administrative setting in EPM Workspace to enable UPK (User Productivity Kit). | |
| com.hyperion.reporting.HRPrefs.language | EN | User language. Can be any ISO language code for supported languages. |
| com.hyperion.reporting.HRPrefs.locationuserpov | above | Location of the User POV bar. Value can be either "above " or "viewpane." |
| com.hyperion.reporting.HRPrefs.merge_equal_prompts | true |
Default behavior for users who have not explicitly set the "Merge Equivalent Prompts" setting in Web User preferences. "True" means that equivalent prompts are merged," false" means equivalent prompts are not merged. |
| com.hyperion.reporting.HRPrefs.previewuserpov | false | Whether to show the Preview User POV dialog box |
| com.hyperion.reporting.HRPrefs.viewtype | HTML | View type ("html" or "pdf") |
| DbConnRetryInterval | In Annotations, 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 Annotations, 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 Disclosure Management | |
| DiscManSessionWSDL | Read only. Identifies the WSDL path for Disclosure Management | |
| DisplayDatasourceInFlatList | false | Displays all data sources used in a report or book in a flat list in the Preview User POV dialog box |
| DisplayFilterBySecurity | true | Changes 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. |
| EnableSMTPServerAuthentication | false | Uses the SMTP server to authenticate sending emails from the Scheduler. |
| EntityCurrency | USD=$,Euro=€ |
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 returns "USD", you can specify that it show the symbol "$". Notes:
|
| EssbaseJAPIServer | Localhost | APS Server machine name when using 3 Tier APS mode to access Oracle Essbase. |
| EssbaseUseMDX | true | Ensures that the query language to access Analytic Services (Essbase Analytic and/or Enterprise Analytic) is MDX. |
| ExportExcelUseRawNumbers | false | Exports to Microsoft Excel without scaling |
| ExportFolders |
Folder locations when exporting and deploying a book as HTML. The syntax should be: For example:
|
|
| FollowedUrlPrefixList | Semicolon-delimited list of URLs from where HTML content is fetched and included in the Budget Book if it refers to it. | |
| GsmServers | Foundation server for annotations | |
| HRWebHtmlLocation | Location where the Financial Reporting web application stores temporary interactive web files. The default location for Oracle Enterprise Performance Management System is ${EPM_ORACLE_INSTANCE}/products/financialreporting/temp/","java.lang.String"
|
|
| HRWebKeepAliveInterval | 1 | Frequency, in minutes, 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. |
| HRWebStaticHTMLLocation | Location where the Financial Reporting web application temporarily stores static HTML files. The default location for EPM System is ${EPM_ORACLE_INSTANCE}/products/financialreporting/temp/","java.lang.String
|
|
| HTTPProxyHost | Proxy server host name for HTTP connections required by Financial Reporting books | |
| HTTPProxyPort | Proxy server port number for HTTP connections required by Financial Reporting books | |
| HasEntityCurrencyMappings | false | Oracle Hyperion Financial Management entity currency. Set to true to define entity currency "mappings". |
| HssLocation |
Read Only. Oracle Enterprise Performance Management System only: Location of the Application Management Server |
|
| HtmlFormat | 0 | HTML format the scheduler generates:
|
| InstalledDir |
${home.reports.lib}
|
Where the Financial Reportingscheduler server persists its state in scheduler.xml
|
| IsDoubleRoundingRequiredForZeroDecimalPlaces | false |
Double-rounds data values where number formatting decimal places is set to zero. When set to true Financial Reporting tries to double round the value for decimal places = 0. For example, 0.49999999 is displayed as 1. When set to false, Financial Reporting tries to single round the value for decimal places = 0. For example, 0.49999999 is displayed as 0. |
| MaxEmailAttachmentSize | 0 |
Maximum attachment size for emails. Values or 0 or less means no limit for attachments. Specify the value in kilobytes. The following example sets maximum attachment size to 128 KB:
|
| MaxExpandAllCount | In Member Selection, the maximum items to display when clicking "Expand All" | |
| MaxImportFileSize | 0 |
Maximum file size for files imported to Financial Reporting. By default, there is no limit on import file size. For example, if MaxImportFileSize is set to 1000, the import file size is limited to 1 MB. This means, importing any file, including .zip files, larger than 1 MB fails. This restriction also applies to files within a .zip file. If the .zip file size is less than 1 MB, but the actual size of a compressed file in the .zip file is more than 1 MB, the import fails. |
| MaxPortUsage | 0 | Upper threshold for number of ports used by the windows system after which report queries will start queuing up until some get released. A value of "0" means that no limit is imposed. |
| MaxSearchResult | 50 | Maximum number of members that will be returned as a result of a member selection search query. |
| MaximumCalculationIterations | 5 |
Report Server Calculation Setting. Specifies 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. Note: A high number may degrade grid execution performance. |
| MemberSelectionDoInitialSearch | false | If set to true, the member selector searches for the member that was previously selected and expands the tree 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 subcomponent of the Report Server, Web Application and Financial Reporting Studio. Minimum time (in milliseconds) before an inactive data source connection is closed. 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.
Note: This property is only effective for Oracle Hyperion Financial Management data sources. |
| NumberDecimalPlacesForZero | 2 | How many decimal places a number must have before it is considered a zero (0) |
| NumberDecimalPlacesForZeroInSuppression | 5 |
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). For example, using the default property of 5, a value of 0.00001 is considered zero. |
| OBIEEServer | Location used when adding OBIEE server for book integration. | |
| PassCSSTokenToHssEssDriver | ||
| PDFRootDir |
${EPM_ORACLE_INSTANCE}/products/financialreporting/temp/PDFOutput/
|
Location where the Financial Reporting Print Server temporarily stores PDF files |
| PUASeparator | Separates Planning Unit Annotations. If no PUASeparator is specified, the default is the Em-Dash (—). | |
| PassCSSTokenToHssEssDriver | true |
Whether an underlying data source should be passed CSS tokens. Do 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 is passed to the data source for user validation. |
| PrintServerResultCacheTime | 6000000 | Time (in milliseconds) that completed reports, snapshots, books, and snapshot books remain on the print server before they are removed |
| PrintServerResultsCleanUpThreadDelay | 36000000 | Frequency (in milliseconds) at which the PrintServerResultCacheTime cleanup thread runs. Setting this too low could cause running requests to be terminated and removed. |
| PrintServers | Comma separated list of print servers available to the report server in the ‘server:port’ format. For example: printserver1:10999,printserver2:10999.
|
|
| PrintingMaxThreads | 10 |
Maximum number of threads created for printing/generating PDF files at one time. The default is based on the number of CPUs in the host machine. Five threads are allowed for each CPU. For example, the default for a system with two CPUs is ten threads. Specifying 0 allows an unlimited number of threads to be created |
| RemoteAdmServer | null | Identifies a remote server from which the data source is accessed. |
| RMIClientSocketFactory | Overrides the Client Side Socket Factory implementation used for RMI. By default a custom client socket factory is used for RMI. | |
| RMIPortRangeLower | Starting port number that Financial Reporting uses for an RMI communication. You should set this when using firewalls. | |
| RMIPortRangeUpper |
Upper Port number that Financial Reporting uses for an RMI communication. When configured with firewalls, you can specify RMIPortRangeLower and RMIPortRangeUpper values to limit the number of ports used by RMI. |
|
| RMIServerSocketFactory | Default factory implementation as shipped with JDK | Overrides the Server Side Socket Factory implementation used for RMI. |
| RegisteredRelatedContentURLs | null |
Default Related Content provider The format of the value is:
where |
| RelatedContentAliases | empty string | Aliases for the related content server and ports used in the product are useful for migration purposes. |
| RelatedContentURLs | empty string | URLs to specify the related content. |
| RelativeRelatedContentServers | empty string | Specifys the RelatedContent servers in a relative manner. This is useful when doing SSL offloading. |
| ReportServerMaxThreads | 5 | Maximum number of threads created to runreports. The default is based on the number of CPUs in the host machine - 5 threads per CPU.
|
| ReportServerReportCacheTime | 72000000 milliseconds (20 hours) |
Time (in milliseconds) that completed reports, snapshots, books, and snapshot books remain on the Report Server before they are removed. Also, the period of time before which uncollected, or "orphaned", results are deleted. A result may become orphaned if you request a report and then close the web browser before the report finishes running. |
| ReportServerReportCleanUpThreadDelay | 36000000 milliseconds (10 hours) | Frequency (in milliseconds) at which the ReportServerReportCacheTime cleanup thread runs. Setting this too low could cause running requests to be terminated and removed. |
| ReportServerWaitCount | In Scheduler, the number of attempts to connect to the report server | |
| ReportServerWaitDelay | Number of seconds to wait before Scheduler tries to reconnect to report server | |
| RowsPerPage | How may rows per page to display (Annotations Manager preference) | |
| SMTPMailServer | Read Only. The SMTP mail server used when sending emails from Scheduler. | |
| SMTPPort | SMTP server port used when sending emails from Scheduler | |
| SMTPServerPassword | Password to access the SMTP server if it is password protected | |
| SMPTServerUserID | User ID to access the SMTP server if it is protected | |
| SSASImpersonate | false |
Allows impersonation of a Windows user to access an SSAS data source. If true, you can connect to the SSAS data source as the currently logged in Windows user If false, the passed credentials are used. Note: Financial Reporting does not use SSAS data source. |
| 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 | 0 |
How often the scheduler checks for batch results to remove (in milliseconds). For example, specify 86400000 milliseconds to check every 24 hours. The default value of 0 means that the scheduler will not remove batch results. |
| SchedulerServer | Configured scheduler server name | |
| SchedulerTemplateLocation |
${EPM_ORACLE_INSTANCE}/products/financialreporting/data/SchedulerTemplate
|
Location where the Financial Reporting scheduler server gets template files |
| SchedulerOutputLocation |
SchedulerOutputLocation,PropType.NORMAL,"${EPM_ORACLE_INSTANCE}/FinancialReporting/data/SchedulerOutput/","java.lang.String"
|
Location where the context of resulting files for batch execution is stored |
| SortUsesJavaCollator | true | Whether to use the default Java collator for sorting |
| StellentServer |
Oracle Universal Content Management server name. This is useful if the content for Oracle Universal Content Management is added to a Financial Reporting book as external content. |
|
| StudioInstallerLocation |
Read Only. The location for the Studio Installer. When |
|
| SystemMode | Read Only. Show Fusion applications or no Fusion applications. | |
| TextPrintTemplate |
C:/Oracle/products/financialreporting/install/scripts/../../bin/FR_TextTemplate.doc
|
Full path to a Microsoft Word document used as a template for text file printing. Used by cell documents in a report and external content in a book. |
| UrlLaunchMode | post,yahoo.com|google.com |
A regular expression used to determine exceptions The value contains two components. The first component is the type used for launching URLs. The second component is a regular expression to identify exceptions for how to launch the URL. Also, 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 is any exception that should not use that request type. Note: The default is "post" except when Google or Yahoo. |
| UseEssbaseEDS | true |
Whether to use the Analytic Provider Services (APS) driver instead of the native ADM driver. If using APS remote mode, uncomment the EssbaseEDSSErver property and specify your APS server name as its value: UseEssbaseEDS=false EssbaseEDSServer= EssbaseEDSDriver=HssEdsDriver |
| Word2007ExportIgnorePageBreak | true | Whether to ignore page breaks when exporting to Word.
|
| ZipEmbedded | true | Zips up the files when "export to HTML" is selected as an output type for a scheduled job |