EPRCS Admin Guide
EPRCS Admin Guide
EPRCS Admin Guide
E94194-14
Oracle Cloud Administering Narrative Reporting,
E94194-14
Copyright © 2015, 2019, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify,
license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.
Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are
"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-
specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the
programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.
No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro
Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Documentation Accessibility
3 Overview of an Application
Learning About an Narrative Reporting Application 3-1
iii
What is an Narrative Reporting Application? 3-2
Working with Data 3-2
Reasons to Create an Application 3-4
Using the Sample or Custom Application 3-4
Creating Your Custom Application 3-4
Artifact Locking 3-5
Dimension Basics 3-6
Security 3-6
iv
Previewing a Report POV 6-9
8 Installing Samples
v
13 Granting Access
Granting Access to Report Packages 13-4
Granting Access to Folders and Third-party Documents 13-7
Granting Access to an Application 13-9
Granting Access to Dimensions 13-13
15 Performing an Audit
Creating a System Audit 15-1
Creating an Artifact or Folder Audit 15-5
16 Migrating Artifacts
Migrating Artifacts from One Environment to Another Environment 16-1
Exporting and Downloading Artifacts Using the Library 16-2
Importing Artifacts into the New Environment Using the Library 16-2
Migrating Artifacts Using the File Transfer Utility 16-3
Migrating Artifacts within the Same Environment 16-6
vi
Cloning Environments 18-5
vii
Documentation Accessibility
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.
viii
Follow us on Social Media
Follow EPM Information Development on these social media sites:
LinkedIn - http://www.linkedin.com/groups?gid=3127051&goback=.gmp_3127051
Twitter - http://twitter.com/hyperionepminfo
Facebook - http://www.facebook.com/pages/Hyperion-EPM-Info/102682103112642
See all videos on YouTube - https://www.youtube.com/oracleepminthecloud
To provide feedback on this documentation, send email to epmdoc_ww@oracle.com.
ix
1
Overview of Narrative Reporting
Related Topics
• Icons
Icons are used to define areas on the Home Page.
• Settings and Actions Menu
This menu has options to select from, based on you role.
• User Assistance
This menu is used for help on Narrative Reporting, a place to connect with other
members, the support site, and to provide feedback.
• Accessibility Settings
Use this for accessibility.
• Welcome Panel
Quickly displays your status, create, open, or take a tour.
• Conventions Used
These are the most popular icons used in Narrative Reporting.
• Roles and Permission-Based Access
Based on your roles provisioned, you have access to certain roles.
• Which Tasks Should I Do First?
Explains, to an administrator, what tasks to do.
• How Do I Get Additional Help
This explains how to obtain user assistance.
• Configuring SPF Record for Oracle Cloud Email Verification
Oracle publishes Sender Protection Framework (SPF) policy that identifies the
Oracle server IP addresses and subnets that are permitted to send cloud services
emails.
• Using Translations
This tells you the languages translated for Narrative Reporting.
• Uploading a Disclosure Management Report
You can create a Disclosure Management report or upload one to a library folder
that you have or to a folder that you have created.
Icons
Icons are used to define areas on the Home Page.
There are up to thirteen main icons accessible from the Home Page for a System
Administrator.
1-1
Chapter 1
Icons
Tasks
Displays tasks to perform such as reviewing a doclet or signing off on report
packages.
Messages
Displays notifications about actions you need to take or others took; for example,
confirmation that an export file was created.
Report Packages
Displays the list of report packages that you can access.
Books
Displays the list of books that you can access.
Reports
Opens Management Reporting.
Notes
Opens the Note Manager.
Disclosure Management
Opens the Disclosure Management user interface. From here, you can upload a
locally saved Disclosure Management to the Narrative Reporting library.
1-2
Chapter 1
Settings and Actions Menu
Library
The central repository for report packages, folders, and artifacts such as audit files as
well as an application.
Application
Used to create a sample or custom application that stores data in the Oracle Cloud for
Narrative Reporting.
Daily Maintenance
Used by administrators to set the daily maintenance time and perform backup and
restore actions.
Appearance
Used by administrators to set default display options for all users. For example, a
company logo and background logo for the Home page.
Access Control
Used by administrators to can create and manage group, where as in Narrative
Reporting, an Application Administrator can create and maintain all artifacts, such as
applications, models, dimensions, and data grants.
Academy
Displays links to videos and to the Cloud Help Center on using Narrative Reporting.
Use the Home icon in the upper right area of the Home page to return to the
Home Page.
1-3
Chapter 1
Settings and Actions Menu
Select the caret beside your user name to display the Settings and Actions menu.
Preferences
Upload a photo, set your language and time zone, set notification email addresses,
and customize other display items. See Managing User Preferences.
Downloads
Depending on your assigned roles, allows you to install the following client software:
• Sample Content – Selecting the Get Sample Content displays an information
message that upload samples has completed and the Samples folder has been
created at the Library root folder. See Install Samples.
• File Transfer Utility – Downloads a ZIP file containing a command-line utility so
you can migrate and export artifacts and perform backup and restore actions. See
Using the File Transfer Utility.
• Oracle Smart View for Office – Download the latest version of Smart View from
the Oracle Smart View for Office software download page. See Setting Up
Narrative Reporting in Smart View.
• Smart View Extension for Narrative Reporting. Allows users to perform assigned
tasks and analyze model data from within the Microsoft Office suite.
• Smart View Extension for Disclosure Management. Allows users to perform
Disclosure Management activities, including tagging, validation and instance
generation from within Microsoft Word.
• Smart View Extension for Disclosure Management Auto Tagging. Provides the
ability to perform high volume XBRL for auto tagging as part of Disclosure
Management from within Microsoft Excel.
Help
Access videos and other task-related topics in the Oracle Cloud Help Center.
1-4
Chapter 1
User Assistance
Provide Feedback
A diagnostic utility called Provide Feedback is available within your Enterprise
Performance Management cloud service. If you encounter an issue while using the
service, use the Provide Feedback utility to describe the issue and the steps to
reproduce it. See Helping Oracle Collect Diagnostic Information Using the Provide
Feedback Utility.
Oracle Support
My Oracle Support site.
About
Contains Narrative Reporting notices and version information.
Sign Out
Exits Narrative Reporting.
User Assistance
This menu is used for help on Narrative Reporting, a place to connect with other
members, the support site, and to provide feedback.
A User Assistance icon is available on certain screens. Click the icon to display
the available options.
1-5
Chapter 1
User Assistance
Help
This option displays help for Narrative Reporting.
Oracle Support
Select this option to navigate directly to the My Oracle Support site to search for
solutions, download patches and updates and create a service request.
Provide Feedback
Note:
Only in User Assistance Menu.
If you encounter an issue while using the service, use the Provide Feedback option to
describe the issue and the steps to reproduce it. To expedite the resolution of issues
that you find in the service, Oracle recommends that you add multiple screenshots to
your feedback submissions. Adding a succession of screenshots that show your
progress through a task enables you to create a storyboard that shows Oracle how to
recreate your issue.
Each time a user submits feedback to Oracle, a feedback notification, a subset of the
information that a user submits using the Provide Feedback function, is sent to Service
Administrators and to the user who submits the feedback. These notifications enable
Service Administrators to review submitted issues and suggest corrective actions.
Feedback notification is enabled by default. Each Service Administrator can turn off
the notification by clicking the Unsubscribe link embedded in the email. See Disabling
Feedback Notification. Regardless of the subscription status, a notification is always
1-6
Chapter 1
Accessibility Settings
sent to the user who submits the feedback. Before providing feedback, ensure that you
are at the stage in the process when the problem was observed.
Note:
Using this option to provide feedback sends your submission to Oracle but
does not create a service request. If a Service Administrator cannot resolve
the issue, then you can create a service request using the information that
you submit.
1. From any page, select Send Diagnostics To Oracle.
2. In Feedback, describe the issue that you encountered.
3. Optional: Select an option to highlight or darken areas of the screen in
the next two steps:
a. Select Highlight, and then click and drag on the screen to highlight
portions of the screen, for example, to highlight errors or issues.
b. Select Darken, and then click and drag on the screen to hide
portions of the screen. Use this option to hide sensitive data in the
screenshot.
Accessibility Settings
Use this for accessibility.
To access accessibility settings, click the Accessibility icon at the upper right of
the Home page.
1-7
Chapter 1
Welcome Panel
• Screen Reader Mode – Enables a screen reader to read the text on the screen.
• High contrast – Sharpens screen contrast.
Note: To increase the font size, use your browser settings.
Welcome Panel
Quickly displays your status, create, open, or take a tour.
The Welcome Panel gives you access to key areas while you use Narrative Reporting
and helps you see your pending workload at a glance. Click the arrow to access each
option.
1-8
Chapter 1
Welcome Panel
Incomplete Tasks
Shows the number of assigned tasks that have not been completed yet.
New Messages
Displays the number of unread messages.
Flagged Messages
Displays the number of flagged messages.
Create
Depending on your permissions, lets you create a report, book, report package or
system audit file.
Open
Opens the recently used list.
Tour
Takes you to the Oracle Cloud Help Center to access videos and documentation.
Messages
When you select Messages from either the Welcome Panel or the Messages icon, you
will see items such as confirmation of an action or a notification that you’re assigned a
task. Click the blue text to perform the action that you need to take.
1-9
Chapter 1
Conventions Used
Tasks
You can access your incomplete tasks from the Welcome Panel or all of your tasks
(current, future, completed) from the Tasks icon. Click either the icon or the blue text
link to access additional task details.
Conventions Used
These are the most popular icons used in Narrative Reporting.
Conventions used in Narrative Reporting:
In addition, a person indicates that you can get help from either the Oracle Cloud
Help Center, Oracle Support site, or Provide Feedback. You can also access Oracle
Customer Cloud Connect, a community gathering place for members to interact and
collaborate on common goals and objectives, from this icon.
1-10
Chapter 1
Roles and Permission-Based Access
All Narrative Reporting icons have tooltips. Hover your cursor over tooltips for
information about icons.
All Users
• Learn about Narrative Reporting in Learn about Narrative Reporting.
• See which tasks you should start with in Which Tasks Should I Do First?
• Find out about browser requirements as well as other requirements in
Prerequisites.
• Find out how to access an instance of Narrative Reporting in Accessing EPM
Cloud.
• Upload your photo, check the language and time zone, and set any other
preferences listed in Managing User Preferences.
1-11
Chapter 1
How Do I Get Additional Help
2 in Oracle Narrative Reporting, Learn about Smart View, and reading this topic,
Using the Library.
Administrators
• Learn about Narrative Reporting in Learn about Narrative Reporting.
• See which tasks you should start with in Which Tasks Should I Do First?
• Get familiar with these additional features by watching these videos: Learn
about working with applications, models, and dimensions and Learn about
Security.
• For information to help you configure Oracle’s Sender Protection Framework
(SPF) see Configuring SPF Record for Oracle Cloud Email Verification
• Set the daily maintenance time in Settings. See Setting Service Maintenance
Time.
• Create users and assign roles. See Creating Users and Assigning Roles.
• Review Known Issues on My Oracle Support where you can see if any known
issues or helpful work arounds exist for this release.
• Review Readiness Information for Narrative Reporting, where you can review
information about what’s new in each release.
• Join Customer Connect, where you can join discussions, ask questions, and share
information.
Note:
Depending on your browser, the screenshots and procedures shown may
look slightly different from what you see on screen. For example, a browse
button may be presented as "choose file" in Chrome.
1-12
Chapter 1
Using Translations
Using Translations
This tells you the languages translated for Narrative Reporting.
The following items are translated for Narrative Reporting:
• The User Interface (UI) is translated into Arabic, Danish, German, Spanish,
Finnish, French, Italian, Japanese, Korean, Dutch, Norwegian, Polish, Portuguese
(Brazilian), Russian, Swedish, Turkish, Simplified Chinese, Traditional Chinese,
and Canadian French.
• Disclosure Management is translated into Danish, German, Spanish, Finnish,
French, Italian, Japanese, Korean, Dutch, Norwegian, Polish, Portuguese
(Brazilian), Russian, Swedish, Turkish, Simplified Chinese, Traditional Chinese,
and Canadian French.
• The overview video closed captions are translated into French, German, Italian,
Spanish, Brazilian Portuguese, Japanese, Korean, Traditional Chinese, and
Simplified Chinese.
Note:
Tutorial video closed captions are not translated.
The online Help and guides are translated into French, German, Italian, Spanish,
Brazilian Portuguese, Japanese, Korean, Traditional Chinese, and Simplified
Chinese. Additionally, theOracle Smart View for Office User's online Help and
guide is translated to Dutch. See the Oracle Cloud Help Center Translated Books
tab at Oracle Cloud Help Center.
Note:
The Sample Application and the contents are in English only.
The translated documentation covers all features up to August 28, 2017,
except for Working with Smart View for Enterprise Performance
Management Cloud which covers features up to August 7, 2017.
1-13
Chapter 1
Uploading a Disclosure Management Report
Note:
For Colombian clients, there is no integration with Narrative Reporting. You
open the regulator’s Microsoft Office Excel workbook directly in Smart View
and enter through the High Volume XBRL tab on the ribbon.
To upload a Disclosure Management report to the Narrative Reporting library for use in
Smart View:
1. From the Narrative Reporting Home page, select the Disclosure Management area
icon.
2. Select
3. From the Upload File dialog, select a Disclosure Management report to upload to a
folder in the library.
4. Go to the Smart View library and open the Disclosure Management report you
uploaded to the Narrative Reporting library.
1-14
2
Overview of Report Packages
Related Topics
• Learning About Report Packages
Report packages provide a secure, collaborative, and process driven approach for
defining, authoring, reviewing and publishing financial and management reports.
• Why Use a Report Package?
Report packages enables you manage the lifecycle of your deliverable, such as:
Gathering information, reviewing it for accuracy, and Presenting it are key to
business. Reports can be assigned to multiple authors, who each contribute
individual pieces of the report.
• What is a Report Package?
With report packages, you can structure the content of your report, assign
responsibilities to content creators and reviewers, and manage their collaboration
and workflow to produce a unified document.
• Report Package Components
A report package is made up of several components:
See these videos also Overview: Report Package Part 1 in Narrative Reporting
and
Overview: Report Package Part 2 in Narrative Reporting.
2-1
Chapter 2
What is a Report Package?
Reports can be assigned to multiple authors, who each contribute individual pieces of
the report.
Financial reporting is a critical function in most companies. Reports can be internal, for
board packages, management updates, or quarterly updates. Or they can be external,
such as statutory, regulatory, filing, or annual reports. For any report, gathering
information, reviewing it for accuracy, and presenting it are key to businesses.
Creating reports is easy with one author and no review, but having multiple authors
working on a report can be more complicated. Do all of the authors have the current
version? How do you merge changes from multiple authors into a single document?
As you add content creators, keeping everyone organized becomes more challenging.
The situation becomes even more difficult with several authors, multiple reviewers—
each of whom might be responsible for different sections, and multiple signers who
provides final sign off on the whole report. How do you keep all of your authors,
approvers, reviewers, and signers organized? How do you handle versioning and
manage workflow? Coordinating stakeholders by email can be daunting.
A better way to organize and produce a collaborative report is by using a report
package.
Report packages help you manage the lifecycle of your deliverables. With them, you
can:
2-2
Chapter 2
Report Package Components
• Assign content to multiple authors, who each contribute individual pieces of the
report
• Gather comments from multiple reviewers
• Provide an electronic sign off on the completed report
• Manage the report lifecycle by providing notifications to users, managing the
workflow, and coordinating the processes
• Combine data points with textual narrative
• Secure and control access to the report content, enabling users to see only the
content that they are permitted to see at the time that they are permitted to see it
Next, let’s look at some key components of a report package.
Doclets
A core feature of report packages is the ability to break down a report into
subcomponents called doclets. What makes up a doclet varies, depending on the type
of report that you are creating. For example, a sales report might have separate
doclets for each geographical region, and a financial disclosure might have doclets for
each of the various financial statements, tax statements, and notes.
Alternatively, if one person is responsible for all of the income statement information in
a report, for example, those income statement documents can be all classified as a
single doclet. How you define a doclet is completely up to you. See "Identifying
Doclets" in Report Package Design Considerations.
2-3
Chapter 2
Report Package Components
After you identify the doclets in a report, you assign them to authors, who provide
content. For example, in a report that breaks down revenue by categories, you can
have doclets for services, hardware, and software licenses. Then, you could assign
each doclet to the management team in charge of that category.
Supplemental Doclets
Supplemental documents such as procedures, instructions, reference material, and so
on, can be uploaded into a report package as a supplemental doclet. Supplemental
documents can be any type of document file (for example, PDF, Excel, Word, and so
on). As the content for supplemental doclets is not included within the merged report,
these doclets are excluded from the review and sign off processes. The supplemental
doclet contents cannot be viewed online, but users can download and use native
programs to open the supplemental doclet in the same way that you can work with
third party artifacts in the library.
Reference Doclets
A Reference doclet can be used as a container to store contents such as named
ranges from an Excel file or charts and graphs created from Management Reporting,
see Adding a Management Report to a Reference Doclet and consumed by one or
more regular doclets (non-supplemental).
The file content for Reference doclets is not directly included in any report package
outputs, such as preview, publish, review instances or signoff instances. However,
embedded content within a consuming doclet is displayed as part of the report
package outputs - even though the actual reference doclet is not directly merged in the
outputs. Reference doclets can participate in the author phase, but not in the review or
signoff phases.
Sections
Sections enable you to group doclets for organization, or to keep doclets together that
have a common format or are intended for a common viewership. For example, you
2-4
Chapter 2
Report Package Components
can group all financial statements in a financial disclosure report into one section.
Doing so provides a filtered view of only those doclets to the reviewers assigned to
that section.
Development Phases
Report package development occurs in three phases:
• Author phase—Compile the various report content and supporting details together
into a cohesive report package.
• Review phase—Gather commentary on multiple draft versions and revise the
report content accordingly.
• Sign Off phase—Gather electronic signatures from key constituents and secure
report contents to prevent modifications.
You decide which development phases your report requires. If the report content is
going to be provided primarily by one or two people, then you may not need an author
phase. If your report is being developed for a small group of internal stakeholders and
not a public audience, then you may not need a review phase. You can tailor the
development phases to the type of report that you need. See "Determining
Development Phases" in Report Package Design Considerations.
Lets’s look at these development phases in a little more detail.
Author Phase
2-5
Chapter 2
Report Package Components
In the author phase, authors and approvers work with doclets to add content to a
report package. Authors provide content, and approvers review and edit the content.
Benefits of the author phase include:
Content Management
Content management allows users to check doclets in and out of a central repository,
ensuring that only one user at a time is updating a doclet. It also provides for version
control. When a user checks in an updated version of a doclet, the previous version is
automatically stored. Previous versions can be easily accessed for comparison. Users
can store versions that they're still working on and can check versions in when they're
ready for others to access them.
Flexible Workflow
Workflow enables doclet content to be developed collaboratively. An author can
update the doclet, and an approver can review and edit the content. You can set up
multiple levels of approvals, and the number of approval levels can vary per doclet.
For example, a doclet containing an introductory statement may not require an
approval, and a doclet containing revenue information may require multiple approval
levels.
Using workflow, users scheduled for later in the review process can take control of a
doclet sooner. For example, if a doclet is assigned to an author, an approver or the
owner of the report package can take action on the doclet without waiting for the doclet
author. This flexibility eliminates bottlenecks and speeds up content development.
Process Reporting
Process reporting enables you to view the author phase status on two levels:
• Summary level—Provides statuses for the entire author phase, such as the
overall completion percentage of the author phase, a summary of the status of all
the doclets, and the due date and time remaining for the author phase.
• Doclet level—Provides the status for each individual doclet, the current
responsibility, and whether the doclet is checked in or out. You can also tell at a
glance the workflow level of the doclets, including the user assignments and the
due dates by user.
2-6
Chapter 2
Report Package Components
Review Phase
In the review phase, reviewers provide feedback, ask questions, and recommend
changes.
Benefits of the review phase include:
Threaded Commentary
Reviewers provide feedback by commenting on different areas of the report. These
comments are threaded so other reviewers can participate in the discussion.
Reviewers can provide attachments or links to their comments to provide supporting
details. Reviewers can close comments after the outstanding issue is addressed.
Note:
Comments persist across review cycles in context, so that reviewers can see
how comments are addressed in subsequent drafts.
Multiple Platforms
You can comment on reports in these ways:
• Desktop or mobile web browser
• Microsoft Office, through Oracle Smart View for Office
2-7
Chapter 2
Report Package Components
Process Reporting
Process reporting enables the report package owner to view the review phase status
on two levels:
• Summary level—Provides statuses for the entire review phase, such as the
overall completion percentage of the review phase, the number and percentage of
reviews completed, the number of open comments, and the due date and time
remaining for the review phase.
• Doclet level—Provides review status for each doclet, such as the reviews
completed per doclet and the number of open and closed comments raised for
each doclet.
The Sign Off phase enables you to finalize your report content and get sign off from
your key stakeholders.
Benefits of the sign off phase include:
Locked Content
In the sign off phase, you lock your report to prevent changes. The report signers
review the final report and either sign off or reject the report content. If the report is
rejected, the report package owner can unlock and correct the report content. If the
report is signed off, the process is complete, and the report is ready for publication.
Multiple Platforms
You can provide sign off in these ways:
• Desktop or mobile web browser
• Microsoft Office, through Oracle Smart View for Office
2-8
Chapter 2
Report Package Components
Process Reporting
Report package owners can view a summary of the sign off phase. The summary can
include completion percentage, number of sign offs and rejections, due date, and days
remaining, as well as who signed off and any sign off notes.
2-9
3
Overview of an Application
Related Topics
• Learning About an Narrative Reporting Application
An application is a storage container for data.
• What is an Narrative Reporting Application?
An application is a storage container for data that you want to centrally store in the
Cloud.
• Working with Data
To work with data in the Cloud, you need to set up an application, model, and
dimensions and then load your data.
• Reasons to Create an Application
There are two main reasons to create an application.
• Using the Sample or Custom Application
You can have only one application per environment (for example, one in Test and
one in Production) and have a choice between creating a sample or custom
application.
• Creating Your Custom Application
Before you begin to create your custom application, determine what type of
application you need to create by knowing what data you need to work with, where
that data resides now, what dimensions you need to include, and the formatting
necessary for load.
• Artifact Locking
To prevent concurrent editing of application and model artifacts, simultaneous
operations on the same artifact are not permitted.
• Dimension Basics
Here’s some basic information about dimensions and dimension types:
• Security
There are different levels of security in an application. At the application level, you
grant users access to the application. At the dimension level, you can grant access
to the dimensions. Security on the data level is achieved through data grants that
provide access to individual or the combinations/intersections of dimensions.
3-1
Chapter 3
What is an Narrative Reporting Application?
3-2
Chapter 3
Working with Data
You can also work with Smart View to access data in an existing on-premise
Enterprise Performance Management or Business Intelligence product such as
Planning, or Essbase as well as other Cloud services that Smart View supports such
as Planning. This method does not require an Narrative Reporting application to be set
up.
Both methods of working with data allow you to perform interactive analysis and easily
refresh updated data into a report package. See Learn About Smart View and
Example: Work with Narrative Reporting data in Smart View.
3-3
Chapter 3
Reasons to Create an Application
When you first get started, you can use the sample application to see a finished
application with its dimensional hierarchies in a model, and use Smart View to interact
with data in a doclet in a sample report package. Once you are familiar with the
sample application functionality, you can create your custom application. See Working
with the Sample Application and Creating a Custom Application.
3-4
Chapter 3
Artifact Locking
Artifact Locking
To prevent concurrent editing of application and model artifacts, simultaneous
operations on the same artifact are not permitted.
This locking feature ensures the integrity of data and the model. The lock is applied
during either a bulk operation or a dimension edit, and it is unlocked upon completion.
If another user attempts to access an artifact that has already been locked, an error
message is displayed. For example, you cannot delete a model while another user is
deploying that model.
3-5
Chapter 3
Dimension Basics
Dimension Basics
Here’s some basic information about dimensions and dimension types:
Security
There are different levels of security in an application. At the application level, you
grant users access to the application. At the dimension level, you can grant access to
3-6
Chapter 3
Security
the dimensions. Security on the data level is achieved through data grants that provide
access to individual or the combinations/intersections of dimensions.
For more information, see Learn About Security, Grant Access, and Set Up Data
Grants. See the following video as well on security Understanding Security.
3-7
4
Overview of Smart View
Related Topics
• Learning About Smart View
You can learn how to work with Oracle Smart View for Office and then try to
interact with Narrative Reporting data and report packages.
In Excel, Smart View allows you to perform ad hoc queries on Narrative Reporting
data and other EPM and BI data sources. You can easily embed data points from ad
hoc queries into your report narratives in Narrative Reporting. The data points in your
narratives are refreshable, meaning the data will always be the latest.
4-1
Chapter 4
Learning About Smart View
When you work with doclets in Word or PowerPoint, you can use Smart View to
include data from Narrative Reporting data sources and other EPM System data
sources, including on-premises and cloud data sources. For example, you can
incorporate data from a profit and loss statement in Oracle Essbase Studio and an
income statement from a Planning source. The data points for the areas that you copy
remain in Word or PowerPoint, and you can refresh the doclet to see the latest data
values.
For more information about working with Smart View in Narrative Reporting, see this
4-2
5
Overview of the Library
Related Topics
• Learning About the Library
The library is the Narrative Reporting artifact repository.
the library from this video Learning About the Narrative Reporting Library.
Users with the library administrator role can:
• Create folders and see all child folders and folder contents however, they cannot
open and view the contents of folders unless they have the appropriate
permissions.
• Create shortcuts in any folder where they have write permissions.
5-1
Chapter 5
Learning About the Library
A user with the service administrator role has the complete ability to perform any of the
actions or tasks to any artifact or folder in the library. The service administrator can
see each users My Library folder and has unrestricted access to the service. However,
they cannot see other users Favorites or Recent folders since these only contain
shortcuts.
The library provides these benefits:
Migrating
You can migrate folders, report packages, Word documents, graphic files, and
applications between environments and within them. You can migrate artifacts using
the export, download, and import functionality in the library or by using the File
Transfer Utility. See Migrate Artifacts and Use File Transfer Utility.
Auditing
An administrator of an artifact can run audit reports for their artifact. The service
administrator can run additional audit reports for the entire system. Additional
information on audits:
• Actions in the system are captured in a running system audit.
• You can extract audit entries for folders or artifacts to which you have
administrator permissions.
• An extract file is created from the running system audit that falls within the time
frame that you entered in Create Audit File and is saved in the Audit Logs folder in
the library.
For more information on audits, see Using Audits.
Built-In Intelligence
The library is role-based, and a user is either shown content that they have been given
explicit access to, or content that has been made available to them from the report
package workflow. For example, a doclet author cannot see a report package in the
library until the author phase has started. See Creating Artifacts in the Library.
5-2
Chapter 5
Learning About the Library
5-3
Chapter 5
Learning About the Library
Note:
The menus and actions available for the following are role based.
Recent
Contains shortcuts to recently accessed content. The number of recent shortcuts
retained is set in preferences, see the Library tab in Managing User Preferences. You
can inspect shortcuts, which are read only, to view artifact properties. Refresh to
update the contents. See Inspect. See the Using the Action Menus for more
information on how to access the action menus to select these options. Additional
rules for this folder are:
• Only the given user can see the shortcuts in this folder.
• The user cannot copy, move, or rename the shortcuts in this folder.
• The user can delete shortcuts in this folder.
• If the name of the artifact to which the Recent shortcut points to is changed, the
name of the shortcut is also changed.
• If the source artifact is deleted, the recent shortcut is deleted.
• The ability of the given user to access the artifact that the Recent shortcut points
to is governed by the user’s permissions on the base artifact, not the shortcut.
• The artifact properties shown in the Inspect dialog for a recent artifact are from
the source artifact.
Favorites
Contains shortcuts to artifacts marked as favorites. Includes the same options
available as the Recent folder. Additional rules for this folder are:
• Only the given user can see the shortcuts in this folder.
• The user can rename and delete shortcuts in this folder, and add or change a
description.
• The user can move a sub-folder or shortcut contained in this folder only within the
Favorites folder or its children.
5-4
Chapter 5
Learning About the Library
• The user cannot copy or move artifacts to or from outside the Favorites folder, this
includes the copy and move of shortcuts.
• The name of the favorite shortcut does not need to match the source artifact, and
if the source artifacts name changes, the name of the shortcut contained in the
Favorites does not change.
• If the source artifact is deleted, the favorite artifact is deleted.
• The artifact properties shown in the Inspect dialog for a Favorites artifact (shortcut
or folder) are from the favorites artifact.
My Library
Personal artifacts such as Excel spreadsheets, Word documents, shortcuts, and
folders. Includes the same options as the Recent and Favorites folders, plus adds
auditing. You cannot give another user access to the content in My Library. The audit
type artifact file is created in the Audit Logs folder and audit is added to the artifact
name, for example Audit — reportpackageRP1. Additional rules for this folder
are:
• Only the service administrator or given user can see the artifacts in this folder.
• You can't create report packages in the My Library folder, or move or copy report
packages to it. However, you can use shortcuts to report packages in the My
Library folder.
• Other artifacts can be copied or moved into or out-of this folder.
5-5
Chapter 5
Learning About the Library
3. Select an existing folder or create a new one using the for where you would
like to place the copied report package.
5-6
Chapter 5
Learning About the Library
Note:
If copying to an existing folder, you must have write-access to the folder
where you are placing the copied report package.
Note:
This topic also applies to other artifacts in the library you have access to,
for example reports.
3. Select an existing folder or create a new one using the for where you would
like to move the report package.
Note:
When moving to an existing folder, you must have write-access to the
folder where the report package is being moved to.
Note:
This topic also applies to other artifacts in the library you have access to,
for example reports.
5-7
Chapter 5
Learning About the Library
Note:
When selecting the option to create report packages, the Create Report
Package wizard is displayed. See Create Report Packages.
5-8
Chapter 5
Learning About the Library
For information on granting access to library artifacts, see this video Granting
Access to Library Artifacts.
Note:
The list of column names that are displayed for the View menu are
determined by artifact, folder type, and a user’s privilege.
cursor in the header title areas and selecting sort ascending or descending
icons.
Using Audits
Audits are stored in the system-generated Audit Logs folder. It contains system-
generated audits for the entire system and audit reports that were run on specific
artifacts. Audit-type extracts that can be run on library artifacts and folders by a service
administrator. An audit extract allows you to view who made changes to an artifact or
folder, when it was changed, and what was changed.
5-9
Chapter 5
Learning About the Library
5-10
Chapter 5
Learning About the Library
area, the folder is added after the system generated folders but not within. In the
content area, you can create a personal folder within any of the following folders that
have been selected in the navigation pane to help with organization:
• Favorites
• My Library
• Application
• Any personal folder that you created or can access
Depending on the folder type selected in the navigation pane, you might have more
options. For example, if the My Library folder is selected, you can inspect and audit.
Note:
For localized versions of Narrative Reporting, you should not create custom
folders spelled the same as a translated system folder. This is due to certain
implications when opening the same localized version of Narrative Reporting
in English.
Note:
Some of the following actions might not apply to system-generated personal
folders or system personal folders.
5-11
Chapter 5
Learning About the Library
• Inspect—Review or change; properties and access, and view history for a artifact
or folder. See Inspecting Folders and Artifacts .
• Delete Favorites Shortcut—Removes shortcut from Favorites folder.
• Audit—Extract results that can be used to investigate a folder.
• Add to Favorites—Allows an artifact to be displayed in the system-generated
Favorites folder.
• Export—Makes a ZIP file of a folder and its contents and saves it where you
choose.
• Import—Imports a file from library or locally.
Note:
When an artifact is selected from the content pane of the library, it
automatically opens the artifact in its native environment. For example, when
you select a report package it opens in the report center. You are prompted
to open or save third-party documents, such as XLSX files.
Report Package
When you select a report package from the Report Packages folder of the library, it
opens in the report center. The actions that you can take depends on your role and the
status of the report package. See Create Report Packages. Available actions for report
packages from the content pane:
• Edit—Edit report package in the report center.
• Inspect—View and change; properties and view access, and view the history.
• Audit—Extract audit entries for a report package. See Perform an Audit.
• Export—Makes a ZIP file of a folder and its contents and saves it where you
choose. See Migrate Artifacts.
• View in Library Folder —See the report package in its library location.
Note:
Available only when Report Packages folder is selected.
Reports
When you select a report from the Reports folder of the library, it opens the report in
Management Reporting. The actions that you can take depends on your role and the
status of the report. Some of the available actions for reports from the content pane:
• Open—Open report in Management Reporting.
5-12
Chapter 5
Learning About the Library
Note:
Available only when Reports folder is selected.
Application
When you select the application from the Application folder of the library, it opens in
the application center. The actions that you can take on the application depend on
your role and permissions. Some actions that you can take from the content pane:
• Inspect—View and change; properties and view access, and view history from the
Inspect dialog.
• Audit—Extract audit entries for a report package. See Perform an Audit.
• Export—Makes a ZIP file of a folder and its contents and saves it where you
choose, see Migrate Artifacts. .
Rules for this folder are as follows:
• Only the application artifact resides in this folder. Other child folders and artifacts
are also allowed.
• All system users can see the folder and have read access. Additional access to its
content is through access security.
• Service administrators, application administrator, and library administrator
(specifically for creating child folders) have write access to this folder.
For more information on applications and tasks, see Learn About an Narrative
Reporting Application.
5-13
Chapter 5
Learning About the Library
– Select a folder for export. You will receive a notification when the export is
complete.
– A ZIP file is created in the folder you selected for export and the filename is
prefixed with Export —.
Note:
To perform a successful folder export, the user must have administer
access to all artifacts in the folder.
• Import—used as part of the migration process to import a file either from the library
or locally, see Migrating Folders and Artifacts for more information on how to
complete this task from the library.
You can access Inspect from the navigation and content panes for folders and
artifacts. From the navigation pane, you can review and inspect the properties tab for
the following:
• System-generated personal folders:
– Recent
– Favorites
5-14
Chapter 5
Learning About the Library
– My Library
• System-generated folders:
– Audit Logs
– Report Packages
– Application
Note:
For the Application folder, you can also review the Access and
History tabs.
In Properties ,you can edit names and descriptions of personal folders and
folders that you created. You can also view properties related to a folder or artifact.
To assign or view access permissions for a folder or artifact and manage security for a
folder or artifact, use the Access tab . The Access tab is available only for folders
and artifacts that you have been given permission. For more information on the
Access tab, see Granting Access.
In History , you can view the history for a folder or an artifact. If you selected
inspect for a folder from either the navigation or content panes, the history tab displays
the results for the folder. Only administrators see history for all of the artifacts in a
folder.
5-15
6
Managing User Preferences
Manage your user badge photo, notifications, and other display items by modifying
your personal preferences.
As a user, most of the standard preferences are inherited from the browser or your
operating system and set automatically. The following optional items on the General
tab should be confirmed when you first start to use the service:
• My Photo—Photograph of user
• Locale—Language and Time Zone
• Show Confirmation Messages—Turn on or off system messages to the user
To modify settings, select Preferences from the menu beside your user name from
the Home screen. Select one of the Preferences tabs, located on the left side, to view
and modify settings. If you decide not to keep the changes, see Resetting Preferences
below.
6-1
Chapter 6
Using the General Tab
Use the Zoom control slide to size the image. Then, drag the highlighted square
area to crop the image for best display or use the
6-2
Chapter 6
Using the General Tab
• Under Locale, the default language for your browser is selected. Text, buttons,
and messages are displayed in the selected language. You can select another
language, if desired. If you do so, you must sign out and sign in again for the
language setting to take effect. Select a time zone that you want to use for
displaying time. The current date and time are displayed.
6-3
Chapter 6
Using the Notification Tab
Note:
If you do not set your language in the Preferences - General tab, then
the language displayed for the user interface is derived from your
Browser settings. For email notifications, the default language is English.
If you would like to receive notifications in a language other than English,
select the specific language from the Language drop down menu (not
Default - "Language") from the Preferences - General tab. For example,
if you want Spanish to be your default language, select Spanish from the
Language drop down menu.
The time zone you select can be different than the time zone you are in.
• Under Show Confirmation Messages, if you have turned off the feature to
display system confirmation messages, you can turn system confirmation
messages on again by selecting Show Messages.
Note:
Although you have set the Date and Time format in the Preferences –
Formatting tab, notifications that you receive may have a different format due
to internal architectural constraints.
6-4
Chapter 6
Using the Formatting Tab
6-5
Chapter 6
Using the Library Tab
Use the Format Locale menu to select default values for numbers, dates, and times for
your location. For example, the "English (United States)" locale formats the thousands
separator with a comma, the decimal separator with a period, and the date with the
three-letter abbreviation for month, followed by the day and year.
You can either change these settings manually, or you can use the Format Locale
menu to select the default values for a different locale. For example, the "Spanish
(Spain)" locale formats the thousands separator with a period, the decimal with a
comma, and the date with the day, month, and year.
The following commonly used formats are available for thousands and decimals
separators:
• Default is the value provided from your operating system.
• Comma (for example, 100,000 or 95,91).
• Period (for example, 100.000 or 95.91).
• Space (for example, 100 000 or 95 91).
• Apostrophe (for example, 100'000 or 95'91).
Similarly, for Date and Time, select the format that you want to use for display
purposes.
Note:
You can customize your time formats, using the Customize option which
presents a text box to enter a custom sequence for your unique requirements
using standard time formats.
Date formats:
• M—Month
• d—Day
• y—Year
• E—Day of the Week
Time formats:
• a—AM/PM
• h—Hour
• m—Minute
• s—Second
• z—Timezone
6-6
Chapter 6
Using the Appearance Tab
6-7
Chapter 6
Resetting Preferences
Note:
Both the Oracle logo and background image can be customized. Any logo
image smaller than 125px wide and 25px high can fit without scaling. For
large image logos, Oracle recommends you maintain a 5:1 ratio so the image
is scaled without distortion.
The default size for the background image is 1024x768. You can use a larger
background image, however the image is scaled to fit the resolution setting
of your display and the image is centered horizontally.
Resetting Preferences
To restore your preferences to the default values, select and use one of
the following options:
• Reset name of tab, in this example Reset General to undo any modifications that
were applied and restore default values on the Preferences tab.
• Reset All Tabs to Default option from any Preferences tab to reset every
preference value on all tabs of the Preference dialog box to the original default
values from initial use.
6-8
Chapter 6
Previewing a Report POV
Caution:
All changes, whether applied or not, are removed.
Note:
The default option for the Preview POV preference is disabled
6-9
Chapter 6
Previewing a Report POV
6-10
7
Uploading Additional Fonts
Oracle recommends that as an initial startup task, the service administrator uploads
the TrueType fonts that your company uses to produce reports. This will ensure the
most accurate rendering of the documents when viewing on the web.
Without these uploaded fonts, Narrative Reporting uses a font mapping utility that
attempts to properly render the report on the web. However, this mapping may
introduce variances in the report layout when displayed on the web. Therefore, we
highly recommend that you upload your TrueType fonts when you set up the service.
Note:
The system is not redefining or changing the fonts leveraged in the report,
the font mapping only applies to the document rendered on the web.
The service administrator can upload individual font files or zipped files containing
multiple TrueType fonts to the Fonts folder in the library. You can also organize your
font files by creating sub-folders in the Fonts directory.
The font file must be a TrueType font and cannot already exist in the font folder
structure. If you do upload a duplicate font, you will receive an error message
indicating the duplicate (or invalid) font file. If you uploaded multiple fonts in a zip file,
all other valid files will be loaded.
Note:
You can migrate font files like any other artifact from one environment to
another or within the same environment. You can migrate using the export,
download, and import functionality in the library. See Migrate Artifacts.
Note:
When uploading additional fonts to EPRCS, you are responsible for the
proper licensing of the fonts from the font vendor. For example, if you upload
the Microsoft font "Times New Roman," you must obtain the licensing from
Microsoft to do so. Uploading a Microsoft font sourced from a Windows
machine is not typically covered by the legal use agreement from Microsoft.
1. Locate your additional TrueType fonts. If more than one is to be uploaded, create
a zip file.
7-1
Chapter 7
Note:
Be aware that it may take some time to perform the upload depending on
the size of the font file.
7-2
Chapter 7
The zip file is unzipped, and all the uploaded fonts are automatically extracted to
the Fonts folder. These fonts are now available when displaying your documents.
Any custom fonts uploaded also appear in the font list for management reports.
See the Designing With Management Reporting for Oracle Enterprise
Performance Management Cloud and Working with Management Reporting for
Oracle Enterprise Performance Management Cloud Guides.
Note:
For PowerPoint report package types, custom fonts take effect after the
next scheduled daily maintenance. See Setting Service Maintenance
Time.
7-3
8
Installing Samples
Narrative Reporting provides samples to help you learn how to use report packages,
applications, and management reports. The samples let you view and experiment with,
report packages, management reports, a Disclosure Management report and an
application that includes a model, seven dimensions and data. You can use:
• Sample report packages , with MS Word, PowerPoint and PDF report package
types, can help users become familiar with the report package functionality and
content such as the report center, doclets, phases, embedded content and
variables, where applicable. For all three sample report packages types, phases
and user assignments have not been enabled and defined, however after
importing the sample files, a report administrator can enable phases, define dates
and assign users. To learn more how to use the sample report package, see
Working with the Sample Report Package and watch the following video: Getting
Started with Narrative Reporting Sample Report Packages.
• Sample management reports can help users become familiar with the
functionality of Management Reporting. For the snapshot reports included with the
samples, you don’t need to use an application in order to view the sample
management report, but for the non-snapshot reports, you need the Narrative
Reporting sample application deployed to edit the report and refresh data.
• Sample Books can help users become familiar with the book functionality. The
Narrative Reporting sample application will need to be deployed to edit and view
books.
Note:
The Sample Management Reporting reports and Books should be
deployed under the Samples folder. The Sample Books point to reports
in the Samples folder.
8-1
Chapter 8
with the Sample Application and Load and Extract Dimension Members for more
information.
• A sample data load file contains the data that is loaded to the sample application
and model and lets you see a layout of a data load file. See Working with the
Sample Application and Load, Extract, and Clear Data for more information.
Note:
The sample report packages, management reports, books, and Disclosure
Management report need to be imported by a user with a report administrator
role.
To work with sample files, a service administrator must install the samples from the
User Menu:
To install samples:
From the User menu on the Home Page, select Downloads, and then select Get
Sample Content.
A Samples folder is created in the library containing the following ZIP files:
• Sample Management Reports.zip used for importing sample management reports,
books, and management report snapshots.
• Sample Report Package- MS Word.zip used for importing to create the sample
report package using the MS Word Report file format.
• Sample Report Package- PPT.zip used for importing to create the sample report
package using the PowerPoint Report file format.
• Sample Report Package - PDF.zip used for importing to create the sample report
package using the PDF Report file format.
• Sample DM 10Q Report.zip used for importing to create a sample Disclosure
Management report
• Sample DM 10Q Taxonomy.zip is a sample taxonomy file used in conjunction with
the sample Disclosure Management report
• Sample application data file.zip can be downloaded and unzipped on your
local machine.
• Sample application dim load files.zip can be downloaded and unzipped on
your local machine.
Note:
The Sample Application is generated directly from the Application icon and is
not part of the sample files shown here.
8-2
Chapter 8
1. Click to create a library folder in which to store the sample report package:
For example, SampleRP:
8-3
Chapter 8
3. In Import, click Browse to select the appropriate .zip file in the Samples folder in
the library (Sample Report Package- MS Word.zip, Sample Report Package-
PDF.zip, or Sample Report Package- PPT.zip), and then choose Current Folder
to put the Sample Report Package in the folder that you created.
8-4
Chapter 8
5. Use the Inspect option in the library to assign access to the sample report
package to the users who need to learn to create and work with report packages.
Note:
Before you can assign access to the sample report package, the Identity
Domain Administrator must create users and assign roles.
See Work with the Sample Report Package. for more information.
1. Click the to create a library folder in which to store the sample management
reports:
For example, SampleMP:
2. In the new folder, under Actions, select Import.
3. In Import, click Browse to select the appropriate .zip file in the Samples folder in
the library (Sample Management Reports.zip), and then choose Current Folder to
put the Sample Management Reports in the folder that you created.
4. A message is displayed saying that an import is running in the background. To
verify a successful import, go to Messages or refresh the SampleMP folder in the
library and locate the Sample Management Report files.
5. Use the Inspect option in the library to assign access to the sample management
reports to the users who need to learn to create and work with management
reports.
Note:
Before you can assign access to the sample management reports, the
Identity Domain Administrator must create users and assign roles.
See the Designing With Management Reporting and Working with Management
Reporting for more information.
8-5
Chapter 8
2. In the Import dialog, select Local and browse to your file system location of the
"Vision 10Q Sample.zip" file. Click OK to begin the import.
8-6
Chapter 8
4. Perform a Refresh in the left panel to see the Samples folder appear. The Vision
10Q report will appear in the Samples and Disclosure Management folders.
8-7
Chapter 8
4. In the DM Explorer, double click on the Vision 10Q Sample.docx top node to
open the report.
8-8
Chapter 8
6. Browse to your file system location of the Sample DM 10Q Taxonomy.zip file and
select it.
7. Manually enter the following:
• Entry Point: visi-20190630.xsd
• Folder Name: Vision
• Taxonomy Name: visi-20190630
8-9
Chapter 8
2. Unzip sample application dim load files.zip and save the files to your
local drive. These seven dimension load files populate the sample application. You
can either use these to see the correct format since the format varies by
dimension type or experiment by adding a dimension.
8-10
Chapter 8
3. To use these files as dimension load files, access the Dimension and Models tab
in the Application icon. See Load and Extract Dimension Members for more
information.
4. If you want other users to have access to these files, you can import them into the
library and assign access to the sample application to the users who need to learn
more about working with an application by using the Access option in the
Application icon. See Grant Access for more information.
Note:
Before you can grant access to the dimension load files, the Identity
Domain Administrator must create users and assign roles.
2. If you have already generated a sample application, then this data is reflected as
part of that application.
From the Application icon, use the Load Data option on the Dimension and
Model tab to see how to format a data load file or to experiment with the
data_export.txt. See Load, Extract, and Clear Data for more information.
3. If you want other users to access these files, you can import the files into the
library and use the Access option from the Application icon to assign access to
the sample application. See Grant Access for more information.
8-11
Chapter 8
Note:
The Identity Domain Administrator must create users and assign roles
before you can grant access to the sample application.
8-12
9
Working with the Sample Report Package
Use report packages to create reports quickly and easily. Narrative Reporting includes
three sample report packages (a Word-based sample report package, a PowerPoint-
based sample report package and a PDF-based sample report package) to help you
learn to use the product. Use the sample report packages to get familiar with report
package functionality by performing these tasks:
• Navigate to the report center to learn about doclets and sections.
• Edit the report package to enable development phases, set timelines, and assign
users.
• Assign authors to doclets.
• Edit the style sample file to see how it affects the look and feel of the report.
• Work the report package through the three phases of development, from starting
the author phase to signing off on the report package.
Note:
An administrator must extract the sample report package and assign access
to you before you can view it. See Installing Samples.
9-1
Chapter 9
Sample Report Package Content
Other than the cover page and table of contents, the remaining doclets are grouped
under three sections: Finance, Metrics and References (for reference doclets)
Variables
• There are two static variables: "PeriodEnded" for a date label and "CurrentMonth",
which drives the POV in all Management Reporting reports and Oracle Smart View
for Office reference doclet queries.
• The reference variables are sourced in an Excel reference doclet, "Vision
Statements" in the Rules worksheet.
Reference Doclets and Embedded Content
There are two reference doclets in the "References" section:
Vision Statements (Excel) - the first four worksheets have Smart View ad-hoc queries
to the Narrative Reporting Sample Application and Model.
• Summary Income Statement - Smart View ad-hoc query, which drives some of the
reference variable sources in the Rules sheet.
• Rev & Gross Profit Analysis - Smart View ad-hoc query, chart is inserted as
embedded content in the "3. Finance - Revenue report" doclet.
Balance Sheet - Smart View ad-hoc query, grid is inserted as embedded content
in the "4. Finance - Consol Balancesheet" doclet.
• Metrics - Smart View ad-hoc query, grid is inserted as embedded content in the "6.
Metrics – Units" doclet.
• Rules - contains the inserted variable "CurrentMonth" which is referenced, via cell
formulas, by all four query sheets to drive the Fiscal Calendar (time period
dimension) selection (default of "Jun"). It also contains cell formula references to
the "Summary Income Statement" sheet values and Excel formulas to calculate
variance results and directional words – all of which source the seven reference
variables.
Note:
If the static variable value for "CurrentMonth" is changed, for example to
"Jul", the Vision Statement doclets needs to be downloaded, checked
out and queries refreshed, then checked back in, for the reference
variable values to be updated in the system.
Vision Management Reports ( Management Reporting report) - contains one grid and
one chart. The report POV for the "Fiscal Calendar" dimension is driven by the
"CurrentMonth" variable. Changes in the variable refreshes the report, and doclets
where its embedded content is inserted, automatically.
• Summary Income Statement - grid is inserted as embedded content in the "3.
Finance - Revenue report" doclet.
• Revenues by Segment Chart – chart is inserted as embedded content in the "6.
Metrics – Units" doclet.
Doclets
Other than the two reference doclets, there are seven doclets and one Supplemental
doclet:
9-2
Chapter 9
Sample Report Package Content
1. Cover Page – contains date label, which is driven by the "PeriodEnded" variable
2. TOC – Word-based table of contents, which is generated by EPRCS when the
report package output is generated (for example, Preview, Review Sign-off,
Publish, Download, and Distribution)
3. Finance - Revenue report – contains embedded content ("Summary Income
Statement" Management Reporting grid, "Rev & Gross Profit Analysis" Excel chart
from Vision Statement reference doclet) and variables inserted with the narrative
text ("PeriodEnded" date label and all reference variable values)
4. Finance - Consol Balancesheet – has an Excel reference file attached (Inventory
Trend.xlsx); contains embedded content ("Consol_BalSht" from Vision Statement
reference doclet and "Inventory" from Inventory Trend.xlsx reference file).
5. Finance – Notes – narrative text only, no embedded content or variables.
6. Profit by Segment template – Supplemental doclet that contains Smart View ad-
hoc query against the Narrative Reporting Sample Application/Model
7. Metrics – Units - contains embedded content ("Revenues by Segment Chart"
Management Reporting chart, "Metrics" Excel grid from Vision Statement
reference doclet), no variables
8. Metrics - Backlog and delivery - narrative text only, no embedded content or
variables
9-3
Chapter 9
Sample Report Package Content
variance results and directional words – all of which source the seven reference
variables.
Note:
If the static variable value for "CurrentMonth" is changed, for example to
"Jul", the Vision Statement doclets needs to be downloaded, checked out
and queries refreshed, then checked back in, for the reference variable
values to be updated in the system.
(Vision Management Reports Management Reporting report) - contains one grid and
one chart. The report POV for the "Fiscal Calendar" dimension is driven by the
"CurrentMonth" variable. Changes in the variable refreshes the report, and doclets
where its embedded content is inserted, automatically.
• Summary Income Statement - grid is inserted as embedded content in the "2.
Income-Analysis" doclet.
• Revenues by Segment Chart – chart is inserted as embedded content in the "5.
Metrics " doclet.
Doclets
Other than the two reference doclets, there are six doclets and one Supplemental
doclet:
1. Cover and TOC – contains date label, which is driven by the "PeriodEnded"
variable. Has an agenda-type list of bullets
2. Income Analysis – contains embedded content ("Summary Income Statement"
Management Reporting grid, "Rev & Gross Profit Analysis" Excel chart from Vision
Statement reference doclet) and variables inserted with the narrative text
("PeriodEnded" date label and all reference variable values)
3. Balance Sheet – contains embedded content ("Consol_BalSht" from Vision
Statement reference doclet)
4. Profit by Segment template – Supplemental doclet that contains a Smart View ad-
hoc query against the Narrative Reporting Sample Application/Model
5. Notes – narrative text only, no embedded content or variables.
6. Metrics - contains embedded content ("Revenues by Segment Chart"
Management Reporting chart), no variables
7. Backlog - narrative text only, no embedded content or variables.
9-4
Chapter 9
Sample Report Package Content
• There are two static variables: "PeriodEnded" for a date label and "CurrentMonth",
which drives the POV in all Management Reporting reports, Excel, and Oracle
Smart View for Office reference doclet queries, as well as the Management
Reporting report doclets.
• The reference variables are sourced in an Excel reference doclet, "Vision
Statements" in the Rules worksheet.
Reference Doclets and Embedded Content
There are two reference doclets in the "Financial References" section:
Vision Statements (Excel Reference) - the first four worksheets have Smart View ad-
hoc queries to the Narrative Reporting Sample Application and Model.
• Summary Income Statement - Smart View ad-hoc query, which drives some of the
reference variable sources in the Rules sheet.
• Rev & Gross Profit Analysis - Smart View ad-hoc query, chart is inserted as
embedded content in the "Finance Revenue report (MS Word)" doclet.
• Balance Sheet - Smart View ad-hoc query, grid is inserted as embedded content
in the "Finance - Consol Balancesheet (MS Word)" doclet.
• Metrics - Smart View ad-hoc query, not used in any doclets
• Rules - contains the inserted variable "CurrentMonth" which is referenced, through
cell formulas, by all four query sheets to drive the Fiscal Calendar (time period
dimension) selection (default of "Jun"). It also contains cell formula references to
the "Summary Income Statement" sheet values and Excel formulas to calculate
variance results and directional words – all of which source the seven reference
variables.
Note:
If the static variable value for "CurrentMonth" is changed, for example to
"Jul", the Vision Statement doclets needs to be downloaded, checked
out and queries refreshed, then checked back in, for the reference
variable values to be updated in the system.
(Vision Management Reports Management Reporting report) - contains one grid and
one chart. The report POV for the "Fiscal Calendar" dimension is driven by the
"CurrentMonth" variable. Changes in the variable refreshes the report, and doclets
where its embedded content is inserted, automatically.
• Summary Income Statement - grid is inserted as embedded content in the
3.Finance Revenue report doclet.
• Revenues by Segment Chart – chart is inserted as embedded content in the
6.Metrics units doclet.
Doclets
Other than the two reference doclets, there are seven doclets and one Supplemental
doclet:
1. Cover Page – contains date label, which is driven by the "PeriodEnded" variable.
9-5
Chapter 9
Opening the Report Package
9-6
Chapter 9
Working with the Report Center
• Click to view the report packages that you have access to.
2. Click the name of one of the sample report packages. By default, they are Sample
Report Package — MS Word ,Sample Report Package PPT and Sample
Report Package — PDF.
For more information, see Welcome to Oracle Narrative Reporting.
Doclets
Report packages are divided into subcomponents called doclets. The sample Word
report package contains seven doclets, one supplemental doclet, and two reference
doclets for you to work with:
• Cover page
• Table of contents
• Finance — Revenue report
• Finance — Consol Balancesheet
• Finance — Notes
• Profit by Segment Template (supplemental doclet)
• Metrics — Units
• Metrics — Backlog and delivery
• Vision Statements (Excel reference doclet)
• Vision Management Reports (Management Reporting reference doclet)
9-7
Chapter 9
Editing Report Packages
Sections
Sections group and organize doclets. The sample Word report package contains two
sections for you to work with:
• Finance
• Metrics
Toolbar
• Click to close the report center and return to the home screen.
9-8
Chapter 9
Editing Report Packages
In Enter Properties, you can edit the name of the sample report package and change
its location in the library. You can also upload a new style sample document. See
Working with the Style Sample Document.
Author
Collaborate to develop the report content and supporting details.
Review
Gather comments on multiple draft versions and to revise the report content.
Sign Off
Lock report content and gather sign offs from key constituents.
To enable a phase, click the check mark in the corner of the phase:
9-9
Chapter 9
Editing Report Packages
Click to select the start and end dates for the phases. You can also include doclet
approvals in the author phase and additional review cycles in the review phase. See
"Creating the Report Package Structure" in Create Report Packages.
After you enable each phase and set the timelines, click to continue.
Note:
You do not need to assign authors to all doclets (for example, the report
package owner can author doclet content). If you enable the Author phase
on the report package level, you can specify individual doclets that do not
participate in the author phase by selecting next to the doclet, then Edit
Doclet Properties, and then selecting Exclude from Author Phase.
Assigning Users
Use the Assign Users screen to grant permissions to report package owners,
reviewers, signers, and viewers.
To grant permission to a user:
9-10
Chapter 9
Editing Report Packages
Note:
If you enabled the sign off phase, you must select at least one signer
before you can close the edit wizard.
b. Select the name in the search result, and then click to close the
Select User dialog box.
After you finish assigning users, click to save your changes, close the
wizard, and return to the report center.
Note:
When you return to the report center, an error message says that there are
doclets that do not have authors assigned to them. See Editing Report
Packages
1. Select next to the doclet that you want to assign an author to, and then select
Edit Doclet Properties.
9-11
Chapter 9
Editing Report Packages
2. In Doclet Properties, edit the name and description if desired, and then select the
permission that you want to grant.
Tip:
If the Approvers permission is not displayed, you didn’t enable doclet
approval for the report package. Close the Doclet Properties screen and
edit the report package properties to enable doclet approval. See
"Adding Doclets" in Create Report Packages.
b. Select the name in the search result, and then click to close Select
User.
5. When you have finished assigning authors and approvers to the doclet, click
9-12
Chapter 9
Working with the Style Sample Document
To get an idea of the style sample functionality, click the Preview tab on the left
side of the report center to preview the entire report. You can also preview an
individual doclet and section. Scroll through the report to look at a few sample pages
or click :Show Thumbnail to display thumbnails for the report or doclet.
9-13
Chapter 9
Working with the Style Sample Document
9-14
Chapter 9
Working with the Style Sample Document
Tip:
9-15
Chapter 9
Working with the Style Sample Document
3. Perform an action:
• Select Save File, download the style sample file to your local drive, and then
open the file in Microsoft Word.
• Select Open With, and leave the default selection of Microsoft Word.
The style sample file 0.Style Sheet.docx is displayed in Word.
9-16
Chapter 9
Working with the Style Sample Document
Note:
The system displays a warning message that the new style sample will
be applied to all of the doclets, and asks if you want to continue. Click
Yes.
4. Click to save your changes, close the wizard, and return to the report
center.
Notice that the DRAFT watermark is now displayed on all of the doclets. You can edit
the style sample document to make further changes to the report package. You can
also override the style sample document at the doclet level if you do not want the style
sample applied to that doclet.
9-17
Chapter 9
Working with Development Phases
Author Phase
The author phase allows doclet authors to add content to doclets and doclet approvers
to review and approve that content. You must start the author phase before authors
and approvers can add content to doclets. To start the author phase, select
Review Phase
In the review phase, users review content and add comments to the document. You
start a review cycle by creating a review instance and then starting the cycle.
To start a review cycle:
9-18
Chapter 9
Working with Development Phases
package are allowed. To create a sign off instance, select , and then
select Create Sign Off Instance.
After you have created the sign off instance, perform these actions to learn about the
sign off phase:
• Request sign off on the report package.
• Cancel the sign off and unlock the report package for additional edits.
• Reject the sign off (you must have the Signer permission).
• Sign off on the report package (you must have the Signer permission).
See "Managing the Sign Off Phase" in Manage Report Packages.
After you guide the report package through each development phase, you are ready to
create your own report package. Remember that you can always return to the sample
report package to experiment and become familiar with different report package
functionality. For more detailed information about the tasks and responsibilities of a
report package owner, see these topics:
• Learn About Report Packages
• Report Package Design Considerations
• Create Report Packages
• Understand Style Samples
• Manage Report Packages
9-19
10
Working with the Sample Management
Reports
After a service administrator installs the sample files and you import the sample
management reports (see Installing Samples), the following sample management
reports are available to work with:
• Sample Report 1 - contains a grid with income statement accounts in the rows
and Scenarios in the columns, with two formula columns to display the "% of Net
Sales" for each account in the row.
• Sample Report 1 Snapshot
• Sample Report 2 - contains three charts (pie, bar, and line charts) that are each
driven by grids that are part of each chart definition.
• Sample Report 2 Snapshot
• Sample Report 3 - contains a grid and a chart, where the grid has Entities in the
rows and Scenarios in the columns. The chart is driven by the displayed grid.
• Sample Report 3 Snapshot
• Sample Report 4 - contains a grid with income statement accounts in the rows,
Scenarios and Fiscal Calendar dimensions in the columns. The grid displays a
rolling report with:
– January to the currently selected month in the POV (June by default) for
Actual data.
– The Current POV + 1 (July by default) to December for Plan data.
– You can change the POV to select a different month. The columns use a
combination of the Current POV, Range and Relative Member selection
functions.
• Sample Report 4 Snapshot
• Sample Report 5 (Prompts) - contains a grid with prompts for:
– One or more Segments in the rows
– Children of the select Quarter in the columns
– One or more Entities in the POV with Printable Pages enabled.
• Sample Report 6 (Cond. Format & Suppression) – contains a grid with Entities
in the rows and Scenarios in the columns with the following applied:
– Conditional formatting on the "Act vs. Plan Var" column that colors the cell
background red, green or yellow, depending on the cell value.
– Conditional suppression on the Entity row to suppress all rows where the
value is less than 1,000,000.
• Sample Report 7 (Zoom and Drill) – contains a grid with Accounts in the rows
and Scenarios in the columns with the following Zoom and Drill definitions:
10-1
Chapter 10
Note:
The drill definitions to "Sample Report 3" require that this report
exists in the "Samples" folder. If the sample management reports are
deployed to a different folder, the drill definitions must be updated to
the new location, in order for the drill links to function properly.
• Snapshot Reports – for all the sample management reports, except "Sample
Report 5 (Prompts)". Snapshot reports contain data within the report and do not
require connectivity to the Narrative Reporting Sample Application. They are
available for preview only, as the definition of snapshot reports cannot be edited.
Note:
All the sample management reports contain:
– An image object in the header with a company logo
– Images in the header and footer with a gradient striped thick border
– A text box with text functions in the header which returns the report
description and some point of view information and report run date
– A text box with a function in the footer to return the page number
10-2
11
Working with the Sample Application
We provide a sample application with Narrative Reporting as a learning tool. Use the
sample application to:
• See what an application looks like after it is created. The sample application
includes:
– One sample model
– Seven dimensions with their members loaded
– Data loaded into the sample model
• Learn how the dimension hierarchy works
• View the proper format of dimension load files and proper format of a data load file
• View application history
• Learn how to grant access to the application to users and groups
• Learn how data grants work by creating a data grant within the sample model
• Experiment with refreshing data (from an application) in a doclet within a report
package by using Smart View
This topic shows you how to generate the sample application and guides you to topics
that help you learn about an Narrative Reporting application.
Note:
This User Interface (UI) that is displayed below is only displayed when
you have not already created an application.
11-1
Chapter 11
Experimenting with a Complete Application
11-2
Chapter 11
Experimenting with a Complete Application
2. Click the Dimensions and Models tab to see the dimensions and which models
contain each dimension. Here, only one model is pre-populated.
11-3
Chapter 11
Learning How the Dimension Hierarchy Works
You can use the sample application to experiment with adding, editing and viewing
dimensions. You can create and modify models and assign dimensions to them.
See Create a Custom Application.
11-4
Chapter 11
Viewing the Proper Format of Dimension Load and Data Load Files
See Manage Dimensions Using the Hierarchy Editor for information on how to set
various dimension properties in the Dimension Hierarchy Editor.
To learn how to create dimension load files, see Load and Extract Dimension
Members and see Load, Extract, and Clear Data to learn how to create data load files.
See Load and Extract Dimension Members to learn more about loading dimensions
and members.
11-5
Chapter 11
Viewing Application History
See Load, Extract, and Clear Data to learn more about loading data.
11-6
Chapter 11
Learning How to Set Up Data Grants
Note:
Before you can grant access, the Identity Domain Administrator must have
already created users and assigned roles.
11-7
Chapter 11
Refreshing Data in a Doclet
11-8
12
Learning About Security
In this topic, you will gain a high-level understanding of the layers of security that you
can implement in Oracle Narrative Reporting Cloud Service to ensure that each user
has the appropriate access to information and system administration. The three layers
of security:
• System Level Security
• Artifact Level Security
• Data Level Security
Levels of Security
Oracle Narrative Reporting Cloud Service security is achieved through a combination
of system level roles, corresponding artifact level permissions, and data security:
12-1
Chapter 12
Levels of Security
Service Administrators
Create and maintain all aspects of the system, except for user management
Reports Administrators
Create report packages, management reporting definitions and Disclosure
Management documents
Application Administrators
Create and maintain all application artifacts, such as applications, models,
dimensions, and data grants
Library Administrators
Create folders, including root-level folders
Users
The minimum role required to log in to and use the service, and to view artifacts to
which the user has access
12-2
Chapter 12
Levels of Security
When you see the keys in Oracle Narrative Reporting Cloud Service, you can grant
access to users, groups, or users and groups.
When you create an artifact (report package, folder, application), you automatically
have permission to edit, delete, and maintain that artifact. In addition, you can give
other users, groups, or users and groups the ability to maintain or view that artifact by
granting access to those users. Users who do not have access cannot see or access
that artifact.
The permissions you can grant on an artifact depend on the artifact. For example, you
can grant "Administer" or "View" permissions to Third-Party artifacts in a folder,
whereas you can grant "Administer", "Write", or "View" permissions on a folder in a
library. For an application, you can grant “ADMINISTER” or “USE” permissions. See
Learning About Security for details on all the permissions.
12-3
Chapter 12
Levels of Security
You can grant permissions to artifacts in the library using the concept of “inherited
permissions.” This gives you the ability to easily grant the same permissions that you
set at a parent folder to the child folder(s) and artifacts underneath it. By default,
folders are created with the Inherit Permissions box checked by default, but you can
clear it if you wish. And, you may also individually override the inherited permissions
for certain users and/or groups by directly assigning or revoking a permission. Note
that the inherited permission check box is not the default for a report package, since
granting access allows other users to view it immediately. A report package owner
usually waits until a more appropriate time in the report package lifecycle rather than
granting access at creation time.
See Granting Access for more details.
12-4
Chapter 12
Levels of Security
• On a granular level, you can create data grants to grant access to portions of data
in a model. This grant can be individual or combinations/intersections of
dimensions.
12-5
Chapter 12
Levels of Security
The rows within a data grant determine the security outcome (effective permissions).
The top row (base layer) is evaluated first. Some best practice ideas:
• Apply broad rules for the majority of cases, and then create exceptions. You can
either grant the greatest access in the base layer, or start with a restrictive base
layer and then grant greater access.
• Try to create security in the data grant in the fewest steps to simplify maintenance.
The key to creating data grants is to understand how the order of the rows affects the
effective permissions and steering clear of creating conflicting rules between rows. In
cases of conflict, the least restrictive access rules takes precedence. See Setting Up
Data Grants for more details on the rules and logic applied to creating data grants in
Oracle Narrative Reporting Cloud Service, The chapter includes sample data grants to
increase your understanding of them.
12-6
13
Granting Access
To control which users can access content within Narrative Reporting, you must grant
access to users for the following artifacts:
• Report Packages
• Folders
• Management Reporting reports
• Third-party Artifacts, such as MS Office documents, PDFs, and images
• Dimensions
• An Application (includes the application artifact, dimensions, and data grants)
Note:
Access to models and data is granted through Data Grants . See Set
Up Data Grants. For System audit logs, no access can be granted to other
users. Only the Service Administrator and the creator of the System audit log
can view them.
The access to artifacts is managed by a combination of the role assigned to the user
and the associated permission that is assigned to a user for the artifact. As a general
rule, access is managed as follows:
• The Role (such as Service Administrator, Reports Administrator, Application
Administrator, Library Administrator, and User) enables an administrative user to
create an artifact. For example, the report package owner creates the report
package, or the Library administrator creates a root level folder. See Learn About
Security for more information on security roles.
• Permission is granted to a selected user or group to maintain the specified artifact,
based on the assigned permission, such as edit, view, administer, or remove.
You assign permission to access artifacts to individual users or groups. Generally, until
access is assigned to an artifact, it is invisible to the user, with the following
exceptions:
• The Administrator who created the artifact can always see it, as long as the
administrator’s permission has not been removed.
• Depending on the artifact, some Administrator roles can see it as part of their role.
• The Service Administrator can always see everything.
As a best practice, to minimize maintenance, you can group users who have the same
access level. Permission is then assigned to the group rather than each individual
user.
13-1
Chapter 13
Types of Permission
The following types of permission may be granted on different artifact types:
users and groups. Click the check box on the Access tab of the associated
Inspect dialog box to add or remove that permission for the selected user or group.
When you hover over the selected permission, it is identified as “Direct
Permission.”
13-2
Chapter 13
You can assign both Administer and View permissions at the folder level and the
objects in the folder will inherit those permissions if Inherit permissions from parent
folder is turned on.
By default, inheritance is turned on for folders and third-party artifacts. Inheritance is
turned off by default for report packages and reports so users are granted appropriate
access to the report package and reports during the development of the report.
is displayed beside the modified permission to indicate the change. Click again to
revert to the original inherited permission, if required.
13-3
Chapter 13
Granting Access to Report Packages
Caution:
As a best practice, Report Package Owners and Viewers should be assigned
in the Report Package rather than the Library.
The report package owner can assign access to the report package, using one of the
following methods:
• When creating the report package, select and assign users, as described in
Create Report Packages.
• Through the Library, using the Inspect dialog box, as described in this document.
Available Permissions
Only Administer and View (report package viewer) permissions can be assigned
through the Library. Report package authors, approvers, and reviewers must be
assigned from the report package itself. See Create Report Packages for additional
information.
The following permissions are available for the Report Package:
• Administer—Enables the user or group to edit, delete, and import or export the
artifact to which the permission has been applied for that user or group. The
Administrator user in the Report Package is displayed in the Library and the
Access tab with direct Administer permission. If you assign other users the
Administer permission on a report package, then they are also displayed as report
package owners.
• View—Enables the user or group to see the report package. The View user in the
Report Package is displayed in the Library, and from Inspect on the Access tabs of
the report package as having direct View permissions.
To grant access to report packages:
1. From the Home page, select an option to access the report package:
• Report Packages on the Home Page
• Library, and then Report Packages
• Library, and then Folder
Caution:
As a best practice, Report Package Owners and Viewers should be
assigned in the Report Package rather than the Library.
13-4
Chapter 13
Granting Access to Report Packages
13-5
Chapter 13
Granting Access to Report Packages
• Users
• Groups
• Users and Groups
b. On the Select User dialog box, enter the first few letters for the user name in
the text box, and then click Search to populate the list of names. To
display all users and groups, enter an asterisk "*" as a wildcard in the Search
field.
c. Select the users and groups to which you want to assign access, and then
click OK.
Note:
To remove the original administrator, you must assign the
administrator permission to another user, who can then remove the
original Administrator.
The icon indicates inherited permission. When you hover over the inherited
permission, the complete path to the original artifact is displayed.
7. Click Close.
13-6
Chapter 13
Granting Access to Folders and Third-party Documents
Available Permissions
The following permissions are available for the folders and third-party content:
• Administer – Enable the user or group to read, edit and delete artifacts.
• Write – For folders only, enable the user to import third-party content or other
artifacts as a new file into the parent container or folder.
• View — Enables the user or group to see all authorized folder artifacts within the
application. The View permission may be applied directly to the artifact or inherited
from a parent folder hierarchy.
• Remove – Allows the user to delete a selected user or group from the list.
Highlight the name, and then click X to remove the name and any associated
permissions.
To grant access to folders and third-party content:
1. From the Home page, select Library.
2. In the Library, select the folder or artifact for which you want to assign access.
3. Under Actions, select Inspect, and then Access.
13-7
Chapter 13
Granting Access to Folders and Third-party Documents
Users or groups who are inheriting permissions from the parent folder are
indicated by the inheritance icon .
13-8
Chapter 13
Granting Access to an Application
• Select View to enable the user or group to see all authorized folder
artifacts within the application. The View permission may be applied
directly to the artifact, or inherited from a parent folder hierarchy.
• Select Remove to delete a user or group from the list. Highlight the name,
and then click X to remove the name and any associated permissions
immediately.
b. Optional: To inherit the same permissions that have been assigned to a
parent artifact, click Inherit permissions from parent folder. Inherited
permission is indicated by the icon . When you hover over the inherited
permission, the complete path to the original artifact is displayed
6. Click Close.
Caution:
If you apply access to the Application system folder listed under the left
column of the Library using the Inspect option without opening the
application, the associated permission is applied to the system folder and not
to the application itself.
Available Permissions
The following permissions are available for the application:
• Administer—Allows the user or group to perform the following tasks within the
application, to enable the ongoing management of all application artifacts:
– See and manage all models in the application
– Edit and delete any artifact in the application
– Import and export all application artifacts (models, dimensions, and data
grants)
– Add, edit, and remove users and groups
• Use—Allows a user to see the Application in the Library. The level of access
which the user is allowed is also governed by any additional permissions
restricting the user, such as:
– View permissions applied to any artifact
– Write permissions applied to a folder artifact
– Additional permissions applied to the model, data and metadata
13-9
Chapter 13
Granting Access to an Application
13-10
Chapter 13
Granting Access to an Application
4. From Access , click the check box under the appropriate columns, or select
Grant Permission from User or Group Actions to assign the level of access
for each user or group:
• Select Administer to enable the user or group to perform ongoing
management of all application artifacts.
• Select Use to allow a user to see the Application in the Library. The level of
access which the user is allowed is also governed by any additional
permissions restricting the user.
5. Optional: Select Remove to delete the selected user or group from the list.
Highlight the name, and then click X to remove the name and any associated
permissions:
6. Click Close.
13-11
Chapter 13
Granting Access to an Application
5. From the Access tab , assign the level of access for each user or group by
clicking the check box under the appropriate columns, or select Grant Permission
from User or Group Actions :
• Select Administer to enable the user or group to perform ongoing
management of application artifacts.
• Select Use to allow a user to see the Application in the Library. The level of
access which the user is allowed is also governed by any additional
permissions restricting the user.
13-12
Chapter 13
Granting Access to Dimensions
6. Optional: Select Remove to delete the selected user or group from the list.
Highlight the name, and then click X to remove the name and any associated
permissions.
7. Click Close.
Note:
In addition to applying access to specific dimensions through the application
as described in this document, you can also control access using data
grants:
• Create data grants that restrict which portions of a model can be accessed.
• Set Default Access when you create or modify a dimension to READ from the
Default NONE to enable all users to view but not modify the dimension.
For more information on data grants, see Set Up Data Grants.
To grant access to dimensions:
1. On the Home page, select Application, and then click the application name to
display the Application Overview.
2. From the application Overview screen, select Dimensions and Models.
13-13
Chapter 13
Granting Access to Dimensions
3. Click the name of the dimension for which you want to grant access.
4. From the Dimension Overview screen, select Access. The name of the selected
dimension is displayed at the top of the screen.
6. From the Access tab , select Administer to enable the user or group to view,
modify, or delete the dimension.
7. Optional: Select Remove to delete the selected user or group from the list.
Highlight the name, and then click X to remove the name and any associated
permissions.
8. Click Close.
13-14
14
Setting Up Data Grants
Data grants enable you to apply a level of security to the data stored in a model and to
control who can access sensitive or confidential information. You can create data
grants for dimension intersections that identify users or groups who are allowed to
access that data. At least one model must exist before you can apply a data grant.
Usually, you create data grants only for dimensions to which you need to allow or
restrict access; otherwise, you can use the Default Access to set the access for the
entire dimension. For example, in the Sample Application, you can set the Default
Access to Read for the dimensions that do not need access restriction, and then set
your specific data grants on the remaining dimensions, where Default Access is None,
to grant access as required.
Carefully constructed data grants can ease security maintenance by adapting
automatically to changes in your application, such as members being added or
dropped.
See these sections for more information:
• Understanding How Data Grants Work
• Selecting Member Functions
• Data Grants Processing and Conflict Resolution Rules
• Creating Data Grants
• Sample Data Grant
14-1
Chapter 14
Understanding How Data Grants Work
The rows are read in sequence, from the top down, and the results for each row
culminate in the effective permission for the selected data. For more information on
processing data grants, see Data Grants Processing and Conflict Resolution Rules.
Note:
In the first row of the data grant, Actual and Plan are used in a single row
because they have the same criteria. Alternatively, you can create two rows
instead; however, combining members minimizes the number of rows in the
data grant.
After the data grant is created, it is recommended that you validate the data grant. The
Validate operation checks the data grants to determine whether member names used
in the data grant are still valid. For example, if a member that was selected for a data
grant is removed from a dimension, that data grant becomes invalid. If the data grant
is not valid, an alert icon is displayed for the data grant and the data intersection row
inside the data grant. Open the data grant to see the affected model, and correct the
situation.
Caution:
The Validate operation does not automatically change any data grants.
After validating the data grant, review the assigned permissions on the Data Grants
Access screen. Select each individual user or group, and verify that the data grants
reflect the restrictions that you require. If you created multiple data grants, then
conflicting rows likely exist. The background resolution of multiple competing or
conflicting data grants may not create the final result that you expect, so you might
need to refine your data grants to ensure the proper access.
Best practice suggestions:
• Grant the broadest rules that apply to the most people in your base layer for first
row of the data grant, and then add exception rows to reduce access.
• Try to create your security model in the fewest possible steps, to ease
maintenance.
14-2
Chapter 14
Selecting Member Functions
For more details on the rules and logic applied to creating data grants in Narrative
Reporting, see Data Grants Processing and Conflict Resolution Rules.
The function icon in the Select Members dialog box is available for every member
level in the hierarchy, and offers the following member functions to select the members
to be included in a data grant:
• Member —Assign the data grant to the selected member only.
• Children—Assign the data grant to the children of the member only. The member
is not included.
• IChildren (Inclusive Children) —Assign the data grant to the target member and
its children.
• Descendants —Assign the data grant to the entire tree under the selected
member. The member is not included.
• IDescendants (Inclusive Descendants) —Assign the data grant to the target
member and the entire tree under the selected member.
• Bottom —Under the target member, include all members that have no children
(the lowest hierarchy members).
14-3
Chapter 14
Data Grants Processing and Conflict Resolution Rules
The following example shows the results for each assigned function based on the
Fiscal Year dimension in the Sample Application:
14-4
Chapter 14
Creating Data Grants
• When processing a data grant, it does not matter whether the designated user is
an individual or a group.
• If you have two different data grants for the same dimension, the least restrictive
data grant takes precedence. In cases where there are conflicting rules between
rows, the last row prevails.
2. From the Overview screen in Application, select Dimensions and Models , and
then click the name of the dimension to which you want to assign the data grant.
14-5
Chapter 14
Creating Data Grants
6. Enter a name for the new data grant, and then click Access to set the
permissions for the new data grant.
7. Under Models, select at least one model that contains the dimension for which
you want to set the data grant. The screen is activated when the model is
selected.
14-6
Chapter 14
Creating Data Grants
9. Under the dimension name (for example, Fiscal Calendar), click Select Members
to display the Select Members dialog box.
10. Under All Members, click the member name to expand the list of members to the
required level.
14-7
Chapter 14
Creating Data Grants
11. Click the function icon beside the required level of member to select the
functions for the members to be included in the data grant. The selections are
automatically moved to the Selections column. For a list of member functions, see
Selecting Member Functions.
To redisplay any members, click the previous level in the navigation.
12. Optional: On the Select Members dialog box, click Actions to select one or
more display options for the dimension and its members:
• Show Alias Instead of Name
• Show Member Counts
• Sort Alphabetically
13. Click Close.
14. Under Users, click Add to select the users and groups that you want to include in
the data grant on the Select User dialog box.
15. Optional: Under Users, click the number of users to view all selected users in a
list, or add another user.
14-8
Chapter 14
Creating Data Grants
16. Under Permission, click Select Permission to display the Permissions dialog
box, and then select the appropriate permission for the selected users:
• None – The selected user cannot view or modify the specified member for the
dimension.
• Read – The selected user can view, but not modify the specified member for
the dimension.
• Delete Permission – Click to remove the entire permission from the
Permissions table.
17. Optional: From the drop-down arrow beside each row in the data grant, select
from the available options to perform other actions for permissions for the row:
• Add Another Permission–Enables you to add another permission for the
selected row, without re-entering the member details.
• Move Up or Move Down–Moves the selected row up or down in the table
rows. Because rows are evaluated from top to bottom to determine the data
available to users and groups, you should be aware that any moves to the
rows will affect the effective permissions.
• Add Row–Use to add another row to the data grant.
• Duplicate-Use to add another row with the same criteria to the data grant.
• Delete-Use to delete the row for the data grant.
14-9
Chapter 14
Sample Data Grant
18. After all rows for the selected data grant are added, click Save, and then Close.
Caution:
The Validate operation does not automatically change any data grants.
20. From the list of users on the Data Grants Access tab , select the user or
group that is assigned to this data grant, and verify that the assigned permissions
are correct.
Although the data grant may be valid, it might not accurately represent the access
that you intended to assign. Review all data grants for the selected user or group
to refine the access and ensure only the authorized user or group can access the
required data.
14-10
Chapter 14
Sample Data Grant
2. Set the Default Access for the remaining dimensions (Accounts, Years, Currencies,
and Segments) to Read.
3. Set the access permissions for each user and dimension to Read, as follows:
14-11
Chapter 14
Sample Data Grant
When logged in as Rodney, notice how the data grant is applied in an ad-hoc query in
Smart View.
When logged in as Oceana, notice how the data grant is applied in an ad-hoc query in
Smart View.
14-12
Chapter 14
Setting Up Data Grants
14-13
15
Performing an Audit
All actions performed in the system or on artifacts and folders are tracked in a running
system audit that details who modified an artifact or folder, when it was changed, and
what was changed.
Any changes are automatically tagged with a timestamp that reflects the date and time
that the action occurred.
Two types of files can be generated for audits based on your role or permission:
• System Audit File—Only the Service Administrator can generate a System Audit
File to capture all entries between the default first timestamp (date and time) for
the system log and a selected end timestamp. The starting timestamp of the
records cannot be edited.
• Artifact or Folder Audit File—Can be generated for selected artifacts or folders by
the user who has Administer permission for the artifact or folder, or the Service
Administrator. This audit file provides an extract of the transactions, based on a
selected date range. An audit file can be created for the following system
generated and system personal folders and user created folders:
– My Library
– Report Packages
– Application
– Folders
Note:
You cannot create an audit log for the system generated Recent or Favorites
folders.
The audit logs are stored in the system-generated Audit Logs folder in the library. All
users can view the Audit Logs folder, but they can view only the audit files that they
created. Users cannot copy or move artifacts into or out of this folder. You cannot
grant access to audit logs to another user. Only the Service Administrator and the
creator of an audit log can view them.
After you create the audit files, you can download them to your local file system for
review.
15-1
Chapter 15
Creating a System Audit
Caution:
When creating the system audit file, you can choose an option to remove all
entries for the selected system audit file from the audit logs after they have
been extracted. Because the entries have been removed, the new From
timestamp for all entries changes to the first timestamp after the removed
entries. For example, if you remove all entries up to Mar 16th, the new From
timestamp becomes March 17.
• On the Welcome Panel, select Create , and then select System Audit
File.
• From the Library, select Audit Logs in the left pane, and click Create in
the right pane, and then select System Audit.
15-2
Chapter 15
Creating a System Audit
2. From the Create System Audit File dialog box, use the calendar icon to
select the To timestamp for the end of the range for the audit file.
Note:
By default, From displays the earliest timestamp in the audit log and
cannot be changed.
3. Enter the name for the audit file that will be automatically stored in the Audit Logs
folder in the Library.
4. Optional: Select Remove extracted entries from the active system audit log to
clear the entries in the audit log after the audit file has been created.
15-3
Chapter 15
Creating a System Audit
Caution:
If you remove extracted entries, the From entry in the System Audit file
changes to reflect the next timestamp. For example, if the range for the
audit extract that was removed covered the period from March 15th to
March 31st, then the new From timestamp will be April 1st.
The System Audit Log contains details for each transaction, including the
following:
• Timestamp
• User and IP Address
15-4
Chapter 15
Creating an Artifact or Folder Audit
Note:
In most instances, the IP address displayed may not be the user’s
actual IP address.
• Select Inspect to review the audit log Properties and the History for the file.
• Select Delete to remove the system audit file. A confirmation dialog box
confirms the deletion.
• Click Rename to enter a new name for the audit log file.
15-5
Chapter 15
Creating an Artifact or Folder Audit
Note:
You cannot create an audit log for the system-generated Recent or Favorites
folders.
3. From the Create Audit File dialog box, use the calendar icon to select the
From and To timestamp range for the audit file.
15-6
Chapter 15
Creating an Artifact or Folder Audit
4. Enter the name for the audit file that will be automatically stored in the Audit Logs
folder in the Library, and then click OK.
5. Click OK.
6. Click OK to dismiss the confirmation message. The audit file is created in the
background, and a notification is posted when the audit log is complete.
7. Optional: On the Home page, select Messages to verify that the audit is
complete.
15-7
Chapter 15
Creating an Artifact or Folder Audit
The System Audit Log contains details for each transaction, including the
following:
• Timestamp
• User and IP Address
Note:
In most instances, the IP address displayed may not be the user’s
actual IP address.
• Select Inspect to review the audit log Properties and the History for the file.
• Select Delete to remove the system audit file. A confirmation dialog is
displayed to confirm the deletion.
• Click Rename to enter a new name for the audit log file.
15-8
16
Migrating Artifacts
In Narrative Reporting, you can migrate folders, other artifacts such as report
packages, and an application from one environment to another, or within the same
environment. You can migrate artifacts using the export, download, and import
functionality in the library or by using the File Transfer Utility.
• Migrating Artifacts within the Same Environment
• Migrating Artifacts Using the File Transfer Utility
• Migrating Artifacts from One Environment to Another Environment
• Importing Artifacts into the New Environment Using the Library
• Exporting and Downloading Artifacts Using the Library
Note:
Importing an application in the library replaces the exiting application in the
library.
• Export the artifact from the current environment and download the export file to
your local file
• Log into the new environment where you already have activated your service
• Import the downloaded export file from your local file into the new environment
• Optionally, move data from your application by extracting from the current
environment and loading into the new environment or just reload data from the
source.
Note:
Comments and statuses in a report package are not migrated with the report
package.
16-1
Chapter 16
Exporting and Downloading Artifacts Using the Library
Note:
Oracle recommends that you use the File Transfer Utility for export if the size
of your artifacts (including folders) is larger than 256 MB.
a. For a root level folder, in the navigation pane, select the folder, then click ,
then click Export
b. For other artifacts (folder, report package, or application), in the right pane,
16-2
Chapter 16
Migrating Artifacts Using the File Transfer Utility
Note:
Some browsers have restrictions on the size of files that can be
uploaded. If the zip file size of the export file is beyond the capacity of
your browser, use the upload_file command in the File Transfer Utility.
See Using the File Transfer Utility.
Oracle recommends that you use the File Transfer Utility for import if the
size of your artifacts (including folders) is larger than 256 MB.
4. Select the menu in the upper right corner of the Library and then Import.
5. Select Local and browse to the export zip file you want to import.
6. Select Overwrite Existing Objects to replace any existing artifact with the new
imported artifact.
7. Select Include Access Permissions to include the already defined access
permissions on the imported artifact to the existing one.
8. Select OK. The import process runs in the background.
9. Check Messages to view the notification once the import is complete.
10. Check in the library folder you specified to verify that the file has been imported.
11. Optionally: If you extracted data from an application in your current environment,
you can now load the data into your new environment.
16-3
Chapter 16
Migrating Artifacts Using the File Transfer Utility
artifact_type=FolderResourceType filename=myexportfile
remotefolder=Library/myexportlocation
3. Wait for the system to return a success indicator and a Job ID. The system
performs the export in the background.
4. Optional: Enter the get_stat command with the Job ID to confirm the export is
running in the background or if it has completed. Repeat until you receive a
message showing that the background job completed executing. Enter the
get_stat command as one of the following:
a. Using an XML file: eprcsctl operation=get_stat
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
b. Example using an XML file: eprcsctl operation=get_stat
tenantid=myidentitydomain user=johndoe password=pwd
file=c:\get_stat.xml
c. Without using an XML file: eprcsctl operation=get_stat
server=<EPM server URL> tenantid=<tenantid> user=<user>
password=<password> jobid=<id of job>
d. Example without using an XML file: eprcsctl operation=get_stat
server=myserveraddress tenantid=myidentitydomain
user=johndoe password=pwd jodid=myjobid
5. Optional: Enter the get_detailed_stat command as one of the following with the
Job ID to get all the details on what occurred in processing.
a. Using an XML file: eprcsctl operation=get_detailed_stat
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
b. Example using an XML file: eprcsctl operation=get_detailed_stat
tenantid=myidentitydomain user=johndoe password=pwd
file=c:\get__detailed_stat.xml
c. Without using an XML file: eprcsctl operation=get_detailed_stat
server=<EPM server URL> tenantid=<tenantid> user=<user>
password=<password> jobid=<id of job>
d. Example without using an XML file: eprcsctl
operation=get_detailed_stat server=myserveraddress
tenantid=myidentitydomain user=johndoe password=pwd
jodid=myjobid
6. From the Home page, select Library and navigate to the path that contains the
exported .zip file and confirm that the exported .zip file is there.
7. If you are migrating artifacts to a new environment, use the download_export
command to transfer the export zip file to your local file system. If you are not
moving artifacts to a new environment, you can skip this step. Enter the
download_export command as one of the following:
a. Using an XML file: eprcsctl operation=download_export
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
b. Example using an XML file: eprcsctl operation=download_export
tenantid=myidentitydomain user=johndoe password=pwd
file=c:\download_export.xml
16-4
Chapter 16
Migrating Artifacts Using the File Transfer Utility
16-5
Chapter 16
Migrating Artifacts within the Same Environment
a. For a root level folder, in the navigation pane, select the folder, then click ,
then click Export.
b. For other artifacts (folder, report package, or application), in the right pane,
7. Select the menu in the upper right corner of the Library and then select
Import.
8. Select Library and browse to the export zip file you want to import.
9. Select Overwrite Existing Objects to replace any existing artifact with the new
imported artifact.
16-6
Chapter 16
Migrating Artifacts within the Same Environment
10. Select Include Access Permissions to include the already defined access
permissions on the imported artifact to the existing one. Then select OK.
11. The import process runs in the background.
12. Check Messages to view the notification once the import is complete.
13. Check in the library folder you specified to verify that the file has been imported.
16-7
17
Using the File Transfer Utility
The File Transfer Utility provides an alternate way of performing the following tasks:
migrating artifacts, performing backup and restore, data load and data extract,
uploading and downloading files.
For a list of commands you can use for the command driven File Transfer Utility, see
Using the File Transfer Utility Commands and Parameters or enter eprcsctl in a
command prompt window.
Note:
In Windows, the File Transfer Utility runs using Java and JRE is packaged
along with the utility. In Linux and UNIX, set a JAVA_HOME environment to
point to the latest 1.8 version of the JRE.
Note:
The File Transfer Utility does not work with corporate SSO (identity provider)
credentials. Because users cannot sign in using corporate credentials, the
user accounts for accessing the utility must be maintained in the service. If
you configured your subscription for SSO, you must also enable users to
sign-in with their identity domain credentials. See Enabling Sign In With
Identity Domain Credentials in Administering Oracle Cloud Identity
Management.
17-1
Chapter 17
Running the File Transfer Utility
• data_extract_template
• data_load_template
• download_dbsnapshot_template
• download_export_template
• download_file_template
• download_joboutput_template
• export_template
• get_detailed_stat_template
• get_stat_template
• import_template
• import_library_template
• upload_dbsnapshot_template
• upload_file_template
To use the File Transfer Utility with an XML file:
1. First download the .XML file by entering this command: eprcsctl
<XML_template_filename>=<path><filename>, where:
Note:
If you would just like to see the contents of a template file, you can enter
eprcsctl <XML_template_filename>. If you would like to use the
templates, Oracle recommends that you download them.
17-2
Chapter 17
Using the File Transfer Utility Commands and Parameters
2. Run the executable, eprcsctl.exe. In Linux and UNIX, run the executable using
the following command: $JAVA_HOME/bin/java –jar ./eprcsctl.exe
3. Enter a command similar to the following to specify all required parameters to
transfer file:
eprcsctl operation=upload_dbsnapshot file=restoreSnapshot.xml, where:
file=restoreSnapshot.xml = the edited XML file used to execute the command
Note:
This does not include parameters file and proxy listed above.
Additional Notes
General guidelines for the commands are:
• The Service Administrator can perform all functionality.
• For import and export, the entire application is considered a unit. Users cannot
import and export any child artifacts of an application. Models, data grants and
dimensions are examples of child artifacts that cannot be imported or exported.
However, you can load and extract dimensions from the Applications area, under
Dimensions and Models.
• Application import and export does not include model data. Model data is
separately managed using data_load and data_extract commands.
17-3
Chapter 17
Listing of Commands
Listing of Commands
The following is a list of commands that can be used with the File Transfer Utility.
• data_extract
• data_load
• download_dbsnapshot
• download_export
• download_file
• download_joboutput
• export
• get_detailed_stat
• get_stat
• import
• import_library
• upload_dbsnapshot
• upload_file
data_extract
data_extract command is used to create a copy of the data within a model. It is used
in conjunction with the download_file and data_load commands.
17-4
Chapter 17
Listing of Commands
data_load
data_load command is used to fill a model with data. It is used in conjunction with the
data_extract command.
17-5
Chapter 17
Listing of Commands
download_dbsnapshot
The download_dbsnapshot command is used to transfer the backup image that occurs
nightly at the Settings — Daily Maintenance screen. It can be saved on local file
system for restoration at a later date. download_dbsnapshot is used in conjunction with
upload_dbsnapshot, which returns the snapshot at the next Settings — Daily
Maintenance screen.
• Command usage without an XML file: eprcsctl operation=download_dbsnapshot
localfolder=<localmachinefolder> server=<EPM server URL>
tenantid=<tenantid> user=<user> password=<password> secret=<passphrase
used for encryption>
• Command example without an XML file: eprcsctl
operation=download_dbsnapshot localfolder=c:\myfolder
server=myserveraddress tenantid=myidentitydomain user=johndoe
password=pwd secret=mypassphrase
• Command usage with an XML file: eprcsctl operation=download_dbsnapshot
localfolder=<localmachinefolder> tenantid=<tenantid> user=<user>
password=<password> secret=<passphrase used for encryption>
file=<parameter_xml_file_path>
• Command example with an XML file: eprcsctl operation=download_dbsnapshot
localfolder=c:\myfolder tenantid=myidentitydomain user=johndoe
password=pwd secret=mypassphrase file=c:\download_dbsnapshot.xml
• Additional Parameters:
Where secret: text that will be used as an encryption key which can be any text.
download_export
download_export is used to move previously exported content from the service to the
local file system. Both download_file and download_export can be used
interchangeably.
• Command usage without an XML file: eprcsctl operation=download_export
fileFullPath=<location of file in library to download>
localfolder=<local download location> server=<EPM server URL>
tenantid=<tenantid> user=<user> password=<password>
• Command example without an XML file: eprcsctl operation=download_export
fileFullPath=Library/myfolder/myfile localfolder=c:\myfolder
server=myserveraddress tenantid=myidentitydomain user=johndoe
password=pwd
• Command usage with an XML file: eprcsctl operation=download_export
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
17-6
Chapter 17
Listing of Commands
download_file
download_file is used to move general third party content from the service to the local
file system. Both download_file and download_export can be used interchangeably.
download_joboutput
download_joboutput is used in conjunction with commands that generate output and
run in the background; namely data_extract and export.
17-7
Chapter 17
Listing of Commands
export
The export command is used to move Narrative Reporting artifacts between
environments. It is used in conjunction with the import command. Only Narrative
Reporting artifacts can be exported. Third party artifacts, such as Office documents,
cannot, although third party content is included as part of the export of their parent
containers. Specifically, if a library folder is exported, all of its children are exported as
well, including third-party artifacts. Applications are exported in their entirety. Child
artifacts of Applications (Dimensions, Data Grants, Models) cannot be exported as
standalone exports.
• Command usage without an XML file: eprcsctl operation=export secret=<EPM
server URL> tenantid=<tenantid> user=<user> password=<password>
remoteFolder=<libfolder> fileName=<remotefolder> fileFullPath=<export
File Full Path> resourceType=<artifact_type>
Where resourceType: Type of the artifact such as, Folder –
FolderResourceType , Application – ApplicationResourceType, Report
Package - ReportPackageResourceType.
• Command example without an XML file: eprcsctl operation=export
server=myserveraddress tenantid=myidentitydomain user=johndoe
password=pwd fileFullPath=Library/myfolder1
resourceType=FolderResourceType filename=myexportfile
remotefolder=Library/myexportlocation
• Command usage with an XML file: eprcsctl operation=export
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
• Command example with an XML file: eprcsctl operation=export
tenantid=myidentitydomain user=johndoe password=pwd file=c:
\exportfile.xml
• Additional Parameters:
– export: Full path to the file on local machine which needs to be imported.
– remotefolder: Library folder to which file should be imported.
– fileFullPath: Full path of the File to export.
– resourceType: The type of artifact.
get_detailed_stat
get_detailed_stat provides a log of the detailed information in the user console.
Same information which is available in the status file generated in the My Library
folder.
17-8
Chapter 17
Listing of Commands
get_stat
The get_stat command is used to retrieve the existing job status of any background
process. This can include import, export, and import_library. get_stat always returns
a completed, and in process status or failed status.
• Command usage without an XML file: eprcsctl operation=get_stat
server=<EPM server URL> tenantid=<tenantid> user=<user>
password=<password> jobid=<id of job>
• Command example without an XML file: eprcsctl operation=getstat
server=myserveraddress tenantid=myidentitydomain user=johndoe
password=pwd jodid=myjobid
• Command usage with an XML file: eprcsctl operation=getstat
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
• Command example with an XML file: eprcsctl operation=getstat
tenantid=myidentitydomain user=johndoe password=pwd file=c:
\get_stat.xml
• Additional Parameter: jobid: id of job
import
The import command is used to import content from a local file system. It is used in
conjunction with the export command to migrate files between environments.
17-9
Chapter 17
Listing of Commands
import_library
The import_library command is used to import a previously uploaded file in the
library. It is used in conjunction with the export command to migrate files between
environments.
Note:
For import and export purposes, the entire application is considered a unit.
Users cannot import or export any child artifacts of an application. Models,
Data Grants and Dimensions are examples of child artifacts that cannot be
imported or exported. Application import and export does not include model
data. Model data is separately managed using data_load and data_extract
commands. You can specify the name of the .zip or .csv file from which
data is to be imported.
17-10
Chapter 17
Listing of Commands
– overwrite: If set to true, it will overwrite if the file exists on the server. If it is
false, then import will not happen if the file already exists on the server.
– includeAccesspermission: If set to true then permissions are imported. If set
to false, then permissions are not imported.
upload_dbsnapshot
upload_dbsnapshot uploads a previously saved maintenance snapshot. Once
uploaded, the service is returned to the state defined in that snapshot at the next
scheduled maintenance.
• Command usage without an XML file:
eprcsctl operation=upload_dbsnapshot uploadFile=<localfile>
secret=<same secret code that was used to encrypt the file at the time
of downloading> server=<EPM server URL> tenantid=<tenantid>
user=<user> password=<password>
• Command example without an XML file:
eprcsctl operation=upload_dbsnapshot uploadFile=c:\backup.tar.gz
secret=<same secret code that was used to encrypt the file at the time
of downloading> server=myserveraddress tenantid=myidentitydomain
user=johndoe password=pwd
• Command usage with an XML file: eprcsctl operation=upload_dbsnapshot
secret=<same secret code that was used to encrypt the file at the time
of downloading> tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
• Command example with an XML file: eprcsctl operation=upload_dbsnapshot
secret=<same secret code that was used to encrypt the file at the time
of downloading> tenantid=myidentitydomain user=johndoe password=pwd
file=c:\upload_dbsnapshot.xml
upload_file
The upload_file command is used to bring files into Narrative Reporting. The files are
typically third-party content, but they can also be exported Narrative Reporting artifacts
to move to the library.
• Command usage without an XML file: eprcsctl operation=upload_file
server=<EPM server URL> tenantid=<tenantid> user=<user>
password=<password> uploadfile=<filepath> remotefolder=<libfolder>
• Command example without an XML file: eprcsctl operation=upload_file
server=myserveraddress tenantid=myidentitydomain user=johndoe
password=pwd uploadfile=c:\myfile.gif remotefolder=Library/
myLibraryfolder
• Command usage with an XML file: eprcsctl operation=upload_file
tenantid=<tenantid> user=<user> password=<password>
file=<parameter_xml_file_path>
• Command example with an XML file: eprcsctl operation=upload_file
tenantid=myidentitydomain user=johndoe password=pwd file=c:
\uploadfile.xml
• Additional Parameters:
17-11
Chapter 17
Listing of Commands
– uploadfile: Full path to the file on local machine which needs to be uploaded.
– remotefolder: Library folder to which file should be uploaded.
17-12
18
Performing Backup and Restore (System
Clone)
Every day, during the operational maintenance of the service, Oracle backs up the
content of your service instance to create a complete backup snapshot of existing
artifacts and data. Backup snapshots are created for use in the event that you ever
want to restore your service to a prior known state.
Note:
Before attempting to restore your service from a backup snapshot, make
sure the destination service is the same release or newer. You cannot
restore a backup snapshot into a service that has an older release. You can
confirm release numbers by selecting the User menu from the Home page,
About, and then selecting Version.
Backup
Oracle recommends that you download the backup snapshots regularly to a local file
system, using the File Transfer Utility, so you have them available in case you wish to
restore your service to a saved, prior snapshot. See Saving Backup Snapshots.
Note:
During Daily Maintenance, the service automatically creates a backup
snapshot of data and artifacts. When Daily Maintenance executes, it
replaces the prior backup snapshot with a new backup snapshot. You should
schedule the execution File Transfer Utility on a daily basis to download the
backup snapshot to a local computer.
Restore
Restore can be done either through the Settings on the Home Page or by using the
File Transfer Utility. When you restore a backup snapshot, your system will return to
that prior state. Any changes that may have occurred subsequent to the time of the
18-1
Chapter 18
Saving Backup Snapshots
backup, will not be reflected in the restored system. You can perform the following
tasks:
• Restore using the most recent daily backup snapshot Restore Using the Most
Recent Daily Backup Snapshot.
• Restore using a saved backup snapshot from your local file system Restore Using
a Saved Backup Snapshot.
Note:
This can be only be done from the library after first uploading a snapshot
using the upload_dbsnapshot command from the File Transfer Utility.
Note:
The backup snapshots should be managed on the Service Administrator’s
local file system as part of the regular backup plan.
18-2
Chapter 18
Restore Using the Most Recent Daily Backup Snapshot
Note:
You must be a Service Administrator to access this.
Note:
The most recent snapshot from the last maintenance window is always
available.
18-3
Chapter 18
Restore Using a Saved Backup Snapshot
the administrator decides this is an emergency and is taking it offline at 11:00 am,
then the administrator should inform the user community.
Note:
A message indicates that the snapshot will be restored at the next daily
maintenance time. If you need to cancel the scheduled restore, see Cancel a
Scheduled Restore.
18-4
Chapter 18
Cloning Environments
Note:
You must be a Service Administrator to access this.
Cloning Environments
The backup and restore procedures in this topic also serve as a way to clone from one
service instance to another.
To clone environments:
1. On the source instance, download the backup snapshot as outlined in Saving
Backup Snapshots.
2. On the target instance, restore the backup snapshot that you downloaded to your
local file system. See Restore Using the Most Recent Daily Backup Snapshot or
Restore Using a Saved Backup Snapshot.
3. Verify and adjust the daily maintenance time on the target instance, if necessary.
18-5