This chapter provides an overview of supplier contract setup and discusses how to:
Set up supplier contract attachment FTP servers and directories.
(Optional) Set up Microsoft Word components on workstations.
Define installation options for Supplier Contract Management.
Define clause libraries and groups.
Set up approval types.
Establish clause classes.
Map bind variables.
Set up document configurator groups and types.
Define document templates and styles.
Define default settings for document formats and options.
Set up user preferences.
Note. PeopleSoft Supplier Contract Management uses Microsoft Word 2003 Professional version and Microsoft Office Word 2003 Markup
Language (Microsoft WordML) extensively for document authoring. There are certain multi-byte characters in Microsoft Word
that cannot be supported when you integrate with a nonmulti-byte PeopleSoft database for clause content in the library. If
you are not using a Unicode Standard database, you should not use these special characters. This exception applies to library
setup because the system stores this content in its database. This exception does not apply to modified documents after they
have been generated.
You also must set up PeopleSoft Supplier Contract Management to enable syndication, contract agreements, approvals, and Verity
searching. This chapter does not provide setup requirements for these features. See the corresponding chapters for setup information
about these features.
This chapter discusses the general setup information that the system uses to control the document authoring system. Using supplier contract authoring for transactional purchasing contracts and ad hoc document generation requires basic setup to enable authoring. For example, basic document authoring includes:
The setup of file FTP (file transfer protocol) directories for file storage.
An attachment file-transfer program server and its appropriate directories must be available for use by the system to store and retrieve files used for the clause library and authored documents.
The installation of Microsoft Office Word 2003 on workstations for users interacting with the system. This is a requirement.
A basic library setup.
You use several core setup features to provide the basis for managing the contract library and to establish basic elements of documents. Clause groups and libraries and configurator types and groups help you to organize the library while approval types and clause classes assist in the document approvals.
Bind definitions, mappings, and source transaction structures enable the document authoring system to apply transactional values to clauses. You can also use these binds in rules.
Optional configurations.
These include:
Setting up Microsoft Word components on workstations.
This feature enables selected users to interact directly with the PeopleSoft database from within Microsoft Word to retrieve bind values and clause content.
Comparing and rendering document capability.
This feature enables users to create system-generated comparisons of a current authored document to a regenerated or refreshed version of the document. It also enables the rendering of the .xml authored document into a Microsoft Word .doc format. You should configure for this feature if you intend to dispatch documents externally in a .doc format versus the default .xml format that requires the use of Microsoft Word 2003.
Installation options and user preferences.
These setup features support a variety of processes including approvals, syndication, document comparisons, and Verity searches.
See Also
Understanding Contract Agreements
Setting Up Contract Syndication
This section discusses how to add file transfer protocol servers.
Page Name |
Object Name |
Navigation |
Usage |
SAC_ATT_ADMIN |
Set Up Financials/Supply Chain, Common Definitions, File Attachments, Administer File Attachments |
Add file transfer protocol servers for supplier contract attachments. Click the Add FTP Server button on the Administer File Attachments page to add server information. Note. The Supplier Contract Management application does not support database server types. |
Access the Administer File Attachments page.
Prior to accessing a component in the system that stores or retrieves files, you must set up an attachment file-transfer program server and its appropriate directories. The system stores and retrieves attachments for Supplier Contract Management from the server locations that are defined on this page.
System administrators can configure one or more servers to store attachments. These servers can be FTP servers only. Using this page, system administrators set up new servers and identify the active server. They can add or modify the FTP root folder and the component-specific subfolder for FTP servers. Administrators set up the attachment server and directories to operate:
Microsoft Word document templates.
Clauses.
Sections.
Document configurator maintenance.
Contract entry agreement attachments.
Agreement result attachments.
Document maintenance.
Use this grid to add FTP servers. Click the Add FTP Server button to add a server.
Pick Active Server |
Select the server ID that you want to make active for the entire installation. |
ID (server ID) |
Displays the system-assigned ID number for each server on this page. When an attachment is stored on the server, the server ID is inserted into the attachment record. When you request to download (view) this attachment, the system retrieves it from the original server based on the server ID. |
Type |
Identifies the type of server based on whether you click the Add FTP Server button or the Add Database Server button. After you save the row and quit the component, you cannot change the server type. Values include: FTP (file transfer protocol server) and DB (database server). Note. Supplier Contract Management does not support the database server type. |
Login |
Enter or change the login name. This is required for FTP servers. |
Password |
Enter or change the password corresponding to the login name. The password is required for FTP servers. |
Server/Record Name |
Enter a value for both FTP servers and database servers. For FTP servers, enter the machine name. After you save the information, the machine name should be changed only if the same FTP server is renamed. To add a different FTP server, click the Add FTP Server button to insert a new row into the grid and define the new server. You cannot delete servers, because attachments could already be stored on them. |
Path |
Enter the subdirectory path under the server's FTP root where all attachments are to be stored. This is a required field for FTP servers. |
Add FTP Server |
Click to insert a new row in the grid to define a new FTP server for attachments. |
Add Database Server |
Click to insert a new row in the grid to define a new database server for attachments. Note. Supplier Contract Management does not support the use of database servers. |
Component Subdirectories
Use this grid after you set up the attachment server to specify specific server subdirectories for the appropriate components. This enables you to segregate and better manage files on the file server as they pertain to contracts. The next table provides examples of how you can set up subdirectories. You can select any path name you want for a subdirectory. You set up subdirectories for these components:
Component |
Path Example |
Description |
CS_CLAUSE_DEFN |
Clause |
Stores clause information for Microsoft Word 2003 editing. |
CS_CNT_AG_RESULT |
AgreeResult |
Stores contract agreement results that are attachments. |
CS_CONTRACT_ENTRY |
TransContract |
Stores transactional contract-entry related attachments. |
CS_DOC_MAINT |
AuthoredDocs |
Stores generated contract documents. |
CS_SECTION_DEFN |
Section |
Stores section information for Microsoft Word 2003 editing. |
CS_TMPL_TBL |
Configurator |
Stores ad hoc document configurator clauses for Microsoft Word 2003 editing. |
This section provides an overview of the setup necessary to install and configure Microsoft Word components on workstations. This enables users to interact directly with the PeopleSoft database from which they can retrieve bind values and clause content.
Microsoft Office Word 2003 integration is a core requirement of PeopleSoft Supplier Contract Management. You can use Microsoft Word directly to check out, and edit clauses, sections, ad hoc configurator clauses, and contract documents. In addition to standard editing of content with Microsoft Word, an optional, real-time integration between Microsoft Word and the PeopleSoft clause library is available. This integration enables clause librarians to search for bind variables when developing clause content. The integration also enables contract specialists and collaborators to search for clauses while maintaining the authored contract.
For example, if you are creating a contract clause that requires an inspection process that has been described in another clause, you don't have to navigate to and view the clause using application pages. You can use the Research task pane functionality to search for the clause directly from Microsoft Word and insert the content of the clause or alternate clause directly into the document that you are creating.
See Installing and Configuring Microsoft Word Components on Workstations.
PeopleSoft delivers setup files on the product installation CD that are necessary for this integration. A setup directory containing files for installing and configuring Microsoft Word is available on the CD when you follow this path: setup\SupplierContractMgmt\eng.
Note. You can install the CD to the path you choose.
This setup utility must be run on the workstation of each user who wants to use the Microsoft Word integration with Supplier Contract Management. The setup files add information to the registry that is specific to Microsoft Word, which shows up as two additional Microsoft Word Research task pane services. Within Microsoft Word, you can enable the Research task pane by selecting the Alt key and clicking the mouse. You can also access the page by selecting Tools on the toolbar, and then selecting Research from the menu.
When you open the Research pane, the drop-down menu displays the search values PeopleSoft Search For Clauses and PeopleSoft Search for Binds.
To enable this functionality, you must update the config.txt file in the directory before you run the setup.exe program. The config.txt file contains information that needs to correspond to the PeopleSoft environment configuration. Uniform resource locators (URLs) that are listed in the file need to point to the machine name of the gateway that has been configured for the database for messaging. In addition, you need to update the URLs to contain the corresponding default local node for the database. The config.txt file contains < > markers that indicate what you need to update. Update these URLs:
ClauseQueryPath=http://<insert server name here> /PSIGW/PeopleSoftServiceListeningConnector?From=PSFT_XINBND &To=<insert default local node here> &MessageName=CS_SEARCH_CLAUSES&MessageVersion=VERSION_1 ClauseServiceName=Peoplesoft Search For Clauses BindQueryPath=http://<insertserver name here> /PSIGW/PeopleSoftServiceListeningConnector?From=PSFT_XINBND &To=<insert default local node here>&MessageName= CS_SEARCH_BINDS&MessageVersion=VERSION_1 BindServiceName=Peoplesoft Search For Bind Variables
Here is an example of how the URLs appear after you insert the machine name for the gateway and the default local node:
ClauseQueryPath=http://ple-machine/PSIGW/PeopleSoftServiceListeningConnector?From= PSFT_XINBND&To=PSFT_EP&MessageName=CS_SEARCH_CLAUSES&MessageVersion=VERSION_1 BindQueryPath=http://ple-machine/PSIGW/PeopleSoftServiceListeningConnector?From= PSFT_XINBND&To=PSFT_EP&MessageName=CS_SEARCH_BINDS&MessageVersion=VERSION_1
Use the Gateways page to setup and define the gateway. To access the page, select: PeopleTools, Integration Broker, Configuration, Gateways.
While you must update the machine name for the server and default local node (the to parameter) in the config.txt file, you need to change the PSFT_XINBND message node only if you want to change the message node to which the message transactions are linked. PeopleSoft delivers the transactions linked to the PSFT_XINBND node.
The following labels in the config.txt file appear in the Microsoft Word Research task pane as the service names. You can change the labels.
BindServiceName=Peoplesoft Search For Bind Variables ClauseServiceName=Peoplesoft Search For Clauses
Note. When you are working with Microsoft Word, you do not need to be signed in to a database; however, the gateway for the database to which the config.txt file points must be running. If it's not running, the search does not produce results. The system uses a synchronous message to which it posts the request in the Research task pane and the reply is a message with any clauses or binds in it.
To prepare a system to use messaging for bind variable and clause searches:
Ensure that a Microsoft Windows-based server machine, such as Windows 2000, has PeopleTools installed on it.
The machine must be set up as an application server in the system. The PeopleTools installation on this machine must have the file %PSHOME%/BIN/SERVER/WINX86/ CSDOCUTIL.DLL. This file enables server-side processing of Microsoft Word files.
Ensure that the same server machine has Microsoft Word 2003 installed on it.
The CSDOCUTIL program interacts with Microsoft Word 2003 on the machine.
Use the Application Designer to activate the CS_SEARCH_BINDS and CS_SEARCH_CLAUSES messages.
To activate the messages:
Open each message.
Click the Properties button.
Select the Use tab.
Select the Active check box.
Open the CS_DOC_CHL message channel.
Click the Properties button.
Select the Use tab.
Click the Run button.
Configure the Integration Gateway if not already configured for the database.
See Enterprise PeopleTools 8.46 PeopleBook: Integration Tools.
Set the transaction in the node definition to Active.
You should define this transaction on the default local node for the database.
To set the transaction in the node definition:
Select PeopleTools, Integration Broker, Integration Setup, Node Definition.
Click the PSFT_XINBND link.
Select the Transaction tab.
Click the Edit link for both the CS_SEARCH_BINDS and CS_SEARCH_CLAUSES messages.
Set both messages to Active using the Status field and click Save.
Microsoft Office 2003 helps you edit clauses and contract documents through the use of task panes. These tools provide a variety of support such as searches, cutting and pasting, XML schema display, and style formats. You can set task panes to open automatically when you perform certain tasks or you can open it as you need.
After you set up the messages and integration gateway, you can install and configure Microsoft Word for use with task panes, including the Research task pane for bind and clause searches.
To install and configure Microsoft Word:
Modify the config.txt file that is included in the setup directory before running the setup.exe program.
After updating the config.txt file, disseminate all files in the setup directory to user machines for configuration and complete the remaining steps on each machine.
Close all instances of Microsoft Word.
Run the setup.exe program.
Define the folder where you want to store the .dll file you use to integrate Supplier Contract Management with Microsoft Word.
Open Microsoft Word; the version must be Microsoft Word 2003 or greater.
Select Tools, and then select Research.
The Research frame appears on the left side of the window.
Enter a string or word in the Search for field.
When searching for a clause value, the system searches through the clause IDs, descriptions, and titles. When searching for binds, the system searches through bind names and descriptions. The search is not case sensitive.
Select a value from the list that is below the Search for field.
Select PeopleSoft Search for Bind Variables to search for binds.
Select PeopleSoft Search for Clauses to search for clauses.
Note. These values are delivered by PeopleSoft; however, you can change them in the config.txt file.
Click the button with the green arrow to initiate the search.
The button changes to red as the system performs the search. When the search is complete, the system displays the results of the search in the Research frame. All results that meet the search criteria appear in the frame.
Note. Due to Microsoft Word size limitations, the system only returns the first 20 clauses that meet the search criteria. If more than 20 clauses meet the search criteria, the system displays a message at the top of the results that indicates only the first 20 results appear.
The following example shows how the Research task pane might appear after you have performed a search for the word Inspect in a clause ID, description, or title:
When you search for a clause, the frame displays the first 300 plain-text characters of full text and by reference text defined in the clause definition. You can use the Actions button to insert either the formatted full text or by reference text into the document that you are maintaining.
When you search for binds, you use the Actions button to insert the bind value and markers where the cursor is positioned in the Microsoft Word document.
Note. You can uninstall the Microsoft Word integration by running the setup.exe program again.
See Also
Understanding Microsoft Word Integration with Supplier Contract Management
This section provides an overview for document comparisons and rendering and discusses how to define installation options for PeopleSoft Supplier Contract Management.
Document comparisons enable you to compare the current document to a temporarily regenerated, refreshed, or last-executed document. Last-executed documents are only available when you are working with amendments. The system compares the current document to a temporary document using the normal Microsoft Word Compare Document feature without you accessing it through Microsoft Word.
The resulting output document highlights the differences between the current document and the temporary document that you chose to compare to the current document. You can use this feature to determine what the impact of doing a document refresh or regeneration would be and what changes you would lose or gain.
Document rendering is when the system provides files in a .doc format to users who use an earlier version of Microsoft Word than the 2003 version. When the system creates XML documents, they are meant to be opened with Microsoft Word 2003 only. If suppliers do not have this version available to them or if they prefer to review the documents in a .doc format, then you use the Installation Options component to set up information enabling the system to convert the documents from an XML format to a .doc format.
Conversion to a .doc format is only available as an option when you send documents to contacts or dispatch documents during the document life cycle. When you send the documents, the system converts the documents that are attached to the email to .doc file formats.
To compare and render documents, you must enable the features using Installation Options component.
To prepare a system to use the compare and render features:
Ensure that a Microsoft Windows-based server machine, such as Windows 2000, has PeopleTools installed on it.
The machine must be setup as an application server in the system. The PeopleTools installation on this machine must have the file %PSHOME%/BIN/SERVER/WINX86/ CSDOCUTIL.DLL. This file enables server-side processing of Microsoft Word files.
Ensure that the same server machine has Microsoft Word 2003 installed on it.
The CSDOCUTIL program interacts with Microsoft Word 2003 on the machine.
Use the Application Designer to activate the CS_DOC_ACTION message.
To activate the message:
Open the message.
Click the Properties button.
Select the Use tab.
Select the Active check box.
Open the CS_DOC_LIBRARY message channel.
Click the Properties button.
Select the Use tab.
Click the Run button.
Configure the Integration Gateway if not already configured for the database.
See Enterprise PeopleTools 8.46 PeopleBook: Integration Tools.
Set the transaction in the node definition to Active.
You should define this transaction on the default local node for the database.
To set the transaction in the node definition:
Select PeopleTools, Integration Broker, Integration Setup, Node Definition.
Click the Node Name link for the node defined as the default local node.
Select the Transaction tab.
Click the Edit link for each of the CS_DOC_ACTION messages.
Set both messages to Active using the Status field and click Save.
Complete the fields in the Document Compares & Rendering grid in the Installation Options component.
After completing these steps can convert documents to a .doc format and compare documents using the Document Management page.
Page Name |
Object Name |
Navigation |
Usage |
INSTALLATION_CS |
Supplier Contracts, Supplier Contracts Setup, Installation Options Click the Supplier Contract Management link on the Installation Options page. |
Define installation options for PeopleSoft Supplier Contract Management. |
Access the Installation Options page.
Use this page to define servers, server paths, compare and render options, verity searching, syndication options, and required approvals.
Use this group box to define default server locations for use in the file creation processes within PeopleSoft Supplier Contract Management.
Application Server Path |
Enter a directory that is on the server where the system creates temporary server-side files. For example, when the system generates authored documents, it uses this temporary document on the application server to create the file prior to transferring it to the FTP server. You might want to select a directory such as c:\temp, which exists on Windows NT application servers. |
Document Compare and Rendering .Doc Word Files
Use this group box to enable server-side Microsoft Word processing. This includes comparisons of the current authored document with a temporarily created version of a refreshed or regenerated document. After you enable server-side processing, the system makes a Compare button available on the Document Management page.
Also, you can optionally create a Microsoft Word .doc version of the Extensible Markup Language (XML) generated documents to send to suppliers who might be using a version of Microsoft Word prior to Microsoft Word 2003. After you enable rendering, the system displays the Send in .doc Format check box on the Send to Contacts and Dispatch to Contacts pages.
Enable Compare Functionality |
Select to permit the document administrator to run a server-side comparison of the current authored document against a regenerated version or refreshed version of the document. The comparison displays the differences and is for information purposes only. |
Enable Rendering .doc |
Select to permit the generation of a .doc format document when dispatching a document or sending it to contacts. You select this check box in case a supplier does not use Microsoft Word 2003 and cannot read an .xml version of the file. |
Compare/Render Server/Path |
Enter a directory path name for the Windows NT application server that will serve as a temporary location for document processing for server-side comparisons and document rendering of .xml documents. An example of a temporary location might be c:\temp. |
Compare/Render Server URL (compare/render server uniform resource locator) |
Enter the machine name of the Windows NT application server and port that has been set up with Microsoft Word 2003 and the CSDOCUTIL.DLL file. |
Use this group box to specify Verity index search options. PeopleSoft Supplier Contract Management uses Verity searching to perform content searches on elements in the library. For example, you can search clauses and sections, the latest versions document content, and transactional-related contract data for purchasing contracts.
Chunk Size |
Enter the number of returned rows that you want to retrieve and display when you perform a Verity search. If you do not enter a value, the system retrieves 20 rows at a time. |
See Searching for Library and Document Contents.
See Implementing the Verity Search Engine.
Processing Options
Use this group box to define processing options for syndication and documents. Syndication is the exchange of contract information between PeopleSoft contracts and third-party systems. Using syndication, the system publishes contract information from PeopleSoft Purchasing contracts to third-party systems. This enables the third-party system to create the contract. Using syndication, the system can also receive and consolidate contract performance information from third-party systems.
The syndicate options control additional information that the system might publish with the contract. Depending on the capabilities of the remote system as well as the consistency of setup data between the two systems, you might not want to syndicate this optional information.
The default value for all check boxes in this group box is cleared.
See Syndicating Supplier Contracts and Contract Messaging.
Approvals Required
Use this group box to define high-level information for supporting collaboration workflow and approvals.
Clause Approval |
Select to indicate that approvals are required for clauses. When you select this check box, the system enables workflow approvals for clauses. If you do not select this check box, the person maintaining the clause can set the clause status to approved. See Setting Up Approval Types. See Establishing Clause Classes. See Configuring the Approval Workflow Engine for Use with Supplier Contract Management. |
Document Approval |
Select to indicate that approvals are required for documents. If you select this check box, the system requires the document administrator to submit documents for approval. If you do not select this check box, the document administrator can click the Approve button to approve the document for final dispatch to supplier for signature. |
Document Reapproval After Edit |
Select to indicate that if a document is edited after being approved, it must then be reapproved. Depending on organization internal controls for documents, this may or may not be required. |
Collaboration Notifications |
Select the method that the system should use to notify collaborators when they are listed as collaborators in the document collaboration process. Valid Values are: Email: Select to use an email notice to alert collaborators that a collaboration is waiting for them. Email and Worklist: Select to notify collaborators using both notification methods. None: Select to indicate that a notification is not required. User Preference: Select to use a combination of generic templates, which include user roles and PeopleCode application classes, to notify collaborators for clause and document approvals. Worklist: Select to use an automated to-do list that routes work items. From the worklist, collaborators can directly access the pages that they need in order to perform the next action for a document, and then return to the worklist for another item. |
Collaboration Routing Template |
Select the generic template that the system should use in routing documents for collaboration. This template controls the format of information for email notifications when the system routes a document for collaboration. See “Using Generic Templates,” Using Notification Templates, Enterprise PeopleTools 8.46 PeopleBook: Workflow Technology. Predefined values are: CS_ClsRteApproval: Route for Approval CS_ClsRteReview: Route for Review CS_ClsApprove: On Final Approve CS_ClsDeny: On Final Deny CS_ClsTimeout: On Timeout |
Collaboration Done Template |
Select the template that the system should use when collaboration has been completed for a document. The template controls the information that appears in the email to the administrator when collaboration is completed. |
This section provides an overview of clause libraries, groups, and classes, and discusses how to:
Define clause libraries.
Define clause groups.
You use clause libraries to define a broad grouping of contract clauses. Each clause can belong to only a single library code. Library codes provide a simple method to categorize a complete set of clauses. You can use library codes as search criteria when searching for clauses.
Use contract clause groups to help organize and categorize clauses. Clause groups provide a user-defined means for categorizing clauses as needed. For example, you might have a group of clauses relating to indemnification for work that is performed at the buyer’s site. You can associate member clauses with a clause group for work-site indemnification and then address or select the clauses as a group when creating a document configurator.
Note. A clause can belong to more than one clause group at a time.
Clause classes provide another user-defined method of categorizing clauses, particularly for the purposes of clause approvals. Each class contains a description and an optional list of approval types, including a default that enables you to define how the clauses of that class are to be approved. For example, when you create a new clause, you must specify a class. Depending on the class that you select, the system can supply the appropriate workflow for the class by default based on the presence of an approval type on the class.
In addition, you can define alternate approval types on the class. This enables you to further select the appropriate workflow if needed. For example, you can choose to use the class as a higher level category of clauses with zero to n appropriate approval types and descriptions. This enables you to select the appropriate routing, or conversely use the class to define a more detailed grouping, such as a high risk factor, and force a single approval type for the class that cannot be altered by other users.
See Also
Page Name |
Object Name |
Navigation |
Usage |
CS_LIBRARY_DEFN |
Supplier Contracts, Supplier Contracts Setup, Libraries |
Define clause libraries. |
|
CS_CLS_GROUP_DEFN |
Supplier Contracts, Supplier Contracts Setup, Groups |
Define clause groups. |
Access the Library Definition page.
Use this page to define a clause library. To establish a library, enter a library name and description. If you leave the fields blank, you can update them later.
After you establish a library, you can assign contract clauses to it using the Library field on the Clause Definition page. To access the field, select Supplier Contracts, Manage Contract Library, Clauses.
Note. Clause library codes provide a means for a simple broad grouping of clauses. They do not control clause access or row-level security. Permission lists and setIDs control access to clauses.
Access the Group Definition page.
Use this page to add and update clause group definitions. You can use groups to categorize clauses. When selecting clauses for use on document configurators, you can use clause groups as search criteria. You can associate contract clauses with groups by clicking the Associate to Clause link on the Clause Definition page. To access the field, select Supplier Contracts, Manage Contract Library, Clauses.
You can add all clauses that are related to a group to a document configurator or section, but the intent is only for aiding the selection of clauses during clause addition to the configurator. For example, after you add clauses by group, the clauses are individually maintainable within the configurator as if you added them individually.
Note. You cannot add a group as a dynamic object to a section or to a document configurator.
To add a clause group:
Enter the name of the group in the Group Name field and click Add.
Type a description of the clause group and click Save.
To add clauses directly to the group, select an existing clause ID in the Clause ID field.
You can also add a clause to one or more groups while maintaining the clause by clicking the Associate to Clause Group link on the Clause Definition page.
Groups can contain multiple clauses, and a clause can be included in one or more groups.
This section provides an overview of approval types and discusses how to define approval types.
An approval type is a part of the workflow process and controls approvers for the clause approval process and document approval process. Because approval types are associated with clause classes, you use approval types to define the types of approvals that are required for a class of clauses.
Each approval type has an associated role name. The system uses the role name to determine the group of users that it uses in the approval cycle for a clause or document. The system includes all users who have this role in their user profile in the approval process. Each approval type also has a number of configurable approval settings that determine when role users are used in an approval cycle. Check boxes control the approval settings and determine whether:
An approval is required for a clause definition that is associated with the combination of class and approval type.
An approval is required for clause usage in a document.
The system uses role users in the contract approval process when a clause that the contract uses is associated with the combination of class and approval type.
An approval is required for clause changes, including deletion, in a document.
The system uses the role users in the contract approval process when a contract both uses and modifies a clause that is associated with the combination of the class and approval type.
The following examples describe clause definitions and clause usage.
For a clause definition, when the system starts the approval process and accesses the Approval Status page for a clause, it determines the correct approval role names based on the clause class and approval type that is specified on the clause. If the Clause Definition check box is selected for the approval type, then users who have the associated role in the Approving Role Name field will be notified to approve the clause definition.
When using a clause, the system starts the approval process and checks the Approval Status page for a document to be approved. It determines the correct approval role names based on the clause class and approval type that is specified on the clause. If the approval type has the Clause Changes in Doc check box or the Clause Exists in Doc check box selected, then users with the associated role in the Approving Role Name field will be notified to approve the clause use or changes in the document approval process.
To create and apply approval types:
Create the approval type and select the types of clause definition or usage approvals for each approving role name that you add to the approval type.
Add the approval type to the clause class definition.
This links the roles to a class. To define the clause class, select Supplier Contracts, Supplier Contracts Setup, Classes. Specify which approval type is to be the default for the class definition. When a clause is defined, this default approval type is displayed and entered for you.
Create a clause using the clause class with which the approval type is associated.
When you create the clause, the system creates the link between the approval settings from the approval type definition and the specific clause definition. The approval types are associated with classes on a separate configuration page. Each class can have multiple approval types with a default type, but you can select any of the configured approval types that are available for the class.
See Also
Configuring the Approval Workflow Engine for Use with Supplier Contract Management
Page Name |
Object Name |
Navigation |
Usage |
CS_APPROVAL_TYPE |
Supplier Contracts, Supplier Contracts Setup, Approval Types |
Define approval types. |
Access the Approval Type page.
The system uses the approval type that you define on this page for clause approvals. You can include users who are associated with the role name as collaborators in the approval process.
This section discusses how to set up classes.
Page Name |
Object Name |
Navigation |
Usage |
CS_CLS_CLASS |
Supplier Contracts, Supplier Contracts Setup, Classes |
Set up classes for document clauses. |
Use this page to classify clauses and map the clause classes to approval types. This enables the user to use those classes that require workflow approvals for the clause definition itself or within documents. At least one class must be defined. One class can also be designated as the default for new clauses. When a class is associated with a clause, the default approval type is supplied as well for that clause. This determines the behavior for the clause in terms of its approval process and approval for use. If approvals for particular classes of clauses are not required, leave the Approval Settings grid empty.
Class Name |
Displays the name of the class. If you are adding a class, the field is required. |
Default |
Select to make this clause class the default class value when a clause is defined. You can select only one class as a default. |
Approval Type |
Select an approval type for use with this clause class. The system uses the approval roles and settings that are contained in the approval type definition to control workflow routings. You can't select duplicate approval types. |
Default |
Select which, if any, approval type you want to be the default value when this clause class is used for collaboration. If you select a type, that type appears when you select this class for use with a document clause. You can change the approval type on the clause, but it cannot be cleared and always returns to the default approval type. This ensures that all clauses that are related to this class can be designated for workflow processing. |
This section discusses how to:
Define source transaction structures.
Map binds.
Page Name |
Object Name |
Navigation |
Usage |
CS_SRC_TRANS_STRCT |
Supplier Contract, Supplier Contracts Setup, Source Transaction Structures |
Define source transaction structures. |
|
CS_BIND_MAPPING CS_SRC_TRANS_STRCT |
Supplier Contract, Supplier Contracts Setup, Bind Mappings |
Map binds. |
Access the Source Transaction Structures page.
Use this page to define the hierarchical structure of source transaction structures for purchasing contracts. After defining the structure, you can associate a bind variable with the actual record or view and field name from which you want to retrieve data.
See Mapping Binds.
Note. PeopleSoft delivers predefined source transaction structures as system data. You cannot change these delivered structures.
Source Record |
Enter the core transactional record for each data level to which all views need to be linked when you enter bind mappings. |
Level |
Enter a numeric value that indicates the level in the record hierarchy at which the source record exists for the indicated source transaction. The system uses the level to validate binds, which ensures the proper setup of repeating elements. |
Parent Record |
The parent record is the record that the specified source record relates to in the hierarchy. If the source record is at a level greater than zero in the structure, then you must define the correct parent record. This helps to resolve repeating binds during the generation of document elements. If the level is equal to zero, then the parent and source record should be the same, which also helps ensure that document elements are used in the correct parent and child relationship. |
Access the Bind Mappings page.
Use this page to map bind variables to record views and source records.
Source Transaction |
Displays the source transaction. The transaction can be ad hoc or purchasing contract. |
Record View |
Select the view from which the system gathers data is uses to resolve the bind in authored documents. |
Source Record |
Select a source record. These are the records that have been defined as source records within source transaction structures. Only records that are defined as source records are available for selection. The source record is the base record for the record view fields. |
Level |
Displays the level in the source transaction structure at which the source record resides. |
Parent Record |
Displays the parent record associated to the source record. This is based on information in the source transaction structures. For example, the contract header record is considered a parent record for contract line records. |
Bind Variable |
Select a bind variable. Only transactional type variables are available for use. The system validates that a bind is not entered for more than one record or view. |
Field Name |
Select a field that the bind variable maps to in the record view. During document generation, the system replaces bind placeholders in document elements with the actual value that corresponds to this field name in the record view. |
Display Type |
Displays a list of display options when the field that you entered is an XLAT field. This enables you to indicate that you want to display the XLAT short name, XLAT long name, or the actual code in the actual contract. If you are using this bind in a rule criteria, then the criteria always needs to use the code. This field is only for display purposes in an authored document. |
This section provides an overview of configurator groups and types and discusses how to:
Define configurator groups.
Define configurator types.
Configurator groups and types assist you in organizing document configurator information. While the system does not use the groups and types for validation purposes, you can use them for informational and searching purposes.
Use configurator groups to group document configurators for organizational needs. When you display a group, you can view individual document configurators that are contained in the group and that relate to the overall configurator use. For example, if you have contract documents for a class of items, you can associate the configurators that are used for those documents. You can also group configurators that specify certain contractual requirements. After you define a group, you can add individual configurator IDs to it.
Use configurator types to define requirements that you can use in document configurators. These requirements provide instructions and specific details about a transaction type. When you create a document configurator, you can optionally use a transaction configurator type as an information reference for the configurator.
Page Name |
Object Name |
Navigation |
Usage |
CS_TMPL_GROUP |
Supplier Contracts, Supplier Contracts Setup, Document Configurator Groups |
Define configurator groups. |
|
CS_TMPL_TYPE |
Supplier Contracts, Supplier Contracts Setup, Document Configurator Types |
Define configurator types. |
Access the Document Configurator Group Definition page.
Use this page to create a group of configurators that you can use in document authoring. Define the group name, and then use the Configurator ID field to select document configurators for the group.
You can also enter the descriptions and any other textual information to further define information for the configurator group.
See Also
Understanding Configurator Groups and Types
Access the Document Configurator Type Definition page.
Use this page to define the requirements for a specific type of document configurator. For example, you can enter detailed information that might, for example, indicate that the document should specify items and pricing on the contract or indicate how delivery orders should be addressed in the document.
The Short Description field is required.
See Also
Understanding Configurator Groups and Types
This section provides an overview of document templates and discusses how to define document templates and styles.
Templates are predefined Microsoft Word documents that provide formatting for documents. These templates traditionally determine the basic structure for the document that you use in the creation of documents. A template in Microsoft Word is another Microsoft Word document that uses the extension .dot. Templates traditionally have placeholders in which you enter text and use placeholders mainly as starting points for final documents.
A template might traditionally contain document settings, such as autotext entries, fonts, key assignments, macros, menus, page layout, special formats, and styles. When you save a template, Microsoft Word stores it by default in the Templates folder or in one of its subfolders.
Note. Microsoft templates are used only as a basis for the creation of documentation. Other types of templates, such as notification templates and document configurators, are used by the Supplier Contract Management application to manage approvals and collaboration.
See Also
Format and Style Considerations in Microsoft Word
Locating PeopleSoft Document Elements from Microsoft Word
Page Name |
Object Name |
Navigation |
Usage |
CS_WORD_TMPL_SET |
Supplier Contracts, Supplier Contracts Setup, Document Templates and Styles |
Define document templates and styles. |
Access the Define Document Templates and Styles page.
Use this page to upload Microsoft Word templates containing paragraph styles for use with supplier contracts. This page contains all the valid Microsoft Word templates that you can use in setIDs and configurators. The Microsoft Word templates must be inclusive of all paragraph styles that you use in the system, regardless of whether they are defaults for document generation or for overriding a style within a clause.
See Defining Document Configurators.
See Templates.
Document Style Templates
Upload a File |
Click to access a page where you can either enter or browse for a location of the template that you want to upload and add to the group of available templates. |
Template Name |
Displays the name of the template after it has been uploaded. This is the name by which the Microsoft Word file is stored in the template folder. After you upload the file, you can change the template name. |
View |
Click to open the corresponding template. |
Styles
Use this grid to list all valid paragraph styles that are defined in Microsoft Word templates that you want to use for PeopleSoft prompting. You must enter these paragraph styles with spelling that matches that of the styles in the Microsoft Word template because the system does not validate against the Microsoft Word template. System prompting for styles is based on this list to reduce the chance of data-entry errors.
Style Name |
Enter all valid paragraph styles for use within PeopleSoft across all Microsoft Word templates. |
Description |
Enter the description of the style. This should provide further details about how the style appears and its format. |
See Also
Generating Microsoft Word Documents
Format and Style Considerations in Microsoft Word
This section discusses how to define default settings for document formats and options.
Page Name |
Object Name |
Navigation |
Usage |
CS_CONFIG |
Supplier Contracts, Supplier Contracts Setup, Document Format and Options |
Define default settings for document formats and options. |
Access the Document Format and Options page.
Use this page to define Microsoft Word templates and paragraph text styles. These paragraph style values control the default formatting and numbering of documents that are created within the selected setID.
Document Defaults and Options
Use this group box to define default values that the system will apply to a document when you apply a Microsoft Word template to a document.
Word Template Name |
Select a Microsoft Word template to use in the preview mode for clauses and sections within this setID. The available templates are XML versions of word template files (.dot). The system also uses the template that you select as the default template to populate the Word Template field when you add a document configurator. You use the default template for clause and section previews and initial document generation and in the configurator structure preview. Templates that are available for this field are the templates that have been uploaded from Microsoft Word template folders. The templates are uploaded by users. To add more templates, use the Document Templates and Styles feature. |
Allow Check-In as Same Version |
Select to indicate that you want to enable a document to be checked in at the same version as it was when it was checked out. When this check box is selected, you can leave the document at the same version instead of allowing the system to check it in as an incremental version. This option is also available when you refresh or regenerate a document. You should be careful using these functions because if you do not increment the version number during check in, the system overwrites any previous files (file pointers in history) that use the same version number with this new file. For history and tracking purposes, you typically use a version change for actions that can affect the contents of the document. However, if you select the Allow Check-In as Same Version check box, the system provides access to only the latest version of the document on the Document History page. |
Amendment Creation Default |
Use this field to define the default setting when you are creating and updating amendments. The system uses the value to process amendments when you are using the Document Management page. You can always override this value when creating the first amendment of a specific document. Settings include: Amend Contract Only: Select to process amendments within the original document and do not use a separate amendment file. If you use this option, the system leaves the last processed version in place and creates a new version of the same document that you can edit as an amended contract. Amend Contracts with Amendments: Select to amend the original document, and to create a separate amendment document specific for this amendment number. If you select this option, the system creates and maintains two files for checking in and checking out as part of the amendment. One file is for the last processed document, and the second file is for changes that are made specific only to the amendment. The second amendment file is generated, and you must specify an amendment document configurator for its initial content. Note. Use the Amend Contracts with Amendments option if you intend to maintain only amendment-related changes in a new version of the originally processed contract. Amendment Files Only: Select to generate the amendment as a separate document for each version of the amendment. This leaves the last original document as is. This option is similar to Amend Contracts with Amendments except that it requires you to maintain only a separate amendment file describing just the changes to the original contract. Use this option if you do not intend to maintain online amendment-related changes in a new version of the originally processed contract. |
Document Text Styles
Use this group box to define default styles to be applied to Microsoft Word documents. Styles determine the format and appearance of content in the document.
Warning! Be careful when you maintain the paragraph styles that are listed on this page and the styles within Microsoft Word templates. The styles affect the generated format for previewing clauses, sections, configurators, and generated contracts.
To preview clauses and sections, the system always uses the Microsoft Word template name that you specify on this page. To preview document configurators and document generation, the system always uses the Microsoft Word template that is specified on the document configurator that is supplied by default from the setID value. You can select styles for different uses with the template.
Select a paragraph style for use with a Numbered Title style. You use this style with the one in the Body Style under Numbered Title field to define how numbered clauses and sections appear. The system applies this paragraph style when a clause or section is part of a title and when the Numbered check box is selected on the Clause Definition or Section Definition pages. The paragraph style within Microsoft Word must have a custom outline-level numbering scheme associated with it to achieve the numbering format that you want in the authored contract when it is generated. Note. The Level field in the Custom Outlined Numbered list in Microsoft Word corresponds to the Outline Position field in the Content Elements grid on the Document Configurator Definition page. For each element that is assembled for the contract in the authored document,
the system applies the correct numbering, indentation, and formats based on the final level in the Microsoft Word document. The system applies the Body under Numbered Title style to paragraph text that appears following numbered titles. This example illustrates the PeopleSoft Numbered Title style using PSNumHeading.
|
|
Body Style Under Numbered Title |
Select a style that determines how text following numbered titles should appear in documents. The system uses this paragraph style with the Numbered Title style so that as the system generates a document and level indentation occurs, the indented title and body can be specified to align through the paragraph style in Microsoft Word. In Microsoft Word, this paragraph style normally has a blank Customized Outline Number List associated with it. The style also has the Number and Text positions within the Level in Microsoft Word so that the system generates clause and section body indentations correctly depending on the outline position of the clause and section in the document configurator. |
Select a paragraph style for use with Unnumbered Title styles. The system uses this value with the Body following the Unnumbered Title style for use within clauses or sections that are not numbered. The system applies this paragraph style when a clause or section is included with a title, and when the Numbered check box is not selected. The Unnumbered Title style applies to all unnumbered clause and section titles within the document regardless of the outline level. The system applies the Body Text following the Unnumbered Title style to paragraph text that follows unnumbered titles. This example illustrates the Unnumbered Title style.
|
|
Body Style Under Unnumbered Title |
Select a style that determines how text following unnumbered titles should appear in documents. Use this paragraph style with the unnumbered title style so that as the system generates and indents a document, the indented title and body is specified to align through the paragraph style in the Microsoft Word document. In Microsoft Word, this paragraph style normally has a blank Customized Outline Number List associated with it. The style also has the number and text positions within the level in Microsoft Word so that any indentation of the clause or section body is generated correctly depending on its outline position as defined in the document configurator and its content. |
Define a paragraph style for a numbered body if you want to create numbered text within normal body paragraphs, such as when you have not defined this text as a title within a clause or section definition. The system applies this paragraph style when it includes a clause or section without a title, and when the Numbered check box is selected. This example illustrates the numbered body style.
Note. For more information about paragraph styles and custom outline numbered lists, see Microsoft Word documentation. |
See Also
This section provides an overview of user preferences and discusses how to define user preferences.
User preferences determine the security access and authorizations that users (document administrators) have when working with authored documents. A document administrator is typically the contract specialist in an organization and is the user doing day-to-day management of documents. Within user preferences, you can define users as document administrators and also grant users access to other administrators' documents, for example, as a supervisor or team member for other administrators. You can also define a document administrator user to have full authorization when needed. In this case, this user has full control of any document in the system when needed.
In addition to providing user preferences for document administrators, use this page to define security settings to segregate the duties of approving section and changing document configurator status. These may or may not be the same users as document administrator users.
Page Name |
Object Name |
Navigation |
Usage |
OPR_DEF_TABLE_CS |
Supplier Contracts, Supplier Contracts Setup, Define User Preferences Click the Supplier Contract Management link. |
Define user preferences by establishing user document authorizations for tasks they can perform on supplier contract documents. |
Access the User Preferences page.
Use this page to define user authorizations for managing documents through their life cycles and to grant the types of controls that the user who is defined in the User ID field can perform on documents. This is the selected user for this page discussion. This user preference page is enabled only for users who have administration rights for authored contracts, and those users can approve library sections and set configurator status.
The application administrator completes the setup information for user preferences for any document administrator.
The application administrator uses this group box to grant users security for document administrators and users who will manage section approvals and status changes for configurators.
Authorize Document Access
Use this grid area to define additional authorizations for the person with the selected user ID. These authorizations enable this user to act on behalf of other users who are selected in the Document Administrator column of the grid. You might use this feature, for example, if the selected user is a senior contract administrator, and while members of his department or group are away from the office, then the user has the authority to perform tasks for their documents.
Document Administrator (column) |
Select additional users for whom the selected user will have authority to perform document tasks. Use the corresponding check boxes to define the authorities for the selected user. |
Document Administrator (check box) |
Select to indicate that the selected user has document administrator authority for the corresponding user's documents. This means that the selected user can generate and edit the user's documents just as if he or she were the administrator. |
Reset to Dispatch |
Select to indicate that the selected user has authority to reset a processed document back to dispatch for the corresponding user. This authority is in addition to any other task authorities that you select in this grid. |
Bypass Approval |
Select to indicate that the selected user has authority to bypass approvals and expedite a document for the corresponding user. This authority is in addition to any other task authorities that you select in this grid. |