XML Publisher Classes

This chapter provides an overview of the PeopleSoft XML Publisher classes, and discusses the following topics:

• XML Publisher terms

• Life-cycles of the XML Publisher classes

• XML Publisher classes hierarchies

• Error handling

• Data types of XML Publisher objects

• Scope of XML Publisher objects

• How to import XML Publisher classes

• How to create XML Publisher objects

• XML Publisher classes language reference

• XML Publisher classes examples

See Also

Getting Started with XML Publisher

Understanding the PeopleSoft XML Publisher and the XML Publisher Classes

The PeopleSoft XML Publisher enables you to separate the data, layout, and translation layers of a report from each other. This can improve flexibility, as well as reduce maintenance. You need to create report definitions, define templates, and so on, using the XML publisher. The XML Publisher classes enable you to access the runtime portions of the XML publishing process programmatically, that is, after the templates and reports have been created.

The XML Publisher classes are divided into the following categories:

• Report manager definition classes

• Report manager search classes

• XML generation classes

• XML Publisher engine classes

Report Manager Definition Classes

You need to create a report definition for use by the XML Publisher and associates it with a data source using the XML Publisher. You also need to create templates and associate them with a report. Then at runtime, the definitional information is called by the page viewer or processing program to and fed to the XML Publisher core engine to produce the formatted output. You can specify the runtime parameters either using the XML Publisher or the XML Publisher report manager definition classes.

See Report Manager Definition Classes Constructors.

Report Manager Search Classes

After you've published a report, it is stored in the report repository. Using the report manager search classes, you can search for a report based on defined search keys, or even add additional search keys for searching.

See Report Manager Search Classes Constructors.

XML Generation Classes

Use the XML generation classes to generate XML sample data and XML schema for rowset and PeopleSoft query data.

See XML Generation Class Constructors.

XML Publisher Engine Classes

Use the XML Publisher engine classes to directly access the Oracle XML Publiser APIs, as well as to specify page numbers and watermarks on merged PDF reports.

See XML Publisher Engine Class Constructors.

XML Publisher Terms

The following is a list of general XML publisher terms and their definitions.

Life-Cycles of the XML Publisher Classes

The following is the general flow of the XML Publisher classes, how and when they're used in the publishing process.

For most reports, you do not need to use the XML Publisher engine classes. In addition, you may or may not use the report manager search classes after a report is published.

XML Publisher classes life-cycle flow

The following is a representation of how the different classes relate to each other.

XML Publisher classes relationships

XML Publisher Classes Hierarchies

Only the report manager definition and XML Publisher engine classes have a hierarchy. The other categories of classes do not have a hierarchy, that is, you can instantiate all the objects in that class from the top level object.

Report Manager Definition Classes Hierarchy

There are many different classes used with the report manager definition classes. The following flowchart shows the different classes, and how they are interrelated.

XML Publisher classes hierarchy

XML Publisher Report Search Classes Structure

The XML Publisher report search classes are composed of a few classes. All of the classes can be instantiated from a top level object. The following is the structure of the XML Publisher report search classes:

XML Publisher report search classes structure

XML Publisher Generation Classes Structure

The XML Publisher generation classes are composed of a few classes. All of the classes can be instantiated from a top level object. The following is the structure of the XML Publisher generation classes:

XML Publisher generation classes structure

XML Publisher Engine Classes Hierarchy

The XML Publisher engine classes are composed of many different classes. Two classes, can't be instantiated from the top-level object, but instead, are instantiated from the PDFMerger class, the PageNumber and Watermark class. The following flowchart shows the different classes, and how they are interrelated.

XML Publisher engine classes hierarchy

Error Handling

The different categories of classes handle errors differently.

The report manager definition and report manager search classes methods and properties should be wrapped in a try-catch statement to handle any errors.

The general classes generally return a populated object that can be checked for a null value to determine any errors.

The XML Publisher engine class methods generally contain an error parameter as part of their signature that you can check for any errors.

See Also

Try

Data Types of XML Publisher Objects

Every XML Publisher class is its own data type, that is, report definitions are declared as data type ReportDefn, template definitions are declared as type TemplateDefn, and so on.

Scope of XML Publisher Objects

These objects can only be instantiated from PeopleCode.

An XML Publisher object can be declared of type Local, Component or Global.

How to Import the XML Publisher Classes

The XML Publisher classes are not built-in classes, like rowset, field, record, and so on. They are application classes. Before you can use these classes in your PeopleCode program, you must import them to your program.

An import statement names either all the classes in a package or one particular application class. For importing the XML Publisher classes, PeopleSoft recommends that you import all the classes in the application package.

You should only import the classes that you need to for your application.

Your import statements should look like the following:

import PSXP_RPTDEFNMANAGER:*;
import PSXP_REPORTMGR:*;
import PSXP_XMLGEN:*;
import PSXP_ENGINE:*;

Using the asterisks after the package name makes all the application classes directly contained in the named package available. Application classes contained in subpackages of the named package are not made available.

See Also

Application Classes

How to Create XML Publisher Objects

After you've imported the appropriate XML Publisher classes, you instantiate an object of one of those classes using the constructor for the class and the Create function.

The following example creates a new instance of a ReportDefn class, as the variable &rptDefn:

&rptDefn = Create ReportDefn(&rptDefnId);

Search Operator Values

Methods in the report manager definition and report search manager classes enable you to search for existing definitions. Many of the parameters for these methods should be specified in pairs, that is, a value specified with a search operator. All the search operator parameters use the same values.

The following lists the search operator values that can be used with the XML Publisher classes:

Report Manager Definition Classes Constructors

Before you can use the report manager definition classes, you must import the application package that contains them, as follows:

import PSXP_RPTDEFNMANAGER:*;

You must use the constructor for each class to instantiate an instance of that class. The following are the constructors for the report manager definition classes, in alphabetical order.

DataSourceDefn

Syntax

DataSourceDefn(DataSourceID, DataSourceType, Public)

Description

Use the DataSourceDefn constructor to instantiate a DataSourceDefn object. You must then use the Get method to initialize the object.

Parameters

Returns

A reference to a DataSourceDefn object.

See Also

DataSourceDefn Class Methods

ReportDefn

Syntax

ReportDefn(ReportId)

Description

Use the ReportDefn constructor to instantiate a ReportDefn object. You must then use the Create or Get method to initialize the object.

Parameters

Returns

A reference to a ReportDefn object.

See Also

ReportDefn Class Methods

TemplateDefn

Syntax

TemplateDefn(TemplateID)

Description

Use the TemplateDefn constructor to instantiate a TemplateDefn object. You must then use the Get method to initialize the object.

You generally don't use the constructor to instantiate a TemplateDefn object. Instead, use the GetTemplateDefn method.

Parameters

Returns

A reference to a TemplateDefn object.

See Also

TemplateDefn Class Methods

GetTemplate, GetDefaultTemplate.

TemplateFile

Syntax

TemplateFile(&TemplateDefn, EffDate)

Description

Use the TemplateFile constructor to instantiate a TemplateFile object.

You generally don't use the constructor to instantiate a TemplateFile object. Instead, use the GetTemplateFile method.

Parameters

Returns

A reference to a TemplateFile object.

See Also

GetTemplateFile, GetActiveTemplateFile.

TemplateFile Class Methods

TranslationFile

Syntax

TranslationFile(&TemplateDefn, EffectiveDate, LanguageCode)

Description

Use the TranslationFile constructor to instantiate a TranslationFile object.

You generally don't use the constructor to instantiate a TranslationFile object. Instead, use the GetTranslationFile method to access an existing translation file.

Parameters

Returns

A reference to a TranslationFile object.

See Also

GetTranslationFile

TranslationFile Class Method

DataSourceDefn Class Methods

The following are the DataSourceDefn class methods, in alphabetical order.

Get

Syntax

Get()

Description

Use the Get method to initialize the object with the existing underlying data source definition.

Parameters

None.

Returns

None.

GetData

Syntax

GetData(&PromptRecord)

Description

Use the GetData method to return the existing data file.

This method should only be used when the type of the data source is a PeopleSoft query.

If the query requires prompts, you must specify an already instantiated and populated record object that contains the values for the query prompts. Otherwise, specify a null value (" ").

Parameters

Returns

A string containing the path to the data.

See Also

GetSampleData

GetSampleData

Syntax

GetSampleData()

Description

Use the GetSampleData method to return a path to the file containing the sample data.

The file is populated when the data source is first loaded into memory. The file is then created on the application server system. The path that is returned is an absolute path name.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server returns a path with back slashes.

Parameters

None.

Returns

A string containing the path name to the file containing the sample data.

See Also

GetData

GetSchema

Syntax

GetSchema()

Description

Use the GetSchema method to return a path to the existing schema file. This method is only available for data source definitions that have PeopleSoft query defined as the type.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server returns a path with back slashes.

Parameters

None.

Returns

A string containing the path to the existing schema file.

See Also

GetData

DataSourceDefn Class Properties

The following are the DataSourceDefn class properties, in alphabetical order.

ActiveFlag

Description

This property returns the status of the data source definition. This property returns a boolean value: true if the data source definition is active, false otherwise.

This property is read-only.

Description

Description

The Description property returns the description for the data source, as a string.

This property is read-only.

IsPublic

Description

This property is only meaningful for data source definitions that are defined as PeopleSoft queries.

This property returns a boolean value: true if the data source is a public query, false if the data source is a private query.

For all other data source types, this property always returns a value of true.

This property is read-only.

LastUpdatedBy

Description

This property returns the user Id of the user who last updated the data source definition, as a string.

This property is read-only.

LastUpdateDTTM

Description

This property returns the date time of the last time the data source definition was updated, as a date time value.

This property is read-only.

Name

Description

This property specifies the name of the data source definition, as a string.

This property is read-only.

ObjectOwnerID

Description

This property returns the user Id of the user who currently owns the data source definition.

This property is read-only.

RegisteredBy

Description

This property returns the user Id of the user who originally registered the data source.

This property is read-only.

RegisteredDTTM

Description

This property returns the date time of the time when the data source was originally registered, as a date time value.

This property is read-only.

Type

Description

This property returns the type of the data source, as a string. Valid values are:

This property is read-only.

ReportDefn Class Methods

The following are the ReportDefn class methods, in alphabetical order.

DisplayOutput

Syntax

DisplayOutput()

Description

Use the DisplayOutput method to display the report generated by the ProcessReport method in a separate browser window.

You must successfully call the ProcessReport method prior to calling this method.

This method displays a single report. Therefore, the report definition must not be set for bursting.

Parameters

None.

Returns

None.

See Also

ProcessReport

Get

Syntax

Get()

Description

Use the Get method to return a reference to the existing ReportDefn object.

Parameters

None.

Returns

A reference to the newly instantiated and populated ReportDefn object.

GetActiveTemplatesByDistributionChannel

Syntax

GetActiveTemplatesByDistributionChannel(DistributionChannel, AsOfDate)

Description

Use the GetActiveTemplatesByDistributionChannel method to return an array of TemplateDefn objects for the specified distribution channel and as of date.

Parameters

Returns

An array of TemplateDefn objects.

See Also

TemplateDefn Class Methods

GetDatasource

Syntax

GetDatasource()

Description

Use the GetDatasource method to return a reference to the data source definition object registered with the report definition.

Parameters

None.

Returns

A reference to a DatasourceDefn object.

See Also

DataSourceDefn Class Methods

GetDefaultTemplate

Syntax

GetDefaultTemplate()

Description

Use the GetDefaultTemplate method to return a reference to the default template definition registered with the report definition.

Parameters

None.

Returns

A reference to a TemplateDefn object.

See Also

TemplateDefn Class Methods

GetOutDestFormatString

Syntax

GetOutDestFormatString(OutDestFormat)

Description

Use the GetOutDestFormatString method to convert the output format returned from system variable %OutDestFormat to an XML Publisher output format string that can be passed to the output type parameter of the ProcessReport method. This method is useful when processing reports generated by application engine programs that are run process scheduler.

Parameters

Returns

A string if successful. Valid values are:

• PDF

• HTM

• XLS

• RTF

See Also

ProcessReport

GetPSQueryPromptRecord

Syntax

GetPSQueryPromptRecord()

Description

Use the GetPSQueryPromptRecord method to return the runtime prompts of a query as a record object. This method should only be used when the data source type associated with the report definition is a PeopleSoft query. This method returns a null when the data source type isn't a PeopleSoft Query.

Parameters

None.

Returns

A record object populated with the query prompts if the data source definition is a PeopleSoft query, null otherwise.

See Also

SetPSQueryPromptRecord

GetTemplate

Syntax

GetTemplate(TemplateID)

Description

Use the GetTemplate method to access the specified template definition.

The template must have already been associated with the report definition.

Parameters

Returns

A reference to a TemplateDefn object.

See Also

TemplateDefn Class Methods

GetTemplateList

Syntax

GetTemplateList()

Description

Use the GetTemplateList method to return a list of templates registered with the report definition.

Parameters

None.

Returns

An array of TemplateDefn objects.

See Also

TemplateDefn Class Methods

Array Class

PrintOutput

Syntax

PrintOutput(DestPrinter)

Description

Use the PrintOutput method to print the report definition object executing the method. The ProcessReport method must be called successfully before you use this method.

Parameters

Returns

None.

ProcessEtextReport

Syntax

ProcessEtextReport(TemplateID, LanguageCd, AsOfDate)

Description

Use the ProcessEtextReport when you want to process a report that has an etext template and the report output is expected to be a string read by PeopleCode instead of a file.

For any other type of report processing, use the ProcessReport method.

Note. ProcessEtextReport does not support following: bursting, dynamic template selection, and report definitions with template type other than etext.

Before you generate the report, if you are using a data source other than a PeopleSoft query, you must specify that data source using one of the set runtime data methods, such as SetRuntimeDataRowset or SetRuntimeDataXMLFile.

Parameters

Returns

A string.

Example

/* XML Publisher sample report using XML Doc data source */

Local PSXP_RPTDEFNMANAGER:ReportDefn &oRptDefn;

/* create report definition */

&oRptDefn = create PSXP_RPTDEFNMANAGER:ReportDefn("MYREPORT");

&oRptDefn.Get();

Local XmlDoc &inXMLDoc;

Local string &strout;

&inXMLDoc = CreateXmlDoc("");

&ret = &inXMLDoc.ParseXmlFromURL("D:\temp\etext\TestEft.xml");

/*attach XMLDoc Object to Report Definition;*/

&oRptDefn.SetRuntimeDataXMLDoc(&inXMLDoc);

/* process etext report */

&strout = &oRptDefn.ProcessETextReport("", MYREPORT_AET.LANGUAGE_CD, %Date);

WriteToLog(%ApplicationLogFence_Level1, "string output from processEtextReport API " | &strout);

 

See Also

ProcessReport

ProcessReport

Syntax

ProcessReport(TemplateId, LanguageCD, AsOfDate, OutputFormat)

Description

Use the ProcessReport method to generate a report and store the information.

Before you generate the report, if you are using a data source other than a PeopleSoft query, you must specify that data source using one of the set runtime data methods, such as SetRuntimeDataRowset or SetRuntimeDataXMLFile.

After you use the ProcessReport method, you can use the Publish method to post the report, the DisplayOutput method to display the report in a browser window, or the PrintOutput method to print the report.

Use the ProcessEtextReport instead when you want to process a report that has an etext template and the report output is expected to be a string read by PeopleCode instead of a file.

Parameters

Returns

None.

See Also

DisplayOutput, PrintOutput, SetPSQueryPromptRecord, SetRuntimeDataRowset, SetRuntimeDataXMLDoc, SetRuntimeDataXMLFile, SetRuntimeProperties.

ProcessEtextReport

Publish

Syntax

Publish(ServerName, ReportPath, FolderName, ProcessInstanceId)

Description

Use the Publish method to publish the current report definition

You must have successfully completed a call to the ProcessReport method before you can use this method, either directly or by using one of the XML Publisher XML Publisher engine classes.

Parameters

Returns

None.

See Also

ProcessReport

SetPSQueryPromptRecord

Syntax

SetPSQueryPromptRecord(&Record)

Description

Use the SetPSQueryPromptRecord method to specify an already instantiated record object that contains the prompt values for the query to be used to populate the report.

This method can only be used with reports that have a PeopleSoft query defined as the data source.

You must use this method before using the ProcessReport method.

Parameters

Returns

None.

See Also

ProcessReport, GetPSQueryPromptRecord.

Query Classes

SetRuntimeDataRowset

Syntax

SetRuntimeDataRowset(&Rowset)

Description

Use the SetRuntimeDataRowset method to specify an existing rowset object as the data source for the report.

Report definitions that use a data source other than a PeopleSoft query must set that data source before generating the report using the ProcessReport method.

Parameters

Returns

None.

See Also

GetDatasource, ProcessReport, SetRuntimeDataXMLDoc, SetRuntimeDataXMLFile.

Rowset Class

SetRuntimeDataXMLDoc

Syntax

SetRuntimeDataXMLDoc(&XmlDoc)

Description

Use the SetRuntimeDataXMLDoc method to specify an existing XmlDoc object as the data source for the report.

Report definitions that use a data source other than a PeopleSoft query must set that data source before generating the report using the ProcessReport method.

Parameters

Returns

None.

See Also

GetDatasource, ProcessReport, SetRuntimeDataRowset, SetRuntimeDataXMLFile.

XmlDoc Class

SetRuntimeDataXMLFile

Syntax

SetRuntimeDataXMLFile(FilePath)

Description

Use the SetRuntimeDataXMLFile method to specify an existing file as the data source for the report.

Report definitions that use a data source other than a PeopleSoft query must set that data source before generating the report using the ProcessReport method.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server use a path with back slashes.

Parameters

Returns

None.

See Also

GetDatasource, ProcessReport, SetRuntimeDataRowset, SetRuntimeDataXMLDoc.

File Class

SetRuntimeProperties

Syntax

SetRuntimeProperties(&NameArray, &ValueArray)

Description

Use the SetRuntimeProperties method to set additional runtime values and properties required for generating this report.

Parameters

Returns

None.

Example

The following example sets extra parameters for securing a document.

&asPropName = CreateArrayRept("", 0);
&asPropValue = CreateArrayRept("", 0);            
&asPropName.Push("pdf-security");
&asPropValue.Push("true");
&asPropName.Push("pdf-open-password");
&asPropValue.Push("user1");
&asPropName.Push("pdf-permissions-password");
&asPropValue.Push("owner1");            
&oRptDefn.SetRuntimeProperties(&asPropName, &asPropValue);

See Also

ProcessReport

ReportDefn Class Properties

The following are the ReportDefn class properties, in alphabetical order.

AllowRecipientEntry

Description

Use this property to specify whether the requester can add viewers to the process scheduler distribution page when running the report. This property takes a boolean value, true if requestor can add viewers, false otherwise.

This property is read-write.

AllowViewerEntry

Description

Use the AllowViewerEntry property to specify whether the requestor can add email instructions to the process scheduler distribution page. This property takes a boolean value; true if the requestor can add the instructions, false otherwise.

This property is read-write.

ArchiveAfter

Description

Use this property to specify the number of days that the report is retained in the report repository.

This property is read-write.

BurstFieldName

Description

Use the BurstFieldName to specify the name of the field used for bursting the report when it is generated.

This property is required if you are going to burst a report. If this property has no value, the report will not be burst when it is generated.

If you are bursting a report, you also may also want to set the following properties:

• SecurityFieldName

• SecurityIDType

• SecurityJoinTable

• TemplateControlFieldName

• UseBurstValueAsOutputValueName

This property is read-write.

Considerations Using Bursting with File Layouts

In order for bursting to work with a file layout, you must place the burst field at the highest repeating level in the file structure. You must also do the following:

1. Open the file in write mode.

2. Write the following code to the file:

   &file.writeline("<?xml version='1.0'?>");

3. Close the file and open it again in append mode while processing the file layout. This ensures that:

   • The start tags (<start> </start>) are not inserted at the beginning and end of the file.

   • The first line in the file is "<?xml version='1.0'?>".

See Also

SecurityFieldName, SecurityIDType, SecurityJoinTable, UseBurstValueAsOutputFileName.

CategoryId

Description

Use the CategoryId property to specify the report category ID for the report definition.

This property is read-write.

Description

Description

Use the Description property to specify a description for the report definition.

This property is read-write.

DestinationPrinter

Description

Use the DestinationPrinter property to specify a printer for the generated report.

FolderName

Description

Use the FolderName property to specify a folder name for the generated report to be posted to.

This property is read-write.

ID

Description

Use the ID property to specify the ID for the report.

This property is read-write.

IsReadOnly

Description

This property returns a boolean value: true if the report definition is read-only to the current end user, false otherwise.

This property is read-only.

LastUpdateDTTM

Description

This property returns the last time that this report definition was updated, as a datetime.

This property is read-only.

LastUpdateOprID

Description

This property returns the last user Id of the user who updated this report definition.

This property is read-only.

ObjectOwnerID

Description

This property returns the user Id of the owner of the data source associated with the report definition.

This property is read-only.

OutDestination

Description

This property returns the output destination of the report definition, as a string.

This property is read-write.

OutDestinationType

Description

This property returns the type of device specified for the output of the report definition, as a string.

This property is read-write.

OutputEditable

Description

This property specifies whether or not the internal Adobe flag of a PDF report output file has the setting turned on to allow editing.

Note. This property should only be specified when the template type is RTF or XSL, and when generating PDF output.

This property is read-write.

RegisteredBy

Description

This property returns the name of user who originally created the report definition, as a string.

This property is read-only.

RegisteredDTTM

Description

This property returns the date time when the report definition was first created, as a date time value.

This property is read-only.

SecurityFieldName

Description

Use this property to specify the field name from the Security Join Table that stores Viewer ID. This is used with bursting.

This property is read-write.

See Also

BurstFieldName, SecurityIDType, SecurityJoinTable.

SecurityIDType

Description

Use this property to specify the type of ID that the Security Viewer ID is; either a user Id or a permission list. This is used with bursting. Valid values are:

This property is read-write.

See Also

BurstFieldName, SecurityFieldName, SecurityJoinTable.

SecurityJoinTable

Description

Use this property to specify the name of a record that stores either a user ID or permission list assigned to a data value found in the XML data for this report definition. This prompt list is filtered for records that meet this criteria. This is used for bursting reports.

This property is read-write.

See Also

BurstFieldName, SecurityFieldName, SecurityIDType.

Status

Description

This property returns the status of the report definition. This property returns a string. Valid values are:

This property is read-only.

TemplateControlFieldName

Description

Use this property to specify the name of the template control field, as a string. This field is the schema tag value from first child level of the report definition.

This property is used with bursting.

This property is read-only.

See Also

BurstFieldName

UseBurstValueAsOutputFileName

Description

Use the UseBurstValueAsOutputFileName property to specify different names for all the files that result from bursting. This property takes a boolean value: true, the report output files are named BurstValue.Extention. False is the default value.

This property is read-write.

See Also

ReportDefn class: BurstFieldName property.

TemplateDefn Class Methods

The following are the TemplateDefn class methods, in alphabetical order.

Get

Syntax

Get()

Description

Use the Get method to populate the current TemplateDefn object with an existing template definition.

Parameters

None.

Returns

None.

GetActiveTemplateFile

Syntax

GetActiveTemplateFile(AsOfDate)

Description

Use the GetActiveTemplateFile method to return a reference to the active template file specified by the as of date. If you want to access inactive template files as well, use the GetTemplateFile method instead.

Parameters

Returns

A reference to a TemplateFile object.

See Also

GetTemplate

TemplateFile Class Methods

GetTemplateFile

Syntax

GetTemplateFile()

Description

Use the GetTemplateFile method to return a reference to the associated template file object.

Parameters

None.

Returns

A TemplateFile object.

See Also

GetActiveTemplatesByDistributionChannel, GetDefaultTemplate.

TemplateFile Class Methods

GetTemplateFileList

Syntax

GetTemplateFileList()

Description

Use the GetTemplateFileList method to return a list of all the template files associated with the template definition.

Parameters

None.

Returns

An array of TemplateFile objects.

See Also

TemplateFile Class Methods

TemplateDefn Class Properties

The following are the TemplateDefn properties, in alphabetical order.

Description

Description

This property returns the description of the template definition, as a string.

This property is read-write.

DistributionChannel

Description

This property returns the name of the distribution channel associated with the template definition, as a string. Valid values are:

This property is read-write.

ID

Description

This property returns the Id of the template definition, as a string.

This property is read-only.

IsReadOnly

Description

This property returns a boolean value; true if the template definition object is read-only to the current user, false otherwise.

This property is read-only.

IsSubTemplate

Description

This property returns a boolean value: true if the template definition is a sub-template, false otherwise.

This property is read-only.

LanguageCode

Description

This property returns the language code associated with the template definition, as a string.

This property is read-only.

LastUpdateDTTM

Description

This property returns the date time of the last time the template definition was updated, as a date time value.

This property is read-only.

LastUpdateOprID

Description

This property returns the last user Id of the user who updated this template definition.

This property is read-only.

ObjectOwnerID

Description

This property returns the user Id of the owner of the data source associated with the template definition.

This property is read-only.

RegisteredBy

Description

This property returns the user Id of the user who originally registered the template definition.

This property is read-only.

RegisteredDTTM

Description

This property returns the date time of the time when the template definition was originally registered, as a date time value.

This property is read-only.

ReportCategoryID

Description

This property returns the report category Id associated with the template definition.

This property is applicable only if the template definition is a sub-template.

This property is read-only.

Type

Description

This property returns the type of template definition, as a string. Valid values are:

• ETX (Etext)

• PDF

• RTF

• XLS

This property is read-only.

TemplateFile Class Methods

The following are the TemplateFile class methods, in alphabetical order.

GetFile

Syntax

GetFile()

Description

Use the GetFile method to return a string that contains the absolute path to the file.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server use a path with back slashes.

Parameters

None.

Returns

A string.

GetMapFile

Syntax

GetMapFile()

Description

Use the GetMapFile method to return the template map file. This method returns a string containing the absolute path to the file.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server use a path with back slashes.

Note. Only use this method when the template type is PDF. Map files are only used with PDF template processing.

Parameters

None.

Returns

A string containing the path name to the file.

GetTranslationFile

Syntax

GetTranslationFile(LanguageCD)

Description

Use the GetTranslationFile method to return a reference to the specified translation file.

Parameters

Returns

A reference to a TranslationFile object.

See Also

TranslationFile Class Method

GetTranslationFileList

Syntax

GetTranslationFileList()

Description

Use the GetTranslationFileList method to return all the translation files associated with the template file.

Parameters

None.

Returns

An array of TranslationFile objects.

See Also

TranslationFile Class Method

TemplateFile Class Properties

The following describes the TemplateFile class properties, in alphabetical order.

EffectiveDate

Description

This property returns the effective date associated with the template file, as a date value.

This property is read-only.

FileName

Description

This property returns the name of the template file. The file must already exist on the application server. If you want to create the file and then return a path to it, use the GetFile method instead.

This property is read-only.

See Also

GetFile

MapFileName

Description

This property returns just the name of the map file associated with the template definition, as a string. This property is only used when the template type is PDF.

If you want to create the file and then return a path to it, use the GetMapFile method instead.

This property is read-only.

See Also

GetMapFile

Status

Description

This property returns the status of the template file. Valid values are:

This property is read-only.

TranslationFile Class Method

The following is the TranslationFile class method.

GetFile

Syntax

GetFile()

Description

Use the GetFile method to generate the file, as well as return a the path to the actual translation file.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server use a path with back slashes.

Parameters

None.

Returns

A string containing the absolute path to the file.

See Also

FileName

TranslationFile Class Properties

The following are the TranslationFile class properties, in alphabetical order.

Description

Description

This property returns the description of a translation file.

This property is read-only.

FileName

Description

This property specifies the file name of a translation file, as a string. This is just the file name, not the path to the file. This is the name that is displayed to the user.

This property is read-only.

LanguageCode

Description

Use this property to specify the language code of the translation file. This is the translated language, not the base language.

This property is read-write.

Status

Description

This property specifies the status of the translation file. Valid values are:

This property is read-only.

XMLPManager Class Methods

The following are the XMPLManager class methods, in alphabetical order.

GetDatasourceDefnList

Syntax

GetDatasourceDefnList(DataSourceId, DataSourceIdOp, DataSourceType, Owner, Descr, DescrOp, ObjectOwnerId, Active, CaseSensitive)

Description

Use the GetDatasourceDefnList method to return an array of DataSourceDefn objects.

Parameters

Returns

An array of DataSourceDefn objects.

See Also

DataSourceDefn Class Methods

Array Class

GetReportDefnList

Syntax

GetReportDefnList(ReportID,  ReportIdOp,  Descr,  DescrOp , TemplateId,  TemplateIdOp, TemplateDescr, TemplateDescrOp, DatasourceType, DataSourceId, DataSourceIdOp, DataSourceOwner, TemplateType, ReportCategoryId, ReportStatus, CaseSensitive)

Description

Use the GetReportDefnList method to return a list of all the report definitions in the system.

This method doesn't return any report definition based on a PeopleSoft query that the current user does not have access to, or any report that the current user doesn't have access to based on the report category.

Parameters

Returns

An array of ReportDefn objects.

See Also

ReportDefn Class Methods

Array Class

GetTemplateDefnList

Syntax

GetTemplateDefnList(TemplateId, TemplateIdOp, Descr, DescrOp, TemplateType, DistChannel, ReportCategoryId, IsSubtemplate, CaseSensitive)

Description

Use the GetTemplateDefnList method to return a list of template definition objects.

Parameters

Returns

An array of TemplateDefn objects.

See Also

TemplateDefn Class Methods

Report Manager Search Classes Constructors

Before you can use the report manager search classes, you must import the application package that contains them, as follows:

import PSXP_REPORTMGR:*;

You must use the constructor for each class to instantiate an instance of that class. The following are the constructors for the report manager search classes, in alphabetical order.

Report

Syntax

Report(RptId, Prcsinstance, Contentid, Dbname, RptName, RptDescr, RptURL, RptCreateDttm, RptExpireDt, FldrName)

Description

Use the report constructor to instantiate and populate a report object with the data of an already published report.

Parameters

Returns

A reference to a report object.

See Also

Report Class Properties

ReportManager

Syntax

ReportManager()

Description

Use the ReportManager constructor to instantiate an instance of the ReportManager class.

Parameters

None.

Returns

A ReportManager object.

See Also

ReportManager Class Methods

SearchAttribute

Syntax

SearchAttribute(AttrName, AttrValue, CompareOperator)

Description

Use the SearchAttribute constructor to instantiate an instance of a SearchAttribute object.

Parameters

Returns

A SearchAttribute object.

See Also

SearchAttribute Class Properties

Report Class

The report class is one of the report manager search classes. Use the report class to access individual reports that have already been published to the report repository.

Report Class Properties

The following are the report class properties, in alphabetical order.

contentId

Description

This property returns the content Id of the report, as a number.

This property is read-only.

CreatedDateTime

Description

This property returns the date time when the report was created, as a date time.

This property is read-only.

DatabaseName

Description

This property returns the data base name associated with the report, as a string.

This property is read-only.

Description

Description

This property returns the description of the report definition, as a string.

This property is read-only.

ExpireDate

Description

This property returns the date when the report will be archived, as a date value.

This property is read-only.

FileURL

Description

This property returns a URL to the actual report file in the report repository.

Use the ReportURL property to access the report detail page instead.

This property is read-only.

See Also

ReportURL

FolderName

Description

This property returns the full path name of the folder where the report is stored, as a string.

This property is read-only.

ProcessInstanceID

Description

This property returns the process instance Id associated with the report when it was posted, as a number.

This property is read-only.

See Also

ReportInstanceID

ReportInstanceID

Description

This property returns the report instance Id, that was populated when the report was run, as a number.

This property is read-only.

See Also

ProcessInstanceID

ReportName

Description

This property returns the name of the report, as a string.

This property is read-only.

ReportURL

Description

This property returns a URL as a string, that points to the report detail page.

Use the FileURL to access a URL to the actual file containing the report in the report repository.

This property is read-only.

See Also

FileURL

ReportManager Class

The ReportManager class is one of the report manager search classes. Use the ReportManager class to access set the search criteria for reports that have already been published to the report repository.

ReportManager Class Methods

The following are the ReportManager class methods, in alphabetical order.

AddSearchFieldCriteria

Syntax

AddSearchFieldCriteria(&SearchAttribute)

Description

Use the AddSearchFieldCriteria method to add an already instantiated and populated SearchAttribute object to the search.

Parameters

Returns

A boolean, true if the criteria was added successfully, false otherwise.

Example

Local PSXP_REPORTMGR:SearchAttribute &oSearch;
Local integer &compOpSrch;

&CompOpSrch = oRptMgr.PSXP_SrchBegins;

& oSearch = create PSXP_REPORTMGR:SearchAttribute (&sAttrname, &sAttrVal, &compOpSrch);

&bResult = &oRptMgr.addSearchFieldCriteria(&oSearch);

See Also

SearchAttribute Class Properties

GetReportList

Syntax

GetReportList()

Description

Use the GetReportList method to return a list of the report definition objects that satisfy all the criteria you specified with the other methods associated with the ReportManager object.

Parameters

None.

Returns

An array of ReportDefn objects.

See Also

ReportDefn Class Properties

SetBurstFieldCriteria

Syntax

SetBurstFieldCriteria(BurstFld, BurstOp, BurstValue)

Description

Use the SetBurstFieldCriteria method to specify the burst criteria to be used with searching report definitions.

Parameters

Returns

A boolean value, true if the method completes successfully, false otherwise.

See Also

BurstFieldName

SetCaseSensitive

Syntax

SetCaseSensitive(IsCaseSensitive)

Description

Use the SetCaseSensitive method to specify the case sensitivity flag applicable to search field and bursting criteria for searching reports.

Parameters

Returns

None.

SetDateCriteria

Syntax

SetDateCriteria(createdDate, createdLastVal, createdUnit)

Description

Use the SetDateCriteria method to specify the creation date criteria for searching reports.

Parameters

Returns

None.

SetFolderCriteria

Syntax

SetFolderCriteria(FolderName)

Description

Use the SetFolderCriteria method to specify the folder criteria for searching reports.

Parameters

Returns

A boolean value, true if the search criteria is added successfully, false otherwise.

SetProcessInstanceCriteria

Syntax

SetProcessInstanceCriteria(FromPID, ToPID)

Description

Use the SetProcessInstanceCriteria method to specify the process instance range criteria for searching reports.

Parameters

Returns

A boolean value: true if the search criteria is added successfully, false otherwise.

SetReportIDCriteria

Syntax

SetReportIDCriteria(ReportId)

Description

Use the SetReportIDCriteria method to specify a report Id for searching reports.

Parameters

Returns

A boolean value: true if the search criteria was set successfully, false otherwise.

SetUserIdCriteria

Syntax

SetUserIdCriteria(UserId)

Description

Use the SetUserIdCriteria method to specify a user Id to be used for searching reports intended to be accessed by that recipient.

Parameters

Returns

A boolean: true if the search criteria is set successfully, false otherwise.

SearchAttribute Class

The SearchAttribute class is one of the report manager search classes. Use the SearchAttribute class to discovery name-value pairs for the search criteria for reports that have already been published to the report repository. In addition, you can also specify a comparison operator to be used with the name-value pairs.

SearchAttribute Class Properties

The following are the properties for the SearchAttribute class, in alphabetical order.

attrName

Description

This property returns the attribute name used with search.

This property is read-only.

attrValue

Description

This property returns the attribute value used with search???

This property is read-only.

compareOp

Description

This property returns the comparison operator used with search.

This property is read-only.

XML Generation Class Constructors

Before you can use the XML generation classes, you must import the application package that contains them, as follows:

import PSXP_XMLGEN:*;

You must use the constructor for each class to instantiate an instance of that class. The following are the constructors for the report manager definition classes, in alphabetical order.

QueryDS

Syntax

QueryDS()

Description

Use the QueryDS constructor to instantiate a QueryDS object.

Parameters

None.

Returns

A reference to a QueryDS object.

See Also

QueryDS Class Methods

RowsetDS

Syntax

RowsetDS()

Description

Use the RowsetDS constructor to instantiate a RowsetDS object.

Parameters

None.

Returns

A reference to a RowsetDS object.

See Also

RowsetDS Class Methods

QueryDS Class

Use the QueryDS class to generates query schema in XSD based on the query object passed in.

QueryDS Class Methods

The following are the QueryDS class methods, in alphabetical order.

GetXMLData

Syntax

GetXMLData(&Query, &Rowset, XSDLocation)

Description

Use the GetXMLData method to create query data in XML format, based on the specified query and rowset objects.

Parameters

Returns

A string containing the generated XML data.

Example

Local PTXMLP_XMLGEN:QueryDS 
&oDS;&oDS = create PTXMLP_XMLGEN:QueryDS();

&oQuery = %Session.GetQuery();

&oQuery.Open(&sQueryName, False, False);
&recPromptRec = &oQuery.PromptRecord;
&bResult = Prompt(&sQueryName | " Prompts", "", &recPromptRec);
&oRowSet = &oQuery.RunToRowset(&recPromptRec, 0);
&sResult = &ds.getXMLData(&oQuery, &oRowSet, &strSchemaFile);

See Also

RunToRowset

GetXMLSampleData

Syntax

GetXMLSampleData(&Query, &Rowset, Rows, XSDLocation)

Description

Use the GetXMLSampleData method to create sample query data in XML from the query and rowset objects specified.

If you specify a populated rowset object, the method generates the XML from it. If you specify Null (" ") or if the rowset object is empty, the method generates random sample data.

Parameters

Returns

A string containing the generated XML data.

Example

Local PTXMLP_XMLGEN:QueryDS &oDS;

&oDS = create PTXMLP_XMLGEN:QueryDS();
&oQuery = %Session.GetQuery();
&oQuery.Open(&sQueryName, False, False);
&sResult = &oDS.getXMLSampleData(&oQuery, "", &nNumRows, &sSchemaFile);

See Also

Query Classes

GetXSDSchema

Syntax

GetXSDSchema(&Query)

Description

Use the GetXSDSchema method to create a query schema in XSD format from the specified query object.

Parameters

Returns

A string containing the generated query schema in an XSD string.

RowsetDS Class

Use the RowsetDS class to generate XSD schema and XML data from a specified rowset object.

RowsetDS Class Methods

The following are the RowsetDS class methods, in alphabetical order.

AddXMLData

Syntax

AddXMLData(&ParentNode, &Rowset)

Description

Use the AddXMLData method to add the XML data of a rowset to the specified parent node. This method can be used to combine data of multiple rowsets in a single XML.

Parameters

Returns

None.

Example

Local XmlDoc &xmlDoc;
Local XmlNode &xmlDocNode;
Local PSXP_XMLGEN:RowSetDS &oDS;

&oDS = create PSXP_XMLGEN:RowSetDS();

&xmlDoc = CreateXmlDoc("<?xml version='1.0'?><" | &sXmlDataName | "    xmlns:xsi=" | """" | "http://www.w3.org/2001/XMLSchema-instance"
| """" | "/>");
&xmlDocNode = &xmlDoc.DocumentElement;

/* assume you have populated &rsResult1, &rsResult2 */

&dsRS.addXMLData(&xmlDocNode, &rsResult1);
&dsRS.addXMLData(&xmlDocNode, &rsResult2);
Return &xmlDoc.GenXmlString();

AddXSDSchema

Syntax

AddXSDSchema(&ParentNode, &Rowset)

Description

Use the AddXSDSchema method to add the XSD schema of a rowset to the specified parent node. This method can be used to combine schema of multiple rowsets in a single XSD.

Parameters

Returns

None.

Example

Local XmlDoc &xmlDoc;
Local XmlNode &xmlDocNode;
Local PSXP_XMLGEN:RowSetDS &oDS;

&oDS = create PSXP_XMLGEN:RowSetDS();

&xmlDoc = CreateXmlDoc("<?xml version='1.0'?><xsd:schema xmlns:xsd=" |    """" | "http://www.w3.org/2001/XMLSchema" | """"
| "/>");

&xmlDocNode = &xmlDoc.DocumentElement;
/* assume you have populated &rsResult1, &rsResult2 */

&dsRS.addXSDSchema(&xmlDocNode, &rsResult1);
&dsRS.addXSDSchema(&xmlDocNode, &rsResult2);
Return &xmlDoc.GenXmlString();

GetXMLData

Syntax

GetXMLData(&Rowset, XSDLocation)

Description

Use the GetXMLData method to create query data in XML format, based on the specified rowset object.

Parameters

Returns

A string containing the generated XML data.

See Also

RunToRowset

GetXSDSchema

Syntax

GetXSDSchema(&Rowset)

Description

Use the GetXSDSchema method to create a schema in XSD format based on the specified rowset object.

Parameters

Returns

A string containing the generated query schema in an XSD string.

XML Publisher Engine Class Constructors

Before you can use the XML Publisher engine classes, you must import the application package that contains them, as follows:

import PSXP_ENGINE:*;

You must use the constructor for each class to instantiate an instance of that class. The following are the constructors for the XML Publisher engine classes, in alphabetical order.

EFTProcessor

Syntax

EFTProcessor()

Description

Use the EFTProcessor constructor to instantiate an EFTProcessor object.

Parameters

None.

Returns

An EFTProcessor object.

See Also

EFTProcessor Class

FOProcessor

Syntax

FOProcessor()

Description

Use the FOProcessor constructor to instantiate an FOProcessor object.

Parameters

None.

Returns

An FOProcessor object.

See Also

FOProcessor Class

FormProcessor

Syntax

FormProcessor()

Description

Use the FormProcessor constructor to instantiate an FormProcessor object.

Parameters

None.

Returns

A FormProcessor object.

See Also

FormProcessor Class

FOUtility

Syntax

FOUtility()

Description

Use the FOUtility constructor to instantiate a FOUtility object.

Parameters

None.

Returns

A FOUtility object.

See Also

FOUtility Class

PageNumber

Syntax

PageNumber()

Description

Use the PageNumber constructor to instantiate a PageNumber object.

Parameters

None.

Returns

A PageNumber object.

See Also

PageNumber Class

PDFMapTool

Syntax

PDFMapTool()

Description

Use the PDFMapTool constructor to instantiate a PDFMapTool object.

Parameters

None.

Returns

A reference to a PDFMapTool object.

See Also

PDFMapTool Class

PDFMerger

Syntax

PDFMerger()

Description

Use the PDFMerger constructor to instantiate a PDFMerger object.

Parameters

None.

Returns

A reference to a PDFMerger object.

See Also

PDFMerger Class

Properties

Syntax

Properties()

Description

Use the Properties constructor to instantiate a Properties object.

Parameters

None.

Returns

A Properties object.

See Also

Properties Class

RTFProcessor

Syntax

RTFProcessor()

Description

Use the RTFProcessor constructor to instantiate an RTFProcessor object.

Parameters

None.

Returns

An RTFProcessor object.

See Also

RTFProcessor Class

Watermark

Syntax

Watermark()

Description

Use the Watermark constructor to instantiate a Watermark object.

Parameters

None.

Returns

A Watermark object.

See Also

Watermark Class

EFTProcessor Class

Use the EFTProcessor class to access the Oracle EFTProcessor API.

EFTProcessor Class Methods

The following are the EFTProcessor class methods, in alphabetical order.

GenerateOutput

Syntax

GenerateOutput(EFTFile, XMLDataFile, OutputFile, Error)

Description

Use the GenerateOutput method to create an output file from the specified EFT source file and XML data file.

Parameters

Returns

A boolean value: true if the method completes successfully, false otherwise.

Example

Local PSXP_ENGINE:EFTProcessor &oEFT;
&oEFT = create PSXP_ENGINE:EFTProcessor();

&sErr = "";

&bResult = &oEFT.generateOutput(&sXSLFile, &XMLDatafile, &sOutputFile, &sErr);

See Also

GenerateXSL

GenerateXSL

Syntax

GenerateXSL(RTFTemplateFile, XSLOutputFile, Error)

Description

Use the GenerateXSL method to create an XSL file from the specified RTF template file. RTFTemplateName must actually be an EFT source file.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

Example

Local PSXP_ENGINE:EFTProcessor &oEFT;
&oEFT = create PSXP_ENGINE:EFTProcessor();

&sErr = "";

&bResult = &oEFT.generateXSL(&sEFTFile, &sXSLOutputFile, &sErr);

See Also

GenerateOutput

EFTProcessor Class Properties

The following are the EFTProcessor class properties, in alphabetical order.

ConfFile

Description

Use the ConfFile property to specify a file that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify an already instantiated and populated Properties object that contains the configuration properties, use the ConfProp property instead.

This property is read-write.

See Also

ConfProp

ConfProp

Description

Use the ConfProp property to specify an already instantiated and populated Properties object that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify a file that contains the configuration properties, use the ConfFile property instead.

This property is read-write.

See Also

ConfFile

FOProcessor Class

Use the FOProcessor class to access the Oracle FOProcessor API.

FOProcessor Class Methods

The following are the FOProcessor class methods, in alphabetical order.

GenerateMergedOutput

Syntax

GenerateMergedOutput(&XSLTemplateFileArray, &XMLDataFileArray, &XliffFileArray, OutputFileName, OutputFormat, Error)

Description

Use the GenerateMergedOutput method to create formatted output from multiple XSL template files, XML data files and optionally, Xliff files.

The output is merged in the order of the files in the arrays, that is, the first part of the merged output comes from the first template with the first data file, as well as the first Xliff file (if appropriate), the second part from the second template and data file, and so on.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

See Also

GenerateMergedOutputFO, GenerateOutput.

Array Class

GenerateMergedOutputFO

Syntax

GenerateMergedOutputFO(&FOFIleArray, OutputFile, OutputFormat, Error)

Description

Use the GenerateMergedOutputFO method to create output from multiple formatted objects.

The output is merged in the order of the files in the arrays, that is, the first part of the merged output comes from the first template with the first data file, as well as the first Xliff file (if appropriate), the second part from the second template and data file, and so on.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

See Also

GenerateMergedOutput

Array Class

GenerateOutput

Syntax

GenerateOutput(XSLTemplateFile, XMLDataFile, XLiffFile, OutputFile, OutputFormat, Error)

Description

Use the GenerateOutput method to create output from an XSL template file, an XML data file and, optionally, an Xliff file.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

See Also

GenerateOutputFO

GenerateOutputFO

Syntax

GenerateOutputFO(FOFileName, OutputFile, OutputFormat, Error)

Description

Use the GenerateOutputFO method to create output from formatted objects.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

See Also

GenerateOutput

FOProcessor Class Properties

The following are the FOProcessor class properties, in alphabetical order.

ConfFile

Description

Use the ConfFile property to specify a file that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify an already instantiated and populated Properties object that contains the configuration properties, use the ConfProp property instead.

This property is read-write.

See Also

ConfProp

ConfProp

Description

Use the ConfProp property to specify an already instantiated and populated Properties object that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify a file that contains the configuration properties, use the ConfFile property instead.

Example

Local PTXMLP_ENGINE:FOProcessor &oFO;
Local PTXMLP_ENGINE:Properties &oProp;

&oFO = create PTXMLP_ENGINE:FOProcessor();
&oProp = create PTXMLP_ENGINE:Properties();

&bResult = &oProp.setProperty("pdf-security", "true");
&bResult = &oProp.setProperty("pdf-permissions-password", "abc");
&bResult = &oProp.setProperty("pdf-encription-level", "0");

&oFO.ConfProp = &oProp;

See Also

ConfFile

Locale

Description

Use the Locale property to specify the locale for the processing. If no value is specified for this property, the default system locale will be used.

The locale is specified using a two character ISO language code and a two character ISO country code (LC-CC). When you don't need to reflect country specific formatting, the locale code is made up of just the language code.

This property is read-write.

FormProcessor Class

Use the FormProcessor class to access the Oracle FormProcessor API.

FormProcessor Class Methods

The following are the FormProcessor class methods, in alphabetical order.

ExtractFieldNames

Syntax

ExtractFieldNames(PDFTemplateFileName, IncludeReservedNames, FieldNameArray, Error)

Description

Use the ExtractFieldNames method to extract the field names from the specified PDF template.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

See Also

ExtractFieldValues

ExtractFieldValues

Syntax

ExtractFieldValues(PDFTemplateFileName, IncludeReservedNames, FieldValueArray, Error)

Description

Use the ExtractFieldValues method to extract the field values from the specified PDF template.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

See Also

ExtractFieldNames

FillForm

Syntax

FillForm(PDFTemplateFile, XMLDataFile, PDFOutputFile, Error)

Description

Use the FillForm method to fill a PDF form by merging XML data into a PDF template.

Parameters

Returns

A boolean value: true if the method completed successfully, false otherwise. If false, the Error parameter is populated with the returned error message.

FormProcessor Class Properties

The following are the FOProcessor class properties, in alphabetical order.

ConfFile

Description

Use the ConfFile property to specify a file that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify an already instantiated and populated Properties object that contains the configuration properties, use the ConfProp property instead.

This property is read-write.

See Also

ConfProp

ConfProp

Description

Use the ConfProp property to specify an already instantiated and populated Properties object that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify a file that contains the configuration properties, use the ConfFile property instead.

This property is read-write.

Example

Local PTXMLP_ENGINE:FOProcessor &oFO;
Local PTXMLP_ENGINE:Properties &oProp;

&oFO = create PTXMLP_ENGINE:FOProcessor();
&oProp = create PTXMLP_ENGINE:Properties();

&bResult = &oProp.setProperty("pdf-security", "true");
&bResult = &oProp.setProperty("pdf-permissions-password", "abc");
&bResult = &oProp.setProperty("pdf-encription-level", "0");

&oFO.ConfProp = &oProp;

See Also

ConfFile

Locale

Description

Use the Locale property to specify the locale for the processing. If no value is specified for this property, the default system locale will be used.

The locale is specified using a two character ISO language code and a two character ISO country code (LC-CC). When you don't need to reflect country specific formatting, the locale code is made up of just the language code.

This property is read-write.

FOUtility Class

Use the FOUtility class to access the Oracle FOUtility API.

FOUtility Class Methods

The following are the FOUtility class methods, in alphabetical order.

GenerateFO

Syntax

GenerateFO(XSLFile, XMLDataFile, OutputFOFile, Error)

Description

Use the GenerateFO method to generate a formatted object file from the specified XSL file and XML data.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

MergeFOs

Syntax

MergeFOs(&FOFileArray, OutputFOFile, Error)

Description

Use the MergeFOs method to merge formatted objects into an output file.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

Example

Local PTXMLP_ENGINE:FOUtility &oFOU;

&oFOU = create PTXMLP_ENGINE:FOUtility();
&sErr = "";
&asFOFiles= CreateArray(&sFOFile1);
&asFOFiles.Push(&sFOFile2);

&bResult = &oFOU.mergeFOs(&asFOFiles, &sOutputFOFile, &sErr);

FOUtility Class Property

The following is the FOUtility class property Prop.

Prop

Description

Use the Prop property to specify an already instantiated and populated Properties object that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

This property is read-write.

PageNumber Class

Use the PageNumber class to set the page number for a merged PDF file. Objects in this class are used with the PDFMerger class property PageNumber.

PageNumber Class Properties

The following are the PageNumber class properties, in alphabetical order.

BackgroundFile

Description

Use the BackgroundFile property to specify a file to be used for the page number, as a string.

You must specify an absolute file name.

This property is read-write.

Considerations Using the BackgroundFile Property

You should either use the BackgroundFile property, or you should use the other properties associated with this class, like position or font. You cannot use both.

The file you specify must be a PDF file. The page size of the background PDF must be the same as the target PDF document, otherwise the page numbering doesn't work properly. All page numbering starts on the first page of the target document.

FontName

Description

Use the FontName property to specify the name of the font to be used for the page number, as a string. Valid values are:

• Courier

• Courier-Bold

• Courier-BoldOblique

• Helvetica (this is the default value)

• Helvetica-Bold

• Helvetica-BoldOblique

• Helvetica-Oblique

• Symbol

• Times-Bold

• Time-BoldItalic

• Time-Italic

• Time-Roman

• ZapfDingbats

If you specify an invalid font name, the default (Helvetica) is used.

This property is read-write.

See Also

FontSize

FontSize

Description

Use the FontSize property to specify the size of the page number, as a number.

The default value is 8.

This property is read-write.

See Also

FontName

PositionX

Description

Use the PositionX property to specify the X axis position of the text page number in the merged document.

This property is read-write.

See Also

PositionY

PositionY

Description

Use the PositionY property to specify the Yaxis position of the text page number in the merged document.

This property is read-write.

See Also

PositionX

StartFromPageNum

Description

Use the StartFromPageNum property to specify the page index from which you'd like to start the page numbering.

For example, if you have a PDF document which has two cover pages, and you want to start printing page numbers on the document from the third page, specify a three for this property.

This property is read-write.

See Also

StartNum

StartNum

Description

Use the StartNum property to specify the page number to use as the first page number in the merged document. If you don't specify a starting number, the pages are numbered starting from 1.

This property is read-write.

See Also

StartFromPageNum

PDFMapTool Class

Use the PDFMapTool class to access the PeopleSoft map tool.

PDFMapTool Class Methods

The following are the PDFMapTool class methods, in alphabetical order.

EnableMap

Syntax

EnableMap(XSDFile, PDFTemplateFile, XMLInputFile, PDFOutputFile)

Description

Use the EnableMap method to create a map-enabled PDF file based on the specified PDF template file.

Parameters

Returns

None.

extractMap

Syntax

extractMap(PDFFile, OutMapFile)

Description

Use the extractMap method to extract a map file from a map-enabled PDF file.

Parameters

Returns

None.

processForm

Syntax

processForm(PDFTemplateFile, XMLDataFile, MapFile, OutputPDFFile)

Description

Use the processForm method to generate a output from the PDF template and map-enabled file. This is not the same as ProcessReport, which performs full report generation.

Parameters

Returns

None.

PDFMapTool Class Property

The following is a description of the PDFMapTool class property Locale.

Locale

Description

Use the Locale property to specify the locale for the processing. If no value is specified for this property, the default system locale will be used.

The locale is specified using a two character ISO language code and a two character ISO country code (LC-CC). When you don't need to reflect country specific formatting, the locale code is made up of just the language code.

This property is read-write.

PDFMerger Class

Use the PDFMerger class to access the Oracle PDFMerger API.

PDFMerger Class Method

The following is the PDFMerger class method MergePDFs.

MergePDFs

Syntax

MergePDFs(PDFFileArray, PDFOutputFile, Error)

Description

Use the MergePDFs method to merge the specified PDF files into a single output file.

The order of the files specified in the array are the order in which the files are merged.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

Example

Local PTXMLP_ENGINE:PDFMerger &oMerger;

&sErr = "";
&asNames = CreateArray(&sPdfFile1);
&asNames.Push(&sPdfFile2);
&bResult = &oMerger.mergePDFs(&asNames, &sOutputPdfFile, &sErr);

PDFMerger Class Properties

The following are the PDFMerger class properties, in alphabetical order.

ConfProp

Description

Use the ConfProp property to specify an already instantiated and populated Properties object that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify a file that contains the configuration properties, use the ConfFile property instead.

Locale

Description

Use the Locale property to specify the locale for the processing. If no value is specified for this property, the default system locale will be used.

The locale is specified using a two character ISO language code and a two character ISO country code (LC-CC). When you don't need to reflect country specific formatting, the locale code is made up of just the language code.

This property is read-write.

PageNumber

Description

Use this property to specify an already instantiated and populated PageNumber object to be used with the merged document.

This property is read-write.

Example

Local PTXMLP_ENGINE:PDFMerger &oMerger;
Local PTXMLP_ENGINE:PageNumber &oPageNumber;

&oMerger = create PTXMLP_ENGINE:PDFMerger();
&oPageNumber = create PTXMLP_ENGINE:PageNumber();

&oPageNumber.FontName = "Symbol";
&oPageNumber.FontSize = 16;
&oPageNumber.PositionX = 300;
&oPageNumber.PositionY = 20;
&oMerger.oPageNumber = &oPageNumber;

&sErr = "";
&asNames = CreateArray(&sPdfFile1);
&asNames.Push(&sPdfFile2);
&bResult = &oMerger.mergePDFs(&asNames, &sOutputPdfFile, &sErr);

See Also

PageNumber Class

Watermark

Description

Use this property to specify an already instantiated and populated Watermark object to be used with the merged object.

This property is read-write.

Example

Local PTXMLP_ENGINE:PDFMerger &oMerger;
Local PTXMLP_ENGINE:Watermark &oWatermark;

&oMerger = create PTXMLP_ENGINE:PDFMerger();
&oWatermark = create PTXMLP_ENGINE:Watermark();

&oWatermark.Text = "DEMO";
&oWatermark.TextStartPosX = 200;
&oWatermark.TextStartPosY = 400;
&oMerger.oWatermark = &oWatermark;

&sErr = "";
&asNames = CreateArray(&sPdfFile1);
&bResult = &oMerger.mergePDFs(&asNames, &sOutputPdfFile, &sErr);

See Also

Watermark Class

Properties Class

Use the Properties class to specify the properties for setting up the processor configuration. This class is used with the following classes:

• EFTProcessor

• FOProcessor

• FormProcessor

• FOUtility

• PDFMerger

• RTFProcessor

Properties Class Methods

The following are the Properties class methods, in alphabetical order.

GetProperty

Syntax

GetProperty(Name, OutValue)

Description

Use the GetProperty method to return the value of the specified property.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

Example

Local PTXMLP_ENGINE:Properties &oProp;

&oProp = create PTXMLP_ENGINE:Properties();
%sValue = "";
&bResult = &oProp.getProperty("pdf-security", %sValue);

SetProperty

Syntax

SetProperty(Name, Value)

Description

Use the SetProperty method to specify the value of the specified property.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

Example

Local PTXMLP_ENGINE:Properties &oProp;

&oProp = create PTXMLP_ENGINE:Properties();
&bResult = &oProp.setProperty("pdf-security", "true");

RTFProcessor Class

Use the RTFProcessor class to access the Oracle RTF processor API.

RTFProcessor Class Methods

The following are the RTFProcessor methods, in alphabetical order.

GenerateXSL

Syntax

GenerateXSL(RTFTemplateFile, XSLOutputFile, Error)

Description

Use the GenerateXSL method to generate an XSL file from the specified RTF template.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

Example

Local PTXMLP_ENGINE:RTFProcessor &oRTF;

&oRTF = create PTXMLP_ENGINE:RTFProcessor();
&sErr = "";
&bResult = &oRTF.generateXSL(&sRTFFile, &sXSLFile, &sErr);

See Also

GenerateXSLXliff

GenerateXSLXliff

Syntax

GenerateXSLXliff(RTFTemplateName, XSLOutputFile, XliffOutputFile, Error)

Description

Use the GenerateXSLXliff method to generate the XSL file and the Xliff from the specified RTF template.

Parameters

Returns

A boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.

Example

Local PTXMLP_ENGINE:RTFProcessor &oRTF;

&oRTF = create PTXMLP_ENGINE:RTFProcessor();
&sErr = "";
&bResult = &oRTF.generateXSLXliff(&sRTFFile, &sXSLFile, &sXliffFile, &sErr);

See Also

GenerateXSL

RTFProcessor Class Properties

The following are the RTFProcessor class properties, in alphabetical order.

ConfFile

Description

Use the ConfFile property to specify a file that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify an already instantiated and populated Properties object that contains the configuration properties, use the ConfProp property instead.

This property is read-write.

See Also

ConfProp

ConfProp

Description

Use the ConfProp property to specify an already instantiated and populated Properties object that contains the configuration to be used for processing the document. This property enables you to accommodate different system configurations.

If you want to specify a file that contains the configuration properties, use the ConfFile property instead.

See Also

ConfFile

Locale

Description

`

Use the Locale property to specify the locale for the processing. If no value is specified for this property, the default system locale will be used.

The locale is specified using a two character ISO language code and a two character ISO country code (LC-CC). When you don't need to reflect country specific formatting, the locale code is made up of just the language code.

This property is read-write.

Watermark Class

Use the watermark class to specify a watermark for a merged PDF file. Objects in this class are used with the PDFMerger class property Watermark.

You can generate a watermark either using text or an image. You can either use the text properties or the image properties. You cannot use both.

The following are the image watermark class properties:

• ImageFile

• ImageLowerLeftX

• ImageLowerLeftY

• ImageUpperRightX

• ImageUpperRightY

The following are the text watermark class properties:

• Text

• TextAngle

• TextFontName

• TextFontSize

• TextStartPosX

• TextStartPosY

Watermark Class Properties

The following are the properties for the Watermark class, in alphabetical order.

ImageFile

Description

Use the ImageFile property to specify the full path name of an image file to be used for the watermark.

Forward or back slashes are used in the path according to the operating system of the application server or process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a Windows server returns a path with back slashes.

This property is read-write.

ImageFileLowerLeftX

Description

Use the ImageFileLowerLeftX property to specify the lower left, X-axis position for the watermark, as a number.

This property is read-write.

ImageFileLowerLeftY

Description

Use the ImageFileLowerLeftY property to specify the lower left, Y-axis position for the watermark, as a number.

This property is read-write.

ImageFileUpperRightX

Description

Use the ImageFileUpperRightX property to specify the upper right, X-axis position for the watermark, as a number.

This property is read-write.

ImageFileUpperRightY

Description

Use the ImageFileUpperRightY property to specify the upper right, Y-axis position for the watermark, as a number.

This property is read-write.

PageIndex

Description

Use the PageIndex property to specify the page where the watermark begins. For example, you might not want a watermark to display on a cover page. The default value is 0, which sets the watermark on all pages (page index starts at 1.)

This property is read-write.

Text

Description

Use the Text property to specify the text for the watermark, as a string.

This property is read-write.

TextAngle

Description

Use the TextAngle property to specify the angle of the watermark text across the page. You must specify a number between 1 and 360.

This property is read-write.

TextFontName

Description

Use the TextFontName property to specify the name of the font to be used for the text for the watermark.

This property is read-write.

TextFontSize

Description

Use the TextFontSize property to specify the size of the text font. The default value is 8.

This property is read-write.

TextStartPosX

Description

Use the TextStartPosX property to specify the starting position, X-axis location for the text to be used as the watermark.

This property is read-write.

TextStartPosY

Description

Use the TextStartPosY property to specify the starting position, Y-axis location for the text to be used as the watermark.

This property is read-write.

XML Publisher Classes Example

The following example lists a complete example of the code first, then goes through the program line by line.

Generate and Publish a Report

In the following example, a report is created from an existing report definition. It is populated with an already instantiated and populated XmlDoc object, then published.

The following is the complete code sample: the steps explain each line.

import PSXP_RPTDEFNMANAGER:*;

Local XMLDoc &xmlDoc;
Local string &rptDefnId = "Financial";
Local string &LanguageCode = "ENG";
Local string &effdt = "2004-4-1";
Local string &outputfmt = "HTM";

Local String &reportPath = GetEnv("PS_SERVDIR") | "\files\reports";
Local String &folderName = "General";
Local string &serverName = "PSNT";
Local ReportDefn &rptDefn;

&rptDefn = Create ReportDefn(&rptDefnId);
&rptDefn.Get();
&rptDefn.SetRuntimeDataXMLDoc(&xmlDoc);
&rptDefn.ProcessReport("", &languageCd, &effdt, &outputfmt); 

&rptDefn.Publish(&serverName, &reportPath, &folderName);

To generate and publish a report:

1. Import the appropriate application class.

   Because this program generates and publishs a report, you need to import the report manager definition class.

   import PSXP_RPTDEFNMANAGER:*;

2. Initialize variables.

   The variable declaration strings not only specify values for the variables, but give them type and scope as well. This can be very useful when debugging.

   Local XMLDoc &xmlDoc;
   Local string &rptDefnId = "Financial";
   Local string &LanguageCode = %Language_User;
   Local string &effdt = "2004-4-1";
   Local string &outputfmt = "HTM";
   
   Local String &reportPath = GetEnv("PS_SERVDIR") | "\files\reports";
   Local String &folderName = "General";
   Local string &serverName = "PSNT";
   Local ReportDefn &rptDefn;
   

3. Instantiate the report definition object and initialize it.

   After you instantiate a report definition object, you must initialize it and populate it using the Get method.

   &rptDefn = Create ReportDefn(&rptDefnId);
   &rptDefn.Get();
    

4. Specify the data for the report.

   This report uses an XmlDoc for the data source, so you must specify the runtime data source for the report before you process it.

   &rptDefn.SetRuntimeDataXMLDoc(&xmlDoc);

5. Process the report.

   You must process the report, generate a version of it for the report repository, before you can distribute the report.

   &rptDefn.ProcessReport("", &languageCd, &effdt, &outputfmt); 

6. Publish the report.

   After you've generated the report, you may want to publish it to another location.

   &rptDefn.Publish(&serverName, &reportPath, &folderName);