Navigating in the Document Builder

This chapter discusses how to:

Click to jump to parent topicAccessing the Document Builder

PeopleSoft provides a Document Builder tool that enables you to build the structure of a document and define XML and relational formats for it.

The Document Builder is located in the IB_LOGICALSCHEMA component in the PeopleSoft Pure Internet Architecture.

To access the Document Builder, select PeopleTools, Documents, Document Builder. When the Document Builder opens, the default view is of the Document Builder - Documents (IB_LOGICALSCHEMA) page. The following example shows the page:

The Document Builder has three pages. The following table briefly describes the pages and how to access each of them.

Page

Description

Navigation

Document Builder - Document

Use the Document page to view:

  • Metadata objects that reference the current document.

  • General document details, such as comments about the definition, the owner of the object, and more.

  • A list of documents of which the current document is a child.

You also use the Document page to:

  • Build out the logical structure of the document by adding elements to documents and defining element properties.

  • Copy, rename, export, and validate a document. Validate the XML document structure.

PeopleTools, Documents, Document Builder

Click the Document tab.

Document Builder - XML

Use the XML page to view:

  • XML schema details, such as target and imported namespace information.

  • Options such as element whitespace, filter blank elements, and more.

PeopleTools, Documents, Document BuilderClick the XML tab.

Document Builder - Relational

Use the Relational page to map PeopleSoft records to documents, which enables you to populate a rowset with a document.

PeopleTools, Documents, Document Builder

Click the Relational tab.

Subsequent sections in this chapter detail how you navigate each of the Document Builder pages.

See Also

Navigating the Document Page

Navigating the XML Page

Navigating the Relational Page

Click to jump to parent topicUsing the Document Tree to View Document Information

The system displays the structure of a document in a hierarchical format in a document tree.

The document tree appears on each page of the Document Builder. In most cases, when you click an element name, additional information appears for you to view or define on the right side of the page. The information that appears depends on the Document Builder page that you are viewing.

This section discusses how to:

Other chapters of this PeopleBook discuss using the document tree to build and manage documents.

Click to jump to top of pageClick to jump to parent topicViewing the Document Tree

When you open a document in the Document Builder, the Document Builder - Document page appears, and the document tree for the definition appears after the Document Details section.

The following example shows the document tree for the PurchaseOrder document as it appears on the Document Builder - Document page:

Click to jump to top of pageClick to jump to parent topicViewing Elements in the Document Tree

A document has one root element and, by default, the same name as the document definition. The root can have one or more child elements; child elements can have none, one, or more peer elements or child elements; and so on.

In the previous example, the root element has the name of the document, PurchaseOrder. The root has the following child elements: Language_Code, TransactionID, BillTo, ShipTo, and Item_collection. All elements except for Language_Code have child elements.

When you view elements in the document tree, the icons to the left of the element name identify the element type:

Primitive element.

Collection element.

Compound element.

These icons also appear on the buttons of the action toolbar. You use the element action toolbar to add elements to the document tree.

Element types and the action toolbar are discussed in greater detail elsewhere in this PeopleBook.

See Also

Understanding Element Types and Data Types

Using the Elements Action Toolbar

Click to jump to top of pageClick to jump to parent topicExpanding and Collapsing the Document Tree

You can expand and collapse the document tree by clicking the Expand (+) and Collapse (–) buttons next to the parent elements.

Click to jump to top of pageClick to jump to parent topicSelecting Elements and Viewing Element Properties

In most cases, when you select an element name in the document tree, properties that are defined or can be defined for the element appear on the right side of the page. This behavior is consistent for all pages of the Document Builder.

The following example shows the Document Builder - XML page of the BillTo document:

The name element is selected in the document tree. When you select the element on this page, the system displays XML property information for the element.

The following example shows the Document Builder - Relational page for the BillTo document.

On this page, when you select the name element, the system displays properties for any PeopleSoft fields that are mapped to the element to the right of the document tree.

Click to jump to parent topicNavigating the Document Page

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicAccessing the Document Builder - Document Page

The Document page (IB_LOGICALSCHEMA) is the default view in the Document Builder. To access the Document Builder - Document page, select PeopleTools, Documents, Document Builder. The following example shows the page:

Click to jump to top of pageClick to jump to parent topicViewing Metadata References

If a document is referenced by another metadata object in the system, a Metadata References section appears on the Document Builder - Documents page that lists the object type and the object definition name that references the document.

By default, the section appears collapsed on the page. To expand and view the section, click the arrow icon next to the Metadata References section label. To collapse the section, click the arrow again.

The following example shows the Metadata References section for the FlightData document:

The Source column lists the PeopleTools metadata object type that references the document. The Identifier column lists the name of the object definition that references the document.

In the example, an Integration Broker message metadata object references the FlightData document. The name of the Integration Broker message referencing the document is FLIGHT.V1.

Click to jump to top of pageClick to jump to parent topicViewing Document Details

The Document Builder-Documents page features a Document Details section that provides information about the document, such as a document label, owner ID, free-form comments, and whether the document is designated as a private document.

The section appears collapsed by default. To expand and view the section, click the arrow icon next to the Document Details section label. To collapse the section, click the arrow again.

The following example shows the Document Details section for the BillTo document:

Click to jump to top of pageClick to jump to parent topicViewing Document Dependencies

If a document is a child of another document in the system, then it appears in the Document Dependencies grid on the Document Builder - Document page. The Document Dependencies grid appears on the right side of the page when you click the root element in the document tree.

The following example shows document dependencies for the BillTo document:

The previous example shows that the BillTo document is a child document in the PurchaseOrder and DEMO_PURCH_ORDER documents.

Unless write-restricted, any changes you make to a document will impact any parent documents.

Click to jump to top of pageClick to jump to parent topicViewing Element Properties

When you click any element in the document tree other than the root element, properties for the element appear on the right side of the page. The following example shows the element properties for the state element of the BillTo document:

The element properties that appear depend on the element type.

Element properties are discussed in detail elsewhere in this PeopleBook.

See Also

Adding Elements to Documents

Click to jump to top of pageClick to jump to parent topicViewing the Action Toolbar

The action toolbar appears below the document tree on the Document Builder - Document page.

Use the toolbar to add child and peer elements to a document, move elements in the tree, or delete elements in the tree.

In the following example, the action toolbar appears below the document tree of the BillTo document:

The action toolbar is not enabled until you select an element in the document tree. In addition, the actions that are available to perform on an element vary, depending on the element with which you are working and the structure of the tree.

Using the action toolbar is discussed in more detail elsewhere in this PeopleBook.

See Using the Elements Action Toolbar.

Click to jump to parent topicNavigating the XML Page

This section provides an overview of navigating the XML page and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding Navigating the XML Page

The Document Builder - XML page (IB_XMLSCHEMA) features an XML Schema Details section that displays XML schema information defined for the document. It also enables you to view and define schema properties for elements, such as tag names, tag prefixes, and so on.

Click to jump to top of pageClick to jump to parent topicAccessing the Document Builder - XML Page

To access the Document Builder - XML page, select PeopleTools, Documents, Document Builder, and click the XML tab. The following example shows the Document Builder - XML page:

Click to jump to top of pageClick to jump to parent topicViewing XML Schema Details

By default, the XML Schema Details section of the Document Builder - XML page appears collapsed on the page. To expand the section, click the arrow icon next to the XML Schema Details label. The following example shows the section expanded:

The XML Schema details shows the root tag name, XML type, and element type. Target namespace information provided includes the target namespace prefix and URI,, and if the namespace is defined to appear in the generated XML. The Imported Namespace section shows the names and URIs of any documents that are defined as elements in the document. Other information provided includes whether the schema reference is included in the XML, if whitespace is to be trimmed, if blank elements are filtered out of the XML, and so on.

Click to jump to top of pageClick to jump to parent topicViewing XML Schema Properties for Elements

The Document Builder - XML page also displays property information about elements. When you select an element in the document tree, properties for the element appear on the right side of the page. The following example shows that the name element is selected in the document tree, and the XML schema properties defined for it appear on the right side of the page:

The schema properties for the name element are read-only. They are read-only because the BillTo element is actually a document itself. To make any changes to it, you would access the BillTo document and make the appropriate changes.

Click to jump to parent topicNavigating the Relational Page

This section provides an overview of the Relational page and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding the Relational Page

Use the Document Builder - Relational page (IB_RELATSCHEMA) to view PeopleSoft records and fields that are mapped to documents and document elements.

Mapping PeopleSoft records and fields to documents is optional.

Usually, mapping PeopleSoft records to documents is done so that you can populate a rowset using a document.

Click to jump to top of pageClick to jump to parent topicAccessing the Relational Page

To access the Document Builder - Relational page, select PeopleTools, Documents, Document Builder and click the Relational tab. The following example shows the page:

Click to jump to top of pageClick to jump to parent topicViewing Records Mapped to Documents

The Document Builder - Relational page features a Relational Details section where you can view the PeopleSoft record mapped to the document.

By default, the Relational Details section is collapsed. To expand the section, click the arrow icon next to the Relational Details label. The following example shows the section expanded:

The previous example shows that the PeopleSoft record ITEMS is mapped to the Line_Items document.

When a PeopleSoft record is mapped to a document, all the elements in the document must be mapped to fields in the record.

The following section describes how to view record fields that are mapped to document elements.

Click to jump to top of pageClick to jump to parent topicViewing Record Fields Mapped to Document Elements

As described in the previous section, if a PeopleSoft record is mapped to a document, then all document elements must be mapped to a field in the record.

To view the record fields that are mapped to document elements, you select an element name in the document tree, and the field mapped to the element appears to the right of the document tree.

The following example shows the mapping of a record field to a document element: