Viewing Document Generation Logs

Page Name	Definition Name	Usage
Generation Log Page	CS_DOC_WGEN_LOG	View generation logs.

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 Setting Up Document Configurators.

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.

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.

Use the Generation Log page (CS_DOC_WGEN_LOG) to view generation logs.

Navigation:

Supplier Contracts > Create Contracts and Documents > Document Management. 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:

Field or Control	Description
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.

Field or Control	Description
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.

Field or Control	Description
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 a 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 the Copy Document Page and the Copy Document Page for Purchasing contracts.

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 Configurator Selection Wizards.

Bind Variables: Log Tab

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

Field or Control	Description
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.

Field or Control	Description
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.

Field or Control	Description
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.