76
m
If the batch includes Microsoft Word documents with the FRExecute function, the
resulting output depends on the design of the Microsoft Word document:
o
If the FRExecute function was entered in a text box , the resulting output is sized
to fit the parameters of the text box. The designer should size the text box
according to the scope of the FRExecute content.
o
If the FRExecute function was entered on the top of the Microsoft page (not in
a text box), the resulting output is presented as specified in the Financial
Reporting designer.
l
Export as HTML—Export the batch as an HTML file on the scheduler server. To export
to an external directory or a network drive, select Export to an external directory. This
option does not support batch bursting.
Note:
When Export to an external directory is selected, the enabled drop-down menu
is populated by folder locations specified in the
JConsol.exe
file. For
information on JConsole, see the “Property Information” topic in the Oracle
Hyperion Financial Reporting Workspace Administrator's Guide. The value for
this are: FolderLabel1,FolderPath1,FolderLabel2,FolderPath2, and so on.
l
Export as MHTML—Export the batch as a single file on the scheduler server. To export
to an external directory or a network drive, select Export to an external directory. This
option does not support batch bursting.
l
Bursted Output Labels — The Object Label and SubFolder Label fields display two
default text functions that can optionally be used to identify the report and the report's
subfolder names, respectively. Click to select additional text functions. Click to
test the functions. The available functions for bursted reports are:
m
<<MemberName()>>
— Returns the name of the member being bursted. This
function takes no parameters.
m
<<MemberAlias()>>
— Returns the alias of the member being bursted. This
function takes no parameters
m
<<MemberDescription()>>
— Returns the description of the member being
bursted. This function takes no parameters.
m
<<BatchPovMember(“DataSrcName”,”DimName”)>>
— Returns the name of
the POV member being bursted where
DataSrcName
is the name of a data source
of the desired POV (a batch can point to two or more POVs) and
DimName
is the
name of the dimension under the given POV whose member name is to be extracted.
m
<<BatchPovAlias(
“DataSrcName”,”DimName
”)>> — Returns the alias of the
POV member of the report being bursted where
DataSrcName
is the name of a data
source of the desired POV (a batch can point to two or more POVs), and
DimName
is the name of the dimension under the given POV whose member alias
is to be de extracted.
m
<<BatchPovDescription (
“DataSrcName
”,
“DimName”
)>> — Returns the
description of the POV member of the report being bursted, where
DataSrcName
is the name of a data source of the desired POV (a batch can point
Scheduling Batches to Run
75
56
to two or more POVs), and
DimName
is the name of the dimension under the given
POV whose member description is to be extracted.
Note:
When POV-related functions (BatchPovMember, BatchPovAlias, and
BatchPovDescription) are added, the parameter values must be surrounded by
double quotes For example: <<BatchPovDescription(“Essbase sample basic on
ProdServer1”,”Product”>>. where “Essbase sample basic on ProdServer1” is the
data source name and “Product” is the dimension name.
m
<<FinancialReportingObjectName()>> — Returns the name of the Financial
Reporting object being bursted. This is typically the report name. This function
takes no parameters.
m
<<Financial ReportingObjectDescription()>> — Returns the description of the
Financial Reporting object being bursted. This is typically the report description.
This function takes no parameters.
m
<<Date(“format”)>> — Returns the date and time that an online report is
populated with data, or the date and time a snapshot report is saved, where
format
is a list of characters enclosed in quotes that define the format of the date
and time. See the Oracle Hyperion Financial Reporting Studio User’s Guide, Using
Functions chapter for a list of all the
format
date and time characters.
l
Preview Bursting List — Select to preview the CSV bursting list. The list shows the
default settings selected for members in the job bursting batch.
2
Click Next.
l
If your scheduled batch includes email PDF attachments with job bursting, the PDF
Attachment Email dialog box is displayed.
l
If your scheduled batch includes email PDF attachments without job bursting, the Scheduled
Batch Details dialog box is displayed.
Setting Up Email Notifications
You can send a status of Successful and/or Unsuccessful by email when batches scheduled for
PDF output are completed. For nonbursted batches, the email contains the notification and PDF
attachments; for bursted batches, the email contains only the notification.
ä
To set up email notifications:
1
To arrive at Scheduled Batch Details, start the batch wizard and navigate to the email details screen.
2
Perform an option:
l
To set up email addresses when the batch runs successfully, select If Successful, Email
Details to. Then click Select.
l
To set up email addresses when the batch runs unsuccessfully, select If Unsuccessful,
Email Details. Then click Select.
76
Scheduling Batches
46
3
Optional. For job bursting batches, click Preview Bursting List to view and export the Bursting Destination
file. This file contains default settings selected for the members in the bursted batch. For information
on this file, see About the Bursting Destination File.
Selecting Email Addresses for Batch Scheduling
You can set up the scheduler to send an email when a scheduled batch is completed successfully
or unsuccessfully. The email includes status details of the batch and optionally the PDF output
of the batch. You can select, add, or delete email addresses.
ä
To select recipient emails:
1
To arrive at Select Email Recipients for Scheduling, start the batch wizard.
2
Perform an option:
l
To select email addresses when the batch runs successfully, select If Successful, Email
Details to. Then click Select.
l
To select email addresses when the batch runs unsuccessfully, select If Unsuccessful,
Email Details. Then click Select.
3
In the Select Email Recipients for Scheduling dialog, in the Available Recipients pane, select an email
address and click
.
l
To add new recipient emails, click Add. In Add Address to List of Recipients, add email
addresses, separated with a comma and click OK.
l
To Remove recipients' email, select an email address and click Remove
Select Bursting File
If you have created a CVS Bursting File, and have imported it into the repository, you can select
it for your scheduled batch.
Note:
The batch will run only for members selected in Member Selection in the batch wizard.
The CSV file is used only to output options for individual members in a dimension.
ä
To select a Bursting File:
1
Navigate to the folder containing the Bursting File.
2
Select the Bursting File and click OK.
Preview Bursting List
The Bursting List displays the default setting for the current scheduled batch. You can
periodically view the default settings as you navigate through the batch wizard and export it as
Selecting Email Addresses for Batch Scheduling
77
44
a CSV file to specify output and permissions exceptions for a scheduled batch, thus overriding
the default settings defined for the scheduled batch. For example, you may want to specify a
different subfolder for some reports, based on selected dimensions, or make some reports read-
only. To edit the Bursting Destination File for a current batch, the administrator or designer
exports the file to a text editor or Excel, enters the members, if not already displayed, and edits
any values in the table. Upon completion, the file must be imported into the repository (File ,
then Import , then File) where it can be applied to a scheduled batch. See the Bursting Destination
File for a sample list (located in the “sample” folder).
ä
To export the bursting list as a CVS file:
1
Click Export as CSV. as default, the file is exported to MS Excel, if available, else you are prompted to
select a text editor.
2
Specify the output options and permissions for individual members.
Note:
Members added to the file, that are not also selected in the batch wizard, are ignored
during output. To make the reports “read only” to users based on a group or role,
enter a group name or role name.
Batch Deletion
You can delete batches in these ways:
l
If you have a Global Administrator, Report Designer, Scheduler, or Content Publisher role
and proper file permissions, you can delete batches from the repository.
l
You can delete scheduled batches from the Batch Scheduler.
Deleting Batches from the Batch Scheduler
During batch scheduling, you have the option of deleting the scheduled batch from the scheduler
if completed successfully. If this option is not selected, the successful batches are saved in the
Batch Scheduler. Batches with an “error” status are always saved in the Batch Scheduler.
ä
To delete scheduled batches from the Batch Scheduler:
1
Click Navigate, then Schedule , then Batch Scheduler.
2
In Batch Scheduler, select the batches for deletion.
Tip:
To select multiple batches hold down the CTRL key and click each batch in the list.
3
Select Edit, then Delete.
4
When prompted, click Yes.
78
Scheduling Batches
40
Automatic Removal of Batch Scheduler Results
You can configure the Batch Scheduler to automatically remove batch results that exceed a
specified future age. For example, you can remove batch results that are more than a week old
and any associated result files that are stored on the scheduler server.
The automatic removal option is turned off by default. You can enable it by editing the “Property
Information” topic in the Oracle Hyperion Financial Reporting Workspace Administrator's
Guide. Relevant properties are
ScheduledBatchCleanUpThreadDelay
and
ScheduledBatchCacheTime
.
Retrieving the Exported Output
After a scheduled batch is run, you can retrieve a zipped HTML or PDF output file using the
Retrieve Output option to rename and relocate the zipped file to your local drive from the
scheduler server’s \data\SchedulerOutput\Output directory. You must have access to the batch
to retrieve the exported output.
Note:
If you delete a batch after scheduling one, you cannot retrieve the output. Retrieval is only
valid for non-bursted batch files.
ä
To retrieve output:
1
Click Navigate, then Schedule, then Batch Scheduler.
2
In Batch Scheduler, select a completed scheduled batch that produced exported output.
3
Select Action, then Retrieve Output. The file is presented as a zip file.
4
Select the files to export and click Extract to export the files to a directory on your machine or web server.
Viewing the Status of Scheduled Batches
Scheduled batches can be viewed in a list format. Items such as the start time, destination, status,
and so on that occurred while running the batch are displayed in a row and column format.
Viewing Details of a Scheduled Batch
You can review the details of a particular batch, which includes a summary and server activity
in Show Details.
Launching an HTML Book for Web Viewing
After a scheduled batch is generated as HTML output, you can retrieve the zipped HTML output
file for web viewing by using the Retrieve Output option. The zipped file contains everything
Retrieving the Exported Output
79
48
for you to deploy to your web server. You can rename and relocate the zipped file to your machine
or web server.
ä
To launch a book for web viewing:
1
Click Navigate, then Schedule, and then Batch Scheduler.
2
In Batch Scheduler, select a completed scheduled batch that produced exported output.
3
Select Action, and then Retrieve Output. The file is presented as a zip file.
4
Select the files to export and click Extract To to export the files to a directory on your machine or web
server.
Note:
If you delete a batch after scheduling one, you cannot retrieve the output. Retrieval is only
valid for non-bursted batch files.
Note:
The output of a generated batch is static.
Viewing an Example of HTML Web Output
The following image presents a book generated as a static HTML and launched in a browser.
The output shows a customized layout, user defined content, and navigational features. Due to
inherent limitations of an image, not all features can be shown. However an HTML book can
contain:
l
Customized page layout of header and footer. Page layout is defined in the template.css file.
See the topic Managing Book HTML Output Layout in the Oracle Hyperion Financial
Reporting Workspace Administrator's Guide
l
Table of Contents navigation with nested sections and section headings. Table of contents
properties is defined in the Book Editor. See “Editing Book Content and Design” on page
64.
l
Navigation Trail that keeps track of your location within the book.
l
Oracle Hyperion Financial Reporting reports. Reports can have additional navigation links
in the report rows and other areas of the report that link to other reports, URL, and external
websites.
l
Word document with textual content and the FRExecute function. See “FRExecute Syntax”
on page 53.
l
Microsoft Excel and PDF documents.
l
Search on the entire site, table of contents, or content only.
l
Text headings in Table of Content. See “Editing Book Content and Design” on page 64.
80
Scheduling Batches
Documents you may be interested
Documents you may be interested
