Setting Up XML Publisher

This chapter discusses how to:

Prepare to use XML Publisher.
Set Up XML Publisher.

Preparing to use XML Publisher

This section discusses how to:

Define XML Publisher global engine settings.
Assign users to XMLP roles.

Defining XML Publisher Global Engine Settings

XML Publisher Global Engine settings are defined in the xdo.cfg file. The default xdo.cfg file is located in the $PSHOME/appserver directory, which is shared by all application server and process scheduler domains by default.

The default xdo.cfg file contains the following settings:

<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">
    <properties>
        <!-- System level properties -->
        <property name="xslt-xdoparser">true</property> 
        <property name="xslt-scalable">true</property>
        <property name="system-temp-dir">CACHE</property>
        <property name="system-cachepage-size">50</property>

        <!-- PDF compression -->
        <property name="pdf-compression">true</property>

        <!-- PDF Security -->
        <!-- <property name="pdf-security">true</property> -->
        <!-- <property name="pdf-open-password">user</property> -->
        <!-- <property name="pdf-permissions-password">owner</property> -->				
    </properties>
</config>

Note. By default, system-temp-dir property is set to CACHE directory, this is relative to the active running domain. That means runtime XMLP processes will use [PS_HOME]/appserv/[domain]/CACHE directory and batch XMLP processes running under process scheduler will use [PS_HOME]/appserv/PRCS/[domain]/CACHE directory when creating temporary files. This CACHE directory is shared by all running PeopleTools processes and it set through CacheBaseDir setting in psappsrv.cfg or psprcs.cfg configuration files. If you change CacheBaseDir, you will need to change system-temp-dir to point to another valid directory. Note that temporary files created in that directory could grow very large in size depending on the size of your reports so you need to choose your "system-temp-dir" for optimum system performance.

You can also specify an application server or process scheduler domain-specific xdo.cfg file. To do this, you need to change the application server or process scheduler configuration file to update theJavaVM Options -Dxdo.ConfigFile setting. For example, to specify a separate xdo.cfg file for application server domain P8488041, change the [PS_HOME]/appserv/P8488041/psappsrv.cfg file as indicated below and put the new xdo.cfg into the [PS_HOME]/appserv/P8488041directory.

Original line in psappsrv.cfg:

JavaVM Options=-Xrs -Dxdo.ConfigFile=%PS_HOME%/appserv/xdo.cfg

New line in psappsrv.cfg:

JavaVM Options=-Xrs -Dxdo.ConfigFile==%PS_HOME%/appserv/P8488041/xdo.cfg

where P8488041 is the Application Server domain name.

If you change the content of xdo.cfg, you don't need to restart the application server or the process scheduler domain that uses it. It refreshes automatically the next time you run it. But if you change the application server or process scheduler configuration file, you need to restart the affected domain.

Additional properties can be set to further customize XML Publisher, however, the configuration file cannot control all of the existing properties. For example, some PDF security properties including pdf-security, pdf-encryption-level, and pdf-no-changing-the-document are controlled by XML Publisher at runtime.

See Oracle XML Publisher Core Components Guide, Setting Runtime Properties.

Assigning XMLP Permissions to Users

XML Publisher menu access is permission list driven and depends on permission list and role assignment. PeopleTools delivers permission list security and roles for XML Publisher report developers and XML Publisher power users.

Permission list PTPT2600 is intended for report developers. Users assigned a role with this permission list have access to all XML Publisher components, including set up capability on the advanced feature Report Definition Bursting page.

Permission list PTPT2500 is intended for power users and provides access to Query data sources for ad hoc reporting through Query Report Viewer and Query Report Scheduler. This permission list also provides access to report definitions and to the Content Library, though access to the report definition bursting information is view only.

Users assigned to other permission lists and roles, such as permission list PTPT1000, may only have access to the XML Publisher Report Repository.

This table illustrates delivered permission list security for XML Publisher:

	XMLP Report Developer (PTPT2600)	XMLP Power User (PTPT2500)	PeopleSoft User (PTPT1000)
Report Category	Yes	No	No
Design Helper	Yes	Yes	No
Data Source	Yes	No	No
Report Definition	Yes	Yes Note. Display Only access for bursting.	No
Content Library	Yes	Yes	No
Template Translations	Yes	No	No
Query Report Viewer	Yes	Yes	No
Query Report Scheduler	Yes	Yes	No
Report Repository	Yes	Yes	Yes

Setting Up XML Publisher

This section discusses how to:

Set up report categories.
Download template design helpers.

Pages Used to Set Up XML Publisher

Page Name	Object Name	Navigation	Usage
Report Category	PSXPSETUPRPTCAT	Reporting Tools, XML Publisher, Setup, Report Category	Define report categories.
Design Helper	PSXPSETUPDWNLD	Reporting Tools, XML Publisher, Setup, Design Helper	Download plug-ins to facilitate offline template design.

Setting Up Report Categories

Report Category is a required attribute on all report definitions and Content Library sub-templates. By assigning a report category, you are actually applying row level security to the data on those components.

Select Reporting Tools, XML Publisher, Setup, Report Category.

Report Category ID

Enter a report category ID to define a grouping that enables users to control who can access and edit report definitions and Content Library sub-templates.

Description

(Optional) Enter descriptive text that provides more detail about the report category.

Object Owner ID

Indicate which product, feature, or application owns this report category.

ID Type

Select an ID type of either Role or User ID to grant authorization to.

Security ID

Select the authorized editor’s security ID based on the ID type.

Description

A read only field that indicates the related display value for the security ID.

Read Only

(Optional) Select this check box to indicate that the designated ID be able to view the report definitions only under this category and not update them.

Note. The PeopleCode XML Publisher classes also respect report category settings and read-only access rights.

Working with Template Design Helpers

During template creation, a design helper facilitates the insertion of application data tag placeholders into your templates. A schema or sample data file is required for using a design helper. If you use a sample data file, you can preview your template offline during the design process.

There are two template design helpers available one for designing RTF Reports (MS Word Template Builder) and the second for PDF template which gets embedded as a JavaScript inside the pdf template itself upon uploading to PeopleTools.

Select Reporting Tools, XML Publisher, Setup, Design Helper.

This page enables users to download a plug-in for Microsoft Word to facilitate offline RTF template design. Select the link to download the tool.

See Using PDF Templates.

Report Category ID	Enter a report category ID to define a grouping that enables users to control who can access and edit report definitions and Content Library sub-templates.
Description	(Optional) Enter descriptive text that provides more detail about the report category.
Object Owner ID	Indicate which product, feature, or application owns this report category.
ID Type	Select an ID type of either Role or User ID to grant authorization to.
Security ID	Select the authorized editor’s security ID based on the ID type.
Description	A read only field that indicates the related display value for the security ID.
Read Only	(Optional) Select this check box to indicate that the designated ID be able to view the report definitions only under this category and not update them.