Document PeopleCode

PeopleSoft provides a Document API for populating and retrieving document data that includes several built-in functions and classes.

The built-in functions are:

Term	Definition
CreateDocument	Use this built-in function to instantiate a Document object.
CreateDocumentKey	Use this built-in function to instantiate a Document Key object

The classes are:

• Document class.

  Use the methods and properties in this class to populate and retrieve document data.

• DocumentKey class.

  Use the methods and properties in this class to create document keys.

  Document keys enable you to map the document package, document name, and document version, to one string. As a result, when you populate or retrieve data from a document, you can specify the one document key, instead of specifying the document package, name, and version.

  populating or retrieving data from a document, you can use the one document key

• Primitive class.

  Use the methods and properties in this class to populate and retrieve document data from primitive elements.

• Compound class.

  Use the methods and properties in this class to populate and retrieve document data from compound elements.

• Collection class.

  Use the methods and properties in this class to populate and retrieve document data from collection elements.

The Document API is discussed in the product documentation for PeopleCode API Reference.

Examples of populating and retrieving document data are provided elsewhere in this topic.