PeopleSoft Enterprise Supplier Contract Management 9.1 PeopleBook

Generating Microsoft Word Documents

This chapter provides an overview of Microsoft Word document generation and discusses how to:

Generate Microsoft Word documents.
Refresh Microsoft Word documents.
View document generation logs.

Understanding Microsoft Word Document Generation

PeopleSoft Supplier Contract Management generates Microsoft Word 2003 documents in a Microsoft Word 2003 .xml file format when you preview a clause, section, or document configurator or when you generate the first-draft document using the document authoring system. This chapter focuses primarily on draft document generation and re-create and refresh capabilities of document generation.

Note. Make sure you are using the latest service pack of Microsoft Office Word 2003, at least SP1, and that the application is a part of Microsoft Office Professional Edition 2003. The Standard version of Microsoft Word 2003 is not sufficient for editing and maintaining PeopleSoft custom XML tags. You can also use Microsoft Office Word 2007 as long as documents are saved in 2003 .xml compatibility mode. Unlike Microsoft Word 2003, the Standard version of Microsoft Word 2007 is sufficient for editing and maintaining PeopleSoft custom XML tags.

Microsoft Word document generation is the process the system uses to assemble elements from the document library into Microsoft Word documents. The process of creating a document is the beginning phase for enabling integration between PeopleSoft Internet Architecture pages and Microsoft Word documents.

PeopleSoft Supplier Contract Management uses the Microsoft Word generation program when creating initial draft versions of an authored document and initial draft versions of amendment documents when you are creating separate amendment files. You create the initial Microsoft Word document using the Document Management component.

To create an initial document, use the Add a Document page to select a value for the Source Transaction field, assign a contract ID, purchase order ID, or ad hoc ID, and click the Add a Document button. Use the next page to define the document configurator that structures the document, and then click the Create Document button, starting the generation process. You can also use a selection wizard to determine the configurator.

If you use a configurator selection wizard, the document creation process uses the responses to select the appropriate configurator. Then, if a document creation wizard is associated with the configurator, the system captures the responses, then invokes a process to create an instance of the initial draft of the Microsoft Word document. During the generation, the system processes all elements from the library that are directly or indirectly linked to the document configurator to expand and create the initial draft Microsoft Word document in a Microsoft Word 2003 .xml file format. After you create the initial draft, you can view, modify, and perform document life-cycle actions against the document.

Depending on how the document configurator has been defined, the system includes any required content such as sections and clauses, resolves related bind values, evaluates rules that are linked to the configurator, and takes appropriate action depending on the result of the rule. For example, a rule might require that an additional clause be added to the content.

If you are using document types, the generation process depends on the document type and its attributes, such as the kind of wizard it uses to generate a document. Also, you can import or copy documents, but some document creation processes do not apply to these documents.

After the system generates the document, it stores the document as a draft version on a file transfer protocol (FTP) server outside of the database or within the database, depending on the file attachment settings. The system also stores detailed information about the document on the Document Management page so that you can manage it from the PeopleSoft document authoring system. These details include the document identifier, its name, location, and version used in the document.

Note. For the best results in auditing the details and testing the generation process for document creation wizards and configurators, select the Details option in the Log at Document Generation field on the Document Configurator Definition page or when defining default values using the Installation Options page. The Details value enables you to log and review details for warnings, bind variable resolutions, configurator expansion processing, and wizard details for both document creation and configurator selection wizards.

See Defining Installation Options for PeopleSoft Supplier Contract Management.

This flowchart shows a high-level view of how the system generates Microsoft Word documents:

Microsoft Word document generation

The next sections provide a more detailed explanation of Microsoft Word document generation.

Processing Terms Used in This Chapter

This section describes processing features the system uses during document generation.

Document structure	A document structure is the entire document structure that includes any children for which the parent element is either repeating, an alternate, or an element that is included due to a rule. The structure represents the descendent hierarchy of text elements and depends on the repeating nature of the parent element. other repeating elements, rules, or alternates are possible as descendents of the parent element, but they are not considered document structures.
Microsoft WordML (Microsoft Office 2003 WordProcessing Markup Language)	Microsoft Word 2003 uses this XML file format, enabling the PeopleSoft Supplier Contract Management system to generate the Microsoft Word content and complete the check-out and check-in processes without losing Microsoft Word formatting. When a Microsoft Word document is in Microsoft WordML format, the system creates or saves the file with an .xml extension instead of a .doc extension. Note. While Microsoft Word 2003 and Microsoft Word 2007 enable you to open an .xml format file and save it as a .doc format file, when you use it with PeopleSoft Supplier Contract Management, the format must always be a Microsoft Word 2003 .xml file format.
Nonrepeating elements	Nonrepeating elements are clauses, sections, or rules that are based on transaction information. However, nonrepeating elements are not based on repeating transaction information; rather, they are based on transaction information for which only a single value will ever exist for the contract. For example, a vendor name or a contract end date is a single value. Nonrepeating elements can also be based on document creation wizard binds because they have only one value for the contract.
Repeating elements	A repeating element is a clause, section, or rule that is based on transaction information. You map to this information using bind variables that may have multiple values for a contract. Examples of repeating elements might be contract items on a purchase order contract or contact information on an ad hoc contract. The repeating nature of the bind variable used in the element determines whether the element itself is to repeat or not.
Source transaction	Indicates whether the document was created for use with a purchasing contract, purchase order, or for ad hoc use. An Ad Hoc document is one that has been created for general use. These documents are not constrained by procurement requirements and can be used for a variety of organizational uses, such as purchasing a one-time miscellaneous item or a service outside of the procurement system. A Purchasing Contract document is tied to a specific contract ID and extracts specific information from the contract to include in the document. The document contains a link back to its source transaction so that you can identify the source from within the document authoring system. A Purchase Order document is a document that is based on a purchase order and is linked to a PeopleSoft Purchasing purchase order.

Generating Microsoft Word Documents

This section describes the steps that you use and the system actions for generating documents. The steps also apply to amendment document generation. Generally, this information applies to both creating documents and creating separate amendment files for which you specify an amendment configurator ID.

To generate a Microsoft Word document:

You invoke the document generation process.

To begin the generation process, you can create the Microsoft Word document through the Document Management page. For purchasing contracts, the transaction contract must already exist. Using document types, a number of methods exist that lead up to the generation of a document. For example, you might use a configurator selection wizard to select the configurator. Or, the document type might specify to allow automatic document creation where the system launches the generation process with minimal user involvement.

See Understanding Document Types.

Use the following links for more information about invoking the document generation process for ad hoc, purchase order, and purchasing contract documents.

See Adding Authored Documents.

See Adding Purchasing Contract Documents.
You specify document attributes to incorporate into the Microsoft Word document.

As you define a document, you can define additional attributes that are related to the authored document. You can optionally define a document administrator and a sponsor and sponsor's department for the document, along with begin and expiration dates for ad hoc documents, and a document description. You can also define any external contact information for the document at this point.

Attributes can serve as additional information for the document which, in turn, the system can use to evaluate and include in the generation process when using bind variables. For example, you can specify a sponsor for the contract and reference the sponsor in the contract by using a transactional bind that represents the sponsor. After the system generates the document, you can update several of the attributes.

Note. The system has several predefined bind variables. Many of the binds that are related to document attributes have a DOC_ prefix. You set up bind definitions and then map them to source transactions.

See Mapping Bind Variables.
You specify a configurator ID, and click the Create Document button.

The system evaluates the document configurator ID and invokes the document creation process. Then, if a document creation wizard is specified in the configurator definition, the system initiates the wizard and presents the questions to document authors.

The document creation wizard is a tool that enables you to prompt and store values that are related to groups of questions that you define specifically for each document configurator. These questions can result in wizard bind values that the system can use during the document generation process to place values in the contract, or as values referenced in rules to determine contract content. The configurator selection wizard, on the other hand, is a group of questions the system uses to select the configurator. After selecting a configurator using the configurator selection wizard, then the system might use a document creation wizard to create the document.

Note. If you use the Copy Document feature to create a document, the system does not use a document configurator. Rather, the system makes a copy of the existing document. Also, if you use the Import Document feature, you can create a document within the document authoring system from an external document. After importing the document, you can perform a limited number of life-cycle tasks for it, and the system marks it as an imported document.

See Copying Documents Using Document Management.

See Importing Contract Documents.
The system uses the document configurator to expand the content of the document.

During the expansion process, the system finds all elements that are linked to the document configurator and expands the content into a draft version of the Microsoft Word document. The system evaluates document creation wizard bind values, rules, alternate rules, and repeating elements to expand the document.

In addition to wizard bind values, the system can reference additional transactional bind values from purchasing contract or ad hoc source transaction that is defined in the setup. The expansion process applies to both the initial document and the separate amendment files.

During the expansion process, the system:
1. Expands the content within the document configurator.
  
  Using the begin date of the purchasing contract or the ad hoc document to select active and approved content, the system incorporates all directly referenced sections and clauses, section child structures, and clause dependents that are included on the configurator. The expansion includes the children of those elements, such as dependent clauses or clauses that are attached to sections and children of those elements.
  
  Note. The system automatically excludes content from the document that is not approved, is inactive, or is approved, but future-dated beyond the contract begin date.
  
  See Defining Basic Configurator Information.
  
  Note. If the contract begin date changes after the system generates the document and then you re-create the document, the system uses the new contract begin date to expand the content during the re-creation process. Changing the begin date alone does not affect the document.
2. Applies rules that are attached directly to the configurator or to a section element.
  
  During document generation, the system evaluates each rule that has been attached directly to the configurator or section element for a simple true or false result. If the rule is true, the system attaches all elements and their children to that rule and includes them in the Microsoft Word document.
  
  If the rule is false, the system does not include the related elements, but saves the rule with the document in case a future refresh of the document causes the system to invoke the rule again.
  
  You nest rules in the configurator. For example, you can attach a rule to a section that itself was included by a rule on the configurator. The system evaluates rules for each instance of repeating data that it includes as children of a repeating structure. For example, suppose that the repeating information is a section that includes procurement contract items. The system can attach a rule to include additional contract clauses that are specific to the item category of that particular item. When generating the document, the system reevaluates the rule for each contract item to determine whether the additional clauses should be included for that particular item.
3. Resolves binds.
  
  During document expansion, the system determines which binds to resolve for use in document clauses, sections, or rules. The system resolves transactional binds using source transaction definitions and bind mappings to map the binds to transactional sources, such as the transactional purchasing contract. All document creation wizard binds and many transactional binds are typically nonrepeating, level zero binds, for which only one occurrence of the bind value is available during document generation. A contract number is an example of a nonrepeating bind.
  
  For binds that repeat, such as contract items on transactional purchasing contracts, the system resolves the binds based on how many occurrences exist in the contract transaction. An example of a repeating bind might be the items that exist on the purchasing contract. The system logs resolved bind values as part of the generation process.
4. Expands repeating sections or clauses that may exist.
  
  If the document configurator contains repeating sections or clauses, the system expands these during the generation process. For example, suppose a configurator contains a nonrepeating section defined as S_PRODUCTS01 (products and services) and within that section a repeating child section S_CONTRACT_LINES (contract lines) exists with a title or body that references bind variables for items in the transactional purchasing contract. During document generation, the system repeats the child section S_CONTRACT_LINES in the document for each instance of the item information that is contained on the transactional contract. The system evaluates each instance based on the bind mappings for bind variables that are defined within the section S_CONTRACT_LINES.
  
  A section, such as S_PRODUCTS_01, might also contain additional clauses or sections within it, depending on how you define the section. The system expands the section according to its contents. Furthermore, if the system finds nested repeating structures, it expands them in each child section. For example, if the S_CONTRACT_LINES child section contains a repeating child with line-level milestone information, the system repeats the appropriate line-level milestone information directly beneath the corresponding contract line.
  
  See Understanding Bind Variables.
  
  See Bind Variables and Repeating Clauses.
5. Builds table clauses when they exist.
  
  Table clauses enable you to create a table using Microsoft Word and to insert repeating binds within the table columns as you need. During document generation, the system expands the rows within the table clause based on repeating bind data that exists within the transaction system.
6. Applies rules that are attached to alternate clauses.
  
  The system uses rules that are attached to alternate clauses to determine which alternate clauses to use in the Microsoft Word document. Each alternate clause can have a rule attached to it. The system checks the alternates in sequenced priority order to find the first alternate for which the rule is true starting with the highest priority.
  
  During document generation, the system substitutes an alternate clause and its dependent clauses for the primary clause and its dependents in the document when one of the alternate clause rules renders true. Thus, when using multiple alternate clauses, you should typically list the most restrictive rules first followed by the least restrictive.
  
  For example, suppose that the contract specifies that a clause be substituted if the supplier is located in a specific state, and substituted with a different, more restrictive clause, if the supplier is located within a specific county of that state. The highest priority rule and alternate clause should evaluate the combination of the county and state first, followed by the second rule that evaluates just the state so that the system evaluates alternate clauses in the correct sequence.
  
  If the system doesn't find any alternate rule that is true, it does not substitute an alternate. The system evaluates alternates during contract generation once for a clause. For example, if an alternate clause is selected during contract generation, and it, in turn, has alternate rules and clauses defined (alternates for the alternate), the system does not evaluate the rules or alternates for the alternate clause.
  
  Alternates can exist for nested elements within the configurator. The system evaluates those nested alternate clauses. For example, if an alternate clause has dependent clauses which, in turn, have alternates, the system evaluates the alternate clauses as the document is expanded.
The system creates an XML-based document using Microsoft WordML schema.

After the system creates the draft Microsoft Word document, it stores it on the FTP server and links it back to the Document Management page as version 0.0.

The filename the system uses to generate the document uses this format: <setid>_<contract/ah-hoc ID>_<version number>. So, for example, the first time you check out a newly generated document for procurement contract 0000000000000000000000023, the file name might be SHARE_0000000000000000000000023_0.00. You can change this default filename by renaming the file on the local system during check out.

The system does not change the name of the document during check in, check out, or refresh because it displays document names during dispatch and can be referenced within the document itself as Microsoft Word headers or footers.

Note. You specify the location for the file transfer protocol using the Administer File Attachments page. To access the page, select Set Up Financials/Supply Chain, Common Definitions, File Attachments.

See Setting Up Supplier Contract Attachment Database and FTP Servers and Directories.

To create an XML-based document during document generation, the system:
1. Creates a memory resident XML structure to contain the new document.
2. Expands and resolves the .xml versions of sections and clauses.
  
  The system checks for section and clauses on the document configurator and assembles these elements in the memory-resident XML structure. It applies Microsoft Word paragraph styles and content from the Microsoft Word template that are associated with the document configurator.
3. Stores and moves the XML-based document to the FTP server and folder that is defined in the File Attachments component.
  
  This action takes place after the system fully expands the XML document.
4. Associates the XML file with the Document Management page by version number.
  
  The system displays the current version on the Document Management page. You can access previous versions of documents that have been generated using the Document Version History link on the Document Management page. The system displays the Document Management page upon completion of the generation process along with any logging messages.
The system generates a log.

The system generates a log for the initial document generation and displays a message if any serious logging warnings occur such as bind values that it could not resolve in the document. After you initially generate the document, the system does not use the document configurator for document editing, unless you select to re-create the document. Changes that you make to the document at this point are to the draft document, either through application pages or Microsoft Word. For each generation the system performs against the document, it provides a logging history. You access the history using the Document Version History link on the Document Management page.
You select to re-create the document.

After the system generates the document, you can click the Recreate Document button to re-create the document. This action indicates that you want to create the document again. The system completely erases the original document and generates a new document using the same processing as it did for the original document generation. Document re-creation does not include any edits that you have made to the existing current document. If you re-create the document and use a new version number, you can use the Document Version History link to view prior versions of the originally generated document.

Warning! When you re-create a document, the system creates a new document using the latest transactions and document elements that are in effect as of the begin date of the source transaction. This is either the purchasing contract begin date or ad hoc begin date. You lose all changes to the original document.

Note. The Re-create feature can also apply to amendments when you are maintaining separate amendment files for the contract. You can also re-create documents for imported documents and their amendments. Depending on the process options you use to import the legacy document, the Recreate Document button may or may not appear.

Note. Features of the generation process are also used for creating executive summary documents. You can create and refresh a single executive summary document for a main contract document based on setup within the document type.

See Understanding Amendments for Imported Documents.

See Importing Contract and Ad Hoc Documents.

Refreshing Microsoft Word Documents

This section describes how the system refreshes bind variables and related content in a document. You refresh documents after you make changes to a contract transaction or document creation wizard binds. To refresh documents:

You select to refresh an existing document.

You use the Refresh Document button on the Document Management page to initiate the refresh. The system invokes the document creation wizard to enable refresh of wizard binds and uses the previous values as default values.

Note. The system uses the wizard that is defined for the configurator and that was used to generate the document the last time. So if you change the document creation wizard on the contract after initial generation, and the new wizard does not access all the binds that are used by the old wizard, then you may not be able to modify a wizard bind that is used by the contract.
The system evaluates the bind values in the document and compares them to current values in the transaction or document creation wizard.

If the system finds any differences, it replaces the old values in the document with their new values. In this case, the system does not alter other text elements that originate from the document generation or from manual changes to the document. However, exceptions occur.

If the system detects any value changes within a document structure, described in the Processing Terms Used in This Chapter section, then it completely rebuilds the related content in the document using the current definition of the elements it includes. In this situation, you might refresh the document and lose manual changes that were made to the document.

For example, assume that you generated a document that includes a repeating document structure that lists transactional contract line items. Later, you make manual changes to the document text that is related to those line items, and then add a new item to the transactional contract. Refreshing the document replaces the entire repeating document structure of the document. This is the parent repeating element and all its descendents. The new transactional line now appears, but the system removes the manual changes

Note. The system does not use the document configurator to rebuild document structures. Instead, it rebuilds the document starting with the parent element for the document structure and its descendent elements.

When rebuilding document structures in the document, the system uses the current effective-date definition for the content based on the begin date of the source transaction. So if an element in the hierarchy changes, the system might include element changes when it rebuilds the structure.

Before you use the Refresh Document button on the Document Management page, remember that the Refresh process starts with the bind values that are already on the document and compares those to the current values on the transaction or document creation wizard to determine where it needs to update the document. If a rule is true, then the document binds include those that are used on the rule, and those used on any elements included by the rule. If a rule is false, the system saves the rule in the document, hidden from view. In this case, the document binds include only those that are used on the rule, but not those that are used on objects that are attached to the false rule.

You should consider these points about how the system processes content when it refreshes a document:

Refresh of a rule document structure when a bind changes within the rule structure:
- Whether the rule was originally true or false, when the system detects a bind value in the rule document structure, it reevaluates the rule.
- If the rule was true and is still true, during the refresh, the system replaces the content that is related to the rule. The system adds the new content from the library as specified by the rule using the source transaction begin date. This situation occurs even if the rule binds did not change, but binds within the rule structure did change.
- If the rule was true and is now false, the system removes the content that is related to the rule from the document. However, the system keeps the rule as part of the document, but hidden from view, for consideration with future document refreshes.
- If the rule was false and is now true, the system inserts the content that is related to the rule into the document at the location where it originally placed the rule.
- If the rule was false, and is still false, and even if binds have changed on descendent elements, the system does not change the document.
Refresh of repeating document structure when a bind changes within the repeating structure.

The system rebuilds the entire document structure using the current version of the parent element and all descendents. Any manual changes that you make are lost.
Refresh of alternate document structure when a bind changes within the alternate structure.

The system checks alternate clauses with attached rules in their priority sequence order similar to the Generate process. Because of the change in bind values, the system can select an alternate clause that is different from the original clause used in the document. If a different clause is used, then the system includes corresponding descendents of that clause instead of the descendents on the original clause. The system bases alternate rules and clauses that it uses on the current version. Any manual changes that were made within the alternate document structure are lost
Refresh of elements not residing within a document structure.

The system does not modify any content. It replaces only old bind values with the new bind value and retains any manual changes.
Manual insertion of nonrepeating clauses in Microsoft Word:
- If you manually include a nonrepeating clause in the Microsoft Word document using the Research task pane in Microsoft Word, and the clause contains a nonrepeating bind variable, the system resolves the variable after you check in the document and click the Refresh Document button.
- If you insert a repeating bind variable in a Microsoft Word document, the system cannot automatically resolve the bind. It expands and resolves the repeating binds during the initial generation of the document.

Note. The Refresh feature can also apply to amendments when you are maintaining separate amendment files for the contract.

Viewing Document Generation Logs

This section provides an overview of log generation and discusses how to view generation logs.

Understanding Log Generation

During document generation, the system generates a log that you use to review the processing results that indicate how the system interpreted and built the document from the configurator. You can also use the log to resolve unexpected results. After it completes the generation process, the system displays a message that it has logged document generation issues.

The generation log provides you a view of how the system processed the document. The log is essential when you are building documents from complex configurators that contain document creation wizards, binds, rules, alternates, and repeating sections.

The generation log is the primary validation tool for use with document creation wizards and configurators. For example, you can define a wizard that enables document authors to branch through multiple paths that result in a variety of bind responses, rules, and related content. You can validate the wizard combined with the configurator when you generate test documents that exercise the various paths. The log validates that the proper content and bind variable resolution is taking place for each document creation wizard path that you define.

Two options are available for logging warnings and generation details. Logging options determine the content of the log. You can define the default value setting by using PeopleSoft Supplier Contract Management installation options. You can override the default value using the Log at Document Generation field on the Document Configurator Definition page.

Generation logging options are:

Details

This option logs more extensive information for document generation, including grids that contain:
- General warnings.
- Bind variables that are used in the document and their resolved values.
- Configuration expansion that shows how elements were included in the document.
- Rules that were evaluated.
- Extended document creation wizard log showing navigation choices and responses to wizard questions.
- Configurator selection wizard information.
Log Warnings and Wizard

This option includes warnings and document creation wizard summary information only. You should use this for configurators that are in production, especially complex configurators that require more complex processing. This logging option provides better overall performance for complex processing.

See Defining Basic Configurator Information.

Logging Errors and Messages

This table describes detail messages and warnings that are associated with document generation logging:

Messages	Cause and Resolution
Document contains no content. Content is possibly Empty, Inactive, Not Approved, or Future Dated.	This can indicate a problem with the configurator, elements in the library, or the begin date on the contract.
Wizard not specified on configurator but the document contains wizard variables.	The system will not resolve the variables in the document.
Bind variable value changed.	The value for the bind variable has changed since the document was created, refreshed, or re-created.
Refresh document, variable could not be resolved.	The system will not resolve the variables in the document.
Alternate not resolved.	An error occurred when the system created the alternate clause. You can proceed with the document, but you should review the alternates for the specified clause.
Rule could not be resolved.	An error occurred when the system resolved a rule. You can proceed with the document, but you should review the specified rule.
Rule resolved true.	During document generation, the system found the rule to be true and the applied the rule definition and criteria accordingly. Clauses attached to the rule will appear in the document.
Rule resolved false.	During document generation, the system found the rule to be false and will not include clauses that are attached to the rule in the document.
Variable not resolved.	The system found a bind variable (wizard or transactional) in the generated document, but could not resolve the variable. This might happen if a wizard bind exists in a clause or section, but was not answered as part of the wizard.
Effective-dated content inactive.	The specified element is effective-dated, but no active effective row exists. The content might have prior-dated or future-dated entries; however, the closest date prior to the current date is inactive.
Effective-dated content not approved.	The specified element is effective-dated, but the content has not been approved. The content might have prior-dated or future-dated entries; however, the closest date prior to the current date is active and unapproved.
Effective-dated content does not exist.	The specified element is effective-dated, but the date was not found. The content has effective-dated entries for only future dates.
Version in the document is not the most current.	The contract library has a more current version of this clause or section than the one used in the document you are copying. If you want to include the object, you can locate the most current version and place it in the document.
Version in the new document is more current.	The version of this object in the new document is more current than the version in the document from which the document was copied. Normally, this is because a rule or repeating section has been rebuilt. When a section is rebuilt, all manual changes to that section are lost.
Objects exists in new document but not the copy from document.	Normally, this is because a rule or repeating section has been rebuilt. When a section is rebuilt, all manual changes to that section are lost. Refer to the Configurator Expansion grid for more information.
Objects exists in copy from document but not in the new document.	Normally, this is because a rule or repeating section has been rebuilt. When a section is rebuilt, all manual changes to that section are lost. Refer to the Configurator Expansion grid for more information.

This table shows messages that appear in the Configurator Expansion grid action messages:

Messages	Cause and Resolution
Alternate considered.	Alternate Used: The system evaluated the alternate clause that was listed in the Content ID column and used it instead of the primary clause. Alternate Not Used: The system evaluated the alternate clause that was listed in the Content ID column and did not use it to replace the primary clause. For example, the alternate rule did not resolve to true.
Include.	Inserted by Clause: The content ID was included in the document because it was listed as a dependent to the clause object that was listed in the Source Content ID column. Inserted by Section: The content ID was included in the document because it was listed as a child to the section object that was identified in the Source Content ID column. Inserted by Rule: The content ID was included in the document because it was tied to a rule that was identified in the Source Content ID column that was evaluated to true. Blank: If the message column is blank, the content ID was included in the document because it was listed directly on the document configurator.
Include repeating.	Inserted by Clause: The repeating content ID was included in the document because it was listed as a dependent to the clause object that was listed in the Source Content ID column. Inserted by Section: The repeating content ID was included in the document because it was listed as a child to the section object that was identified in the Source Content ID column. Inserted by Rule: The repeating content ID was included in the document because it was tied to a rule that was identified in the Source Content ID column that was evaluated to true. Blank: If the message column is blank, then the repeating content ID was included in the document because it was listed directly on the document configurator.

Page Used to View Document Generation Logs

Page Name	Definition Name	Navigation	Usage
Generation Log	CS_DOC_WGEN_LOG	Supplier Contracts, Create Contracts and Documents, Document Management Click the Generation Log link on the Document Management page.	View generation logs.

Page Name

Definition Name

Navigation

Usage

Generation Log

CS_DOC_WGEN_LOG

Supplier Contracts, Create Contracts and Documents, Document Management

Click the Generation Log link on the Document Management page.

View generation logs.

Viewing Generation Logs

Access the Generation Log page (Supplier Contracts, Create Contracts and Documents, Document Management, and click the Generation Log link on the Document Management page).

The logging option that is specified on the Document Configurator Definition page determines the grids that appear for the Generation Log page.

Use this page to view document processing information. This information indicates system processing conditions and any warnings that were produced during the document's generation.

Logging occurs during processing for rules, alternate clauses, and resolution of binds. The system provides messages on this page that indicate what it is logging. The messages are:

No Warnings Logged	This message indicates that no warnings were logged during the generation of the document.
Logging Warnings and Wizard Only	This message indicates that the system is logging only warnings for transactions and document creation wizards based on the logging setting that is defined on the document configurator. When the configurator is set to only log warnings, the Bind Variables and Configurator Expansion grids are not available.

Generation Warnings

This grid describes warnings that the system generates when it processes a document.

Message	Displays the subject of the warning. See Understanding Log Generation.
Content Type	Displays the type of document content from which the system generated the warning. Examples of content types are rules, clauses, and sections.
Content ID	Displays the content's object name. This is the name that was assigned to the content during its creation.
Source Content Type	Displays the parent content type (section, rule, clause) for the source content ID.
Source Content ID	Displays the parent content object ID in which the specified content ID is a child or is dependent.
Bind Type	Displays the type of bind for which the system logged the message. Values are Transactional, which retrieves data values from source transactions, and Wizard.
Bind Variable	Displays the system identifier for the bind variable for which the system generated the warning. When the system generates a document, it replaces bind variables with either transactional values or values that are supplied by the document creation wizard.
File Type	Displays whether the log is for an actual document or for an attachment file. When you re-create documents, you can re-create only the document, only the attachment, or both. The process logs both types. Main indicates that the log is for the core document and Attachment indicates that the log is for an attachment file.

Wizard Log

Use this grid to view logging entries for document creation wizard that the system processed. The system always logs wizard details, regardless of the value in the Log at Document Generation field on the Document Configurator Definition page. When the value is Details, all the wizard questions appear in the log. When the value is set to Log Warnings and Wizard, only the questions that the document author saw when running the wizard appear in the log.

Question Group	Displays the question group for the document creation wizard to which the listed question belongs.
Display Sequence	Displays the display order in which the question appears to the author.
Question	Displays the question as it appeared to the author.
Answer	Displays the answer that the author provided for the question.
Bind Variable	Displays the bind variable that is associated with the question.
Group Sequence	Displays the group sequence number that was specified on the question group definition for the question. If any of the questions were navigational questions and jumped to a specific sequence number, this is the sequence number that is referenced in that setup.
Navigate	Describes the system navigation after a question was answered by the author. When the field is blank, it indicates that navigation was not defined for that question. Other values are: Next Group: Indicates that the system went to the next question group after the question was answered by the author. Next Question: Indicates that the system went to the next question in the question sequence after the question was answered by the author. Specific Sequence Number: Indicates that the system went to a specific question in the question group after the question was answered. This might happen based on the response to a question when the next question in the set is not required.
Jump to Group Sequence	Displays the sequence number that the system accessed after this question was answered. It is based on the navigation option of Specific Sequence Number.

See Setting Up Question Groups for the Contract Wizard.

Document Copy: Basic Info Tab

Use this grid to review information about documents that have been created using the Copy Document feature. The grid displays messages about the document contents. This includes messages, content type, ID, and description, and an explanation of the message. Select the Details tab to review the explanation.

See Copying Documents Using Document Management.

See Copying Existing Purchasing Contract Documents.

Configurator Selection Wizard

Use this grid to review the generation process when the system generates a document using a configurator selection wizard. This grid is similar to the Wizard Log grid, except it provides additional navigation information and the configurator ID used by the configurator selection wizard to create the document.

The values in the Navigate field define whether the configurator was defined for the wizard or if the configurator was selected based on the answers to wizard questions. The value in the Configurator ID field is either the predefined configurator or the configurator the system selected based on answers to configurator selection wizard questions.

See Understanding the Contract Wizard.

Bind Variables: Log Tab

Use the Log tab grid to view information on the resolution of bind variables.

Occurrence	Displays the occurrence sequence. An occurrence is similar to a line number. Occurrences that are equal to zero are header-level variables. The system uses them anywhere in the document, but the data comes from the header record or the contract document creation wizard. Occurrences that are greater than zeros relate to each occurrence of a repeating structure, such as lines for purchasing contracts, in the document. For example, if the contract contains 10 lines and all 10 lines are included in the document, the occurrences are one to 10. However, if only 5 of the 10 lines are in the document, then the occurrences are 1 to 5.
Bind Type	Displays whether the bind is a wizard or transactional bind. Wizard type binds are those that are used with the document creation wizard. Transactional type binds originate from a source transaction. Nonwizard binds are also available, such as those that are related to the purchasing transactional contract or ad hoc binds.
Bind Variable	Displays the bind variable identifier.
Variable Value	Indicates the value that the system inserted in the document to replace the bind variable.
Bind Change Type	Displays the type of change that the system made to a bind when the bind was refreshed.
File Type	Displays whether the log is for an actual document or for an attachment.

Bind Variables: Wizard Details Tab

Select the Wizard Details tab in the Bind Variables grid.

Use this grid to view information about bind variables that are used in the document creation wizard. Fields in this grid are the same as those in the Wizard Log grid.

Display Sequence	Displays the display order in which the bind appeared to the author. This number is the same as the number shown in the Wizard Log grid and can be used to link the two together.
Question Group	Displays the question group for the document creation wizard from which this bind came.

Configurator Expansion

Use this grid to review log warnings and details about how the system processed the document configurator during document generation.

Action	Displays the action that was taken by the system when it generated the document. See Understanding Log Generation.
Generate Position	Displays the outline position to which this document content belongs in the document. This number is an internally generated number that the system uses to sequence the content as it is expanded for use in the document. This number may not exactly match the Microsoft Word Outline number that appears in the actual document because it does not use paragraph numbering in the document. The field also includes expansion information for items that may ultimately not be used in the final document. These might be, for example, rules that the system evaluates to false. The system uses outline numbering in logging only to assist you in understanding the order of the elements and their relationships to each other.
Content Type	Indicates whether the corresponding type for the content ID is Clause, Section, or Rule.
Content ID	Displays the name of the clause, section, rule that appears in the Content Type field.
Message	Displays more information that is associated with the action. See Understanding Log Generation.
Source Content ID	Displays the parent content ID that resulted in the action. This is applicable only for certain actions and messages.
File Type	Displays the file type that this row belongs too. Document types include Main and Amendment.