This chapter provides an overview of PeopleSoft Supplier Contract Management setup and discusses how to:
Set up URL database servers and FTP attachment servers and directories for supplier contracts.
(Optional) Set up PeopleSoft Integration Broker for Microsoft Word and Adobe integration.
(Optional) Set up digital signatures.
Define installation options for PeopleSoft Supplier Contract Management.
Define clause libraries and groups.
Set up approval types.
Establish clause classes.
Map bind variables.
Set up wizard bind prompt tables.
Set up document configurator groups and types.
Define document templates and styles.
Define default settings for document formats and options.
Set up user-defined fields.
Define automatic numbering specifications.
Set up user preferences.
Note. PeopleSoft Supplier Contract Management uses Microsoft
Word extensively for document authoring. Certain multibyte characters are
in Microsoft Word that cannot be supported when you integrate with a nonmultibyte
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 release of Supplier Contract Management (9.1 Feature Pack January
2012 and forward) supports Microsoft Word 2007 XML, or later versions. If
you have existing data in the contract library that was created using Microsoft
Word 2003 XML, you must convert your library to move to the Microsoft Word
2007 XML, or later version, format. You can find detailed instructions and
information pertaining to the impact of the conversion on My Oracle Support
(https://support.oracle.com), note number 1329290.1. Oracle's PeopleSoft continue
to support Microsoft Word 2003 XML depending on Microsoft Word licenses purchased
prior to January 11, 2010. This is due to the loss of custom XML tags support
in Microsoft Word.
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, purchase orders, and ad hoc document generation requires basic setup to enable authoring. For example, basic document authoring includes:
The setup of a database server or file-transfer program (FTP) server directories for file storage.
Either a database server or an attachment FTP server and its appropriate directories must be available for use by the system to store and retrieve files that are used for the clause library and authored documents. Users might consider storing attachments within the database server preferable to storage to an FTP server because data management is more contained in the database server. However, before choosing a database server or FTP server, you should also consider the following:
Are you currently using FTP server or database server attachment setup for other products such PeopleSoft eProcurement?
If so, you would likely use the same setup for Supplier Contract Management.
When considering database servers, consider the database platform you are running and any restrictions within the platform that depend on the expected attachment volume and database size.
When large volumes of documents are expected consider the benefits of using FTP servers versus database servers for Verity Search Collections.
Because Verity search collections require the collection be built from a saved file outside of the database, rebuilding collections using FTP servers and a mapped server drive will likely perform better than extracting attachments from the database and storing them to temporary files for builds.
The installation of Microsoft Office Word 2007, or later version, on workstations for users interacting with the system.
This is a minimum 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.
Note. This release of Supplier Contract Management (9.1 Feature Pack January 2012 and forward) supports Microsoft Word 2007 XML, or later versions. If you have existing data in the contract library that was created using Microsoft Word 2003 XML, you must convert your library to move to the Microsoft Word 2007 XML, or later version, format. You can find detailed instructions and information pertaining to the impact of the conversion on My Oracle Support (https://support.oracle.com), note number 1329290.1. Oracle's PeopleSoft continue to support Microsoft Word 2003 XML depending on Microsoft Word licenses purchased prior to January 11, 2010. This is due to the loss of custom XML tags support in Microsoft Word.
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 re-created or refreshed version of the document. It also enables the rendering of the Microsoft Word .xml authored document into a Microsoft Word .doc or Adobe .pdf format. You should configure this feature if you intend to dispatch documents externally in a .doc or .pdf format versus the default .xml format that requires the use of Microsoft Word 2007, or later version.
Enabling automatic numbering.
The system uses automatic numbering to automatically assign numbers to ad hoc documents, clauses, and sections.
Installation options.
These setup features support a variety of processes including requiring approvals for documents and clauses, enabling document types, syndication, and document comparisons. You can also define chunking for Verity searches, enable transaction sources, enable cycle times, setup internal and external collaboration, and setup digital signatures.
User preferences.
You use these features to define authorizations for document administrators and librarians, and to delegate document authorizations to other users.
The Supplier Contract Management Helpful Hints appendix provides additional information about setup issues.
See Supplier Contract Management Helpful Hints.
See Also
Understanding Contract Agreements
Setting Up Contract Syndication
To set up URL database or FTP attachment servers and directories, use the Administer File Attachment component (SAC_ATT_ADMIN).
This section discusses how to:
Add FTP servers.
Override FTP Attachment servers.
Note. Setting up database and URL servers is similar except that you only add a database record name, or URL identifier, and do not setup the component directories that are specified for FTP server setup.
Page Name |
Definition Name |
Navigation |
Usage |
SAC_ATT_ADMIN |
Set Up Financials/Supply Chain, Common Definitions, File Attachments, Administer File Attachments |
Add FTP servers for supplier contract attachments if you do not already have an FTP server defined for other Supplier Relationship Management (SRM) products such as PeopleSoft eProcurement. Click the Add FTP Server button on the Administer File Attachments page to add server information. |
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 when the server type is FTP, its appropriate directories. The system stores and retrieves attachments for PeopleSoft Supplier Contract Management from the server locations that are defined on this page.
See "Working with File Attachments," PeopleSoft PeopleTools PeopleBook: PeopleCode Developer's Guide
System administrators can configure one or more servers to store attachments. 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 file transfer protocol 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 URL Server, Add FTP Server, or the Add Database Server button. After you save the row and quit the component, you cannot change the server type. Values include URL (HTTP, SFTP, OR FTPS), FTP (file transfer protocol server), and DB (database server). |
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 or change a server name, record name, or URL identifier. For FTP servers, enter the machine name or IP address. 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. For database servers, enter record name PV_ATT_DB_SRV. For URL servers, enter the URL identifier. |
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 URL Server |
Click to insert a new row in the grid to define a new URL server for attachments. |
Add FTP Server (add file transfer protocol 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. |
Component Subdirectories
Use this grid after you set up the FTP attachment server to specify specific server subdirectories for the appropriate components. This enables you to segregate and better manage files on the FTP server as they pertain to contracts.
Note. Component subdirectories are only applicable to FTP server types, not database or URL servers.
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 editing. |
CS_CNT_AG_RESULT |
AgreeResult |
Stores contract agreement results that are attachments. |
CNTRCT_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 editing. |
CS_TMPL_TBL |
Configurator |
Stores ad hoc document configurator clauses for Microsoft Word editing. |
CS_DOC_SUPP |
AuthoredDocs |
Stores generated contract documents. The system uses this component for the external/supply side access. The directory must match the internal directory defined for the CS_DOC_MAINT component. |
CS_SS_CNT_VFY |
TransContract |
Stores transactional contract-entry related attachments. The system uses this component for the external/supply side access. The directory must match the internal directory defined for the CNTRCT_ENTRY component. |
You can override the attachment server defined during the installation of the PeopleSoft system. When you override the installed server, you can define and use an attachment server specifically for PeopleSoft Supplier Contract Management-related documents and attachments. You use the Override Attachment Server ID field to point to a specific attachment server ID in cases where you are currently using database server attachments in your system only for products other than PeopleSoft Supplier Contract Management. You should evaluate the need for using the FTP Attachment Server feature during the initial setup of the product.
Warning! Overriding an attachment server should be an exception and only performed when absolutely necessary. Overriding the server also affects the use of Verity searching in PeopleSoft Supplier Contract Management. If you choose to use a database server for Supplier Contract Management the Attachment Server Override values must be left blank.
You can use a contract-related attachment server if you need to isolate supplier contract-related attachments from the primary attachment server that is used for all other applications. This feature is primarily intended for when you are already using the database attachment server for all other products, and are ready to begin using PeopleSoft Supplier Contract Management, but prefer the Supplier Contract Management server to be FTP-based versus a database server. So after defining the database attachment server during system installation, you can use the Override Attachment Server ID field on the Supplier Contract Management Installation Options page to define the FTP attachment server for use within Supplier Contract Management only.
When the installation-wide setting is set to a database server, and if you are using a database server for all other types of attachments across the installation, then any other features that store attachments, other than within PeopleSoft Supplier Contract Management document pages, will continue to be stored in the database server and cannot be searched using Verity. Also, if you have attachments tied to an actual purchasing transactional contract or requisitions that are part of a contract, when you create a supplier contract document tied to the transactional contract, these associated or related database attachments cannot be searched using the Verity Search page because Supplier Contract Management searches and indexes FTP server files only.
Note. The Override Attachment Server ID field is used for all supplier contract authoring-related attachments with the exception of header and line attachments existing within the Contract Entry or Purchase Order components. If the Contract Entry or Purchase Order header and line attachments are stored in a database server, you cannot include them in Verity searches.
If you plan to use two FTP attachment servers and neither one is a database type server, you can use one for the installation-wide setting and use a unique one for PeopleSoft Supplier Contract Management. You can use these steps to override the installed server:
Select Setup Fin/SCM, Common, File Attachments to create additional server IDs on the Attachment Server page.
Note. This setup only applies to FTP attachment server types. You also have the option to use a database attachment server instead of a FTP attachment server.
Set the active server to the one that you want for all other applications.
Remember the server ID for the server that you want to use for PeopleSoft Supplier Contract Management.
Access the PeopleSoft Supplier Contract Management Installation Options page.
In the Override Attachment Server ID field, select the server ID for the server that you want to use for PeopleSoft Supplier Contract Management.
When you enter a value in the Override Attachment Server ID field, the system displays a message indicating that the field should normally be left blank.
Click Save.
After overriding the attachment server, you can continue with the PeopleSoft Supplier Contract Management setup process as you normally would.
See Also
Supplier Contract Management Setup Needs
This section provides an overview of system setup for Microsoft Word configuration files and PeopleSoft Integration Broker and discusses how to:
Set up PeopleSoft Integration Broker window servers for use with Microsoft Word and Adobe Acrobat .
Install and configure Microsoft Word and Acrobat components on workstations.
Microsoft Office Open XML integration is a core requirement of PeopleSoft Supplier Contract Management. You can use Microsoft Word 2007, or later version supporting the Microsoft Office Open XML format, to check out and edit clauses, sections, ad hoc configurator clauses, and contract documents. You should begin system setup with a Word 2007, or later version, .XML template (upload).
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 and clauses when developing clause content. Using an optional search feature, contract specialists and collaborators can search for, locate, and retrieve binds and clauses while maintaining the authored contract.
To use Microsoft Word editing features and the Research task pane search requires that you set up workstations on local systems and define settings for PeopleSoft Integration Broker service operations. This section describes the basic steps for setting up both systems. After activating system-supplied service operations in Integration Broker, you can install and configure Microsoft Word components on workstations to interact directly with the PeopleSoft database.
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. Optionally, you can click a link that is provided for each clause from the search results, which accesses the specific clause and its details in the document authoring system.
See Installing and Configuring Microsoft Word and Acrobat Components on Workstations.
The following sections describe special Microsoft Word setup conditions for use with PeopleSoft Supplier Contract Management. They include:
Microsoft Word installation.
URL configuration for use with clause searches.
Microsoft Word Setup on Workstations
After you install components on the workstation, you can use the Microsoft Word - Research task pane to search for and to add binds and clauses to contract documents. In the clause search results, the system provides a URL so that you can navigate to the clause in the contract library of the PeopleSoft database.
The following example shows how the Research task pane might appear after you have performed a search for the word WARRANTY in a clause ID, description, or title:
When you search for a clause, the frame displays the first 300 plaintext characters of full text and by reference text that are 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. Any time you change the settings in the configuration file, you need to uninstall and run install again for the new settings to take effect.
Integration Broker Setup to Enable Workstation's Word Research Task Pane Searches
A service operation definition consists of general information about an operation, such as its name and alias if one has been defined. It also specifies an operation type, which determines how the operation is to be processed, synchronously or asynchronously. The CS_SEARCH_BINDS and CS_SEARCH_CLAUSES are processed synchronously, meaning that the system waits for a response to the message. These two service operations allow specialists and librarians to access clauses and binds from within Microsoft Word using synchronous messages.
In addition, the service operation definition contains routings, which determine the direction, inbound or outbound, of the service operation. A service operation has one or more handlers, which contain and run the programming logic for sending or receiving the message and manipulating service operation content.
See Incoming and Outgoing Request Flows, "Understanding PeopleSoft Integration Broker," PeopleTools PeopleBook: Integration Broker
To prepare the system to use Microsoft Word task pane services to connect to PeopleSoft databases to search for end-user bind variables and clauses:
Configure the gateway if it's not already configured for the database.
The integration gateway is a platform that manages the receipt and delivery of messages that are passed among systems through PeopleSoft Integration Broker. Information defined for the gateway relates to the config.txt file that you update to define servers. The gateway manager maintains links to the other integration gateway components, including target connectors and listening connectors. Listening connectors invoke the gateway manager when they receive a message request.
The gateway manager invokes the appropriate target connector based on the content of the message object and waits for a reply from the target connector. When the reply is received, the gateway manager forwards the reply to the calling listening connector. PeopleSoft Supplier Contract Management delivers the LOCAL gateway configured to exchange information with the PeopleSoftServiceListeningConnector in the URLs for bind and clause searches.
Note. If the gateway is not configured, the database administrator should perform this task.
See "Managing Integration Gateways," PeopleTools PeopleBook: Integration Broker
Set the CS_SEARCH_BINDS and CS_SEARCH_CLAUSES service operations to Active.
Oracle delivers the service operations in PeopleSoft Integration Broker with a default status of Inactive. You must activate each service operation before attempting to send or receive data from a third-party source or another PeopleSoft system, such as Supply Chain Management.
To specify messages for the service operations, and to set them to an Active status:
Select PeopleTools, Integration Broker, Integration Setup, Service Operations.
Select CS_SEARCH_BINDS and CS_SEARCH_CLAUSES, alternately in the Service Operations field.
Click Search.
The service operation appears.
Click the Service Operation link.
You specify messages for service operations in the Message Information section of the Service Operations - General page. Because the CS_SEARCH_BINDS and CS_SEARCH_CLAUSES are already available, they appear in the section. These messages define the structure of the data that is contained in the service operation. The service operation type determines the number of messages and message types (request or response) that you specify.
Set the CS_SEARCH_BINDS and CS_SEARCH_CLAUSES services to Active using the Active check box in the Default Service Operation Version group box.
Select the Handlers tab.
The page provides summary information about handlers that have been added to an operation. Two individual server processes work together to handle incoming requests. One server process functions as a dispatcher, while the other functions as a handler. You can specify an application class as a handler for a service operation. The CS_SEARCH_BINDS and CS_SEARCH_CLAUSES use an application class handler.
See "Sending and Receiving Messages," PeopleTools PeopleBook: Integration Broker
Ensure that Active is selected in the Status field on the Handlers tab.
Click the Save button.
Select the Routings tab.
This page provides access to routing information that has been added to an operation. Routings determine the direction, inbound or outbound, of the service operation. The routing page is where you specify the sending and receiving node. The Sender Node field value should be ANY for both the CS_SEARCH_BINDS and CS_SEARCH_ CLAUSES operations. The Receiver Node field value should equal the value for the database's default local node. This value appears on the Nodes page and contains Y in the Local Node Name column for the node.
Select the Active check box.
Click the Save button.
See Understanding Integration Setup, "Appendix: Integration Scenarios," PeopleTools PeopleBook: Integration Broker
Set the CS_DOC_CHL queue status to Run.
A queue isolates different groups of service operations from each other. The CS_DOC_CHL queue queues the CS_SEARCH_BINDS and CS_SEARCH_CLAUSES for processing.
See "Managing Service Operation Queues," PeopleTools PeopleBook: Integration Broker
To set the queue status:
Select PeopleTools, Integration Broker, Integration Setup, Queues.
Ensure that Run is selected in the Queue Status field.
Click the Save button.
See "Managing Service Operations," PeopleTools PeopleBook: Integration Broker.
See Setting Up Service Operations, "Implementing Integrations," PeopleTools PeopleBook: Integration Broker.
URL Configuration for Use with Clause Searches
Linking to clauses requires an extra task. To link to clauses from within a Microsoft Word - Research task pane, you also need to establish a URL that will appear as the clause name in Microsoft Word. You must define a server and location for the EMP_SERVLET URL. To access the URL, select PeopleTools, Utilities, Administration, URLs. Search for the EMP_SERVLET URL identifier. Enter a partial PeopleSoft Internet Architecture URL in the URL field. An example of the formatting appears on the page. An entry might be, for example, http://pfas027.peoplesoft.com:8001/psp/e900r20bnt/EMPLOYEE/. See the previous example to view how the URL appears in a Microsoft Word page.
See Integration Broker Setup to Enable Workstation's Word Research Task Pane Searches.
See Also
Understanding Microsoft Word Integration with Supplier Contract Management
Page Name |
Definition Name |
Navigation |
Usage |
IB_GATEWAY |
PeopleTools, Integration Broker, Configuration, Gateways |
Configure gateways. |
|
IB_SERVICE |
PeopleTools, Integration Broker, Integration Setup, Service Operations, General |
Define and activate a service operation. |
|
IB_SERVICEHDLR |
PeopleTools, Integration Broker, Integration Setup, Service Operations, Handlers |
Activate one or more service operation handlers. |
|
IB_ROUTINGDEFN |
PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings |
Define and activate routing definitions on the service operation. |
|
IB_QUEUEDEFN |
|
Set the queue used by the service operation to Run. |
|
IB_NODE |
PeopleTools, Integration Broker, Integration Setup, Nodes, Node Definitions |
Activate node used by the service operation. |
|
IB_NODECONN |
PeopleTools, Integration Broker, Integration Setup, Nodes, Connectors |
For an outbound service operation, verify that the node is connected to the correct network. |
This section discusses the Integration Broker setup needed for initiating optional server-side comparisons of Microsoft Word files, rendering of .doc or PDF files, as well as rendering PDF or .docx files for preparing the read-only version of documents for capturing digital signatures.
You have to prepare the system to render contract documents in PDF, .doc, and/or .docx file formats by setting up a Microsoft Windows-based server machine, such as Windows 2000 or Windows XP, to render contract documents. For this functionality the dedicated shared Microsoft Windows-based server also needs to have an application server installed that is used for internal messaging between the application servers the Supplier Contract Management users use and the Microsoft Windows application server for special server- side processing. To setup the Microsoft Windows server machine, ensure that:
PeopleTools is installed.
An application server domain has been created for your system.
A copy of CSDOCUTL.DLL is in the %PSHOME%/BIN/SERVER/WINX86 directory before the application server is booted up.
This DLL enables server-side processing of Microsoft Word files and is used when comparing documents, dispatching documents in .doc file type, and preparing documents for digital signatures using Adobe Acrobat (.pdf) or Microsoft Word 2007, or later version, (.docx). The CSDOCUTIL program interacts with Microsoft Word and Adobe Acrobat on the windows server machine using an internal synchronization message call when you render a .doc or PDF file for dispatch or when you prepare a PDF or .docx file for digital signature.
Adobe Acrobat 8 Professional (or later versions) is installed if you plan to use Adobe Acrobat digital signatures, or dispatching documents in PDF.
Note. When using Adobe PDF format for digital signature purposes, contract administrators who are designated for preparing and enabling signature rights must also have a copy of Acrobat 8 installed on their client workstation.
Microsoft Word 2007, or later version, is installed if you plan to use Microsoft Word digital signature service.
After installing Adobe Acrobat, you have to delete the installed Adobe PDF printer and install it again and update Adobe settings. When re-installing a printer:
Access the Add Printer Wizard page by selecting Start, Control Panel, Printers and Faxes, Add Printer, and clicking Next. This example illustrates the Add Printer Wizard window:
Select Local Printer attached to this computer.
Ensure that the Automatically detect and install my Plug and Play printer check box is deselected.
Click Next, and select the Desktop\*.pdf {Adobe PDF Port} value in the Use the following port field on the Add Printer Wizard/Select Printer Port window.
Click Next, and then click the Have Disk button on the Add Printer Wizard/Install Printer Software window.
Select the Browse button on the Install From Disk window to locate the AdobePDF.inf file. Select the AdobePDF folder as shown in this example:
Select the Adobe PDF Converter printer at the top of the list and click Next.
Select to keep the existing driver on the Add Printer Wizard - Use Existing Driver window, and click Next.
Enter Adobe PDF for printer name on the Add Printer Wizard/Name Your Printer window and select No to indicate that you do not want this to be the default printer, then click Next.
Select Do not share this printer on the Add Printer Wizard: Share Printer window and click Next.
You can print a test page or select No and click Next to complete the wizard.
Access the properties for the installed Adobe PDF printer, and click Printing Preferences on the General tab. The next window appears:
Deselect the Rely on system fonts only; do not use document fonts check box.
Click OK, and then select the Advanced tab, and select Printing Defaults. Also, deselect the Rely on system fonts only; do not use document fonts check box.
If Adobe Acrobat is installed, it is recommended that you check the option to delete log files. These files are created when dispatching a contract document in PDF or preparing document for digital signature. You access the page by launching Acrobat Distiller and selecting Edit, Preferences. This example illustrates the Preferences window:
Note. You use Acrobat Acrobat when a file is being converted to PDF from a Microsoft Word XML Document format to support Adobe digital signature or to dispatch a contract document in PDF.
After you set up the messages and the integration gateway, you can optionally install and configure Microsoft Word for use with task panes, including the Research task pane for bind and clause searches. This is typically setup for contract administrators who want to access the clause library from within Microsoft Word.
In addition, if you intend to enable digital signatures using Adobe PDF format, each contract administrator who needs to prepare, sign, and most importantly enable signature rights for others to sign a document using the Adobe Reader must have Adobe Acrobat 8 Professional installed on their workstation.
To install and configure Microsoft Word for use with the Research task pane:
Microsoft Word Research Task Pane Workstation Installation
Oracle 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. You can copy the files from this folder to each workstation, or you can run the setup executable file directly from the CD, after you have edited the settings in the configuration file (config.txt).
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 task pane integration with PeopleSoft Supplier Contract Management. Normally, this would be the contract specialist. 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 pressing the Alt key and clicking the mouse. You can also access the page by selecting the Review tab, and then selecting the Research button using Microsoft Word 2007, or later version.
After the setup is complete, when you open the Research task 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 and version of Microsoft Word being used. 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
Another parameter in the config.txt file that needs to be verified and updated, if necessary, is the version number for Microsoft Word. Use 12.0 for Microsoft Word 2007 and use 14.0 for Microsoft Word 2010. Here is an example of the version setup for Microsoft Word 2007 client usage of the research pane integration:
;For Word 2007 use 12.0 [WordVersion] Version=12.0
Use the Gateways page to set up 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 node only if you want to change the node to be another external node. The from node can be any external 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.
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 that you use to integrate PeopleSoft Supplier Contract Management with Microsoft Word.
Open a version of Microsoft Word 2007 or later version.
Using Microsoft Word, 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.
Note. When running on Oracle and MSS database platforms, the search also searches the full text field.
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 client processing size limitations, the system returns only 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 that only the first 20 results appear.
To complete workstation setup for Adobe Acrobat 8 Professional, users who enable signatures should deselect the option to display the PDF in their browser after Adobe Acrobat is installed on their workstation. This is required so that the specialist can properly sign and certify signature files after preparing them within PeopleSoft Supplier Contract Management. The system launches Adobe Acrobat on the specialist's workstation as part of the document preparation process. To deselect to display the PDF in the browser:
Launch Adobe Acrobat on each workstation.
From the Adobe toolbar, select Edit, Preferences, and select Internet from the Categories scroll area.
Deselect the Display PDF in browser check box.
This section provides overviews of:
How to set up digital signatures.
Adobe Acrobat digital signatures.
Microsoft Word digital signatures.
This section discusses
Digital signature overview and considerations.
Methods used to create signature clauses.
Digital signature set up steps.
Digital Signature Overview and Considerations
PeopleSoft Supplier Contract Management provides the capability to use third-party digital signatures for internal as well as external users to sign off on contract documents. Digital signatures are cryptographically-based signature assurance schemes. They are often used in the context of public key infrastructure (PKI) schemes in which the public key used in the signature scheme is tied to a user by a digital identity certificate issued by a certificate authority.
Digital signatures provide:
Document integrity that verifies the document content has not been altered.
User authentication that verifies the document came from the person you think sent it.
Non-repudiation that verifies a level of proof regarding who electronically signed the document and what they signed.
Implementation considerations for which technologies you use with digital signatures include:
Adobe Acrobat product (.pdf)
Using Adobe Acrobat enables you to prepare a .pdf document for signature purposes from a Microsoft Word document. This enables internal and external users to sign documents using Adobe Reader. To enable this feature when you using Microsoft Word, you must have a copy of Adobe Acrobat 8 on the same Windows application server as the Microsoft Word installation used to do document compares or .doc format dispatches.
When documents are ready to be prepared, the document administrator clicks the Prepare for Signature button on the Document Management page. This renders the document as a .pdf file on the server-side, and then launches the PDF document on the client so that specialists can enable and certify (sign) the document. Each document administrator must also have Adobe Acrobat version 8 on the client in order to enable the document so that others may sign it using the Acrobat Reader and certify it by indicating that the document is signed and certified.
Microsoft Word (.docx).
You can prepare a signable Microsoft Word 2007, or later version, document instead of a PDF. This method uses Microsoft Word to prepare a signable .docx file of the document instead of a PDF. The .docx file version of the document is intended for signing purposes only. Because this option requires all internal and external users to use Microsoft Word 2007, or later version, for signing purposes, you might find that it is more limited than using a PDF where the Adobe Reader is more readily available to all internal and external users.
Internal and external signatures.
PeopleSoft Supplier Contract Management enables the collection of internal and external signatures. Depending on the organizations needs the document administrator can determine when to prepare documents for signature and when to collect them. For example, for a given document type, you can specify to collect internal signatures before, during, or after approval. And, likewise, send documents to contacts and dispatch documents to collect external signatures before or after approvals, and before or after internal signatures.
Online external signatures.
As part of setting up digital signatures, you can also optionally define a framework that includes suppliers in document collaboration and online review and approval processes including the ability to sign the document. This requires that you have a supplier-facing web site available for external users to access contract documents for collaboration, review, and signatures. You can also choose to configure the system so that external signatures are always collected when sending or dispatching a PDF using an email attachment. If you select this method, external users sign and send the PDF back to the administrator, who then uploads the signed document on behalf of the external user.
Visible and invisible signatures.
Visible signers are those signers whose signature labels appear on a contract document. Unlike visible signatures, you can also set up a signer with an invisible signature. You can only see an invisible signature in the signature properties of the document, and not in the document itself. You can use an invisible signature, for example, when you want to track a signature for non-repudiation purposes, but do not want to show the signature within the document itself.
Invisible signatures still require a signature postscript placeholder image file that is unique. In setting up signatures for a document, and you know there are five invisible signers, then you will need five invisible signature placeholder files. Inside the placeholder file, the title can read invisible signer one, invisible signer two and so on. You can use any signature label that you want to provide the invisible signers.
Note. Using digital signatures to sign contract documents is described in the Managing Document Life Cycles chapter.
See Signing Documents Using Digital Signatures.
Methods Used to Create Signature Clauses
You can set up digital signature clauses using these methods:
Generic signature fields.
This method is the recommended method for digital signature. You use a generic signature field for a given signature role, such as contract specialist, director, or vice president. These generic signature fields are defined within postcript text files that are then inserted as images into the Microsoft Word version of the clause.
To create a signature field, you copy a postscript file from Windows Explorer into a Microsoft Word document. The field will appear as a blank image in the Microsoft Word document. When a contract document is ready for digital signature, it is converted to a PDF and the blank image is converted to a signature field where it can be signed. A signature field is a placeholder for a signer to sign in. The signature image in a PDF will appear as a rectangular box.
When, for example, a director actually signs the signature field in a PDF, the signature information for the director can contain the visible details about him such as his name, title, and an image of his signature. This is the digital ID used in Adobe Acrobat. Using generic signatures are recommended because they reduce the maintenance of clauses and configuration of the system.
Note. The PeopleSoft Financials/Supply Chain sample database contains some sample Microsoft Word clauses named CL_SAMPLE_PDF_SIGN1 (2,3) for reference and use. These are sample clauses where a postscript file has been inserted into Microsoft Word as described later in this section.
See Understanding Adobe Acrobat Digital Signatures Using Postscript Files.
Specific user-signature fields.
This method for creating signature clauses provides each individual signer a unique signature field. With this method, you create a postscript file using the PeopleSoft-delivered file with a specific signer's name in the file. Then, you create a unique clause with the created postscript file. You use rules to include the correct signature based on who the signer is for that document. This setup is not generally recommended because of long-term maintenance issues, but may work well if an organization typically has only a few specific signers for documents.
Note. In Adobe Acrobat, an advantage of using specific user-signature fields for each signer instead of generic fields is that the signer's name appears within the PDF list of signers so they can click on their name to obtain the signature field. This is instead of checking for a generic field such as director. However, with generic signature fields, you can also have the specialist manually change the PDF to replace the title with the signer's name as part of the document signature preparation.
Signature list on the document header versus signature fields in the document.
Within Document Management a list of signers is specified for each contract document. The list can be defaulted for each contract administrator. This list controls if a user is to have access to the Sign Document button on the Document Management page for signing, as well as routing a document internally before or after approvals for signatures depending on configuration. Separately, but as important, is the signature field provided for each of the signers within the document as previously discussed using postscript file for PDF. Depending on the variability of digital signatures required for your various documents the setup for this may be simple or more complex rules driven. For example, a simple approach is to always include a single signature clause with the number of signatures in the file, because it will always match n number of signers within the document header list.
A slightly more complex way to include a signature could be to provide a wizard question specifying the number of signers to drive a rule including the write signature clauses. And, using a more sophisticated solution is to use or create your own rule that includes the correct signature clauses based on the number of signers specified for a given document.
If you are using Adobe Acrobat digital signatures, a signature field in a clause is created by inserting a picture using the signature postscript file. A sample postscript file is delivered by Oracle, but it has to be edited to show the signer's name or title. If you are using Microsoft Word digital signatures, a signature field in a clause is created by inserting a Microsoft Word signature line where you specify the signer's name, title, and email address.
Note. When you use Microsoft Word 2007, or later version, you don't need the image files. You insert the signature field using Microsoft Word - Signature Line and place the binds below the signature fields. You still insert the signers generically.
Digital Signature Set Up Steps
To set up digital signatures:
Setup PeopleSoft Integration Broker to enable rendering of signature documents.
Note. Consider verifying your setup for server processing by performing a trial run for sending the document to contacts using the PDF format. Click the Send to Contacts button on the Document Management page to perform the test.
See (Optional) Setting Up PeopleSoft Integration Broker for Microsoft Word and Adobe Integration.
Update installation options to enable internal and external signatures and indicate the signature method.
Using installation options, you enable digital signatures for the PeopleSoft Supplier Contract Management installation. You can select to use either Adobe Acrobat or Microsoft Word 2007, or later version, for digital signatures. In addition, you can update the generic templates used for signatures to meet the organizations needs. These templates are the email messages associated with the digital signature process. You use the Generic Template Definition page to make changes to the instructions and message text. To access the page, select PeopleTools, Workflow, Notifications, Generic Templates.
Note. You must enable digital signatures on the Installation Options page before you can use them with document types.
Enable internal and external signatures for appropriate document types.
If you are using document types as recommended, you must enable digital signatures for each document type requiring digital signatures. You cannot change the digital signature method. The system automatically uses the installation setting. Additionally, you can set document types to control whether to capture signatures before, during, or after approvals.
Set up the supplier-side to enable online signatures.
The system enables the email dispatch of a signature file for the supplier without having to setup supplier portal access. However, when you enable supply-side integration with PeopleSoft Supplier Contract Management, you can optionally have the supplier access the file for signing directly online. When taking this approach you use the Send to Contacts and Dispatch functionality to notify the supplier using email with URLs that provide supply-side users with links directly to the supply-side web site.
Create postscript signature files to use in signature clauses and sections as placeholders for digital signatures.
The system provides two sample postscript files, one for visible signatures and one for invisible signatures.
Create sections and clauses with signature placeholders.
The system supplies some samples of this within the sample database CL_SAMPLE_PDF_CLAUSE1, 2, and 3 for reference. These clauses contain some sample inserted postscript files from step 5.
Add signature placeholders sections and clauses to document configurators.
Add a document that uses the digital signatures.
This includes adding or defaulting signers to the document header and creating the authored document that can also use rules to determine proper signature clauses. Also, prepare the document for signatures and route it to each signer through the internal and external signature processes.
To map supplier-side users to a contract, use the Vendor Contact page to define external contacts for signing.
The routing and signing process is described in the Managing Document Life Cycles chapter.
To create a signature field for Adobe Acrobat documents, you use a postscript file to insert a signature field when editing a clause, section, or contract document in Microsoft Word. A signature field displays as an image in the Microsoft Word document. When a contract document is prepared for signature, the system converts the document to a PDF and the signature fields are displayed as Adobe Acrobat digital signature fields and signers can sign the document using Adobe Digital IDs.
A sample postscript file is included in your installation directory. For each signature field or signer in a contract document, you should:
Open a copy of the postscript file (SignatureField.eps) in Notepad (or other text editor), edit the text after the /T symbol, and save the file as a <filename>.eps extension.
You can either enter the same text for the /TU for tooltip on the signature field, or you can delete the line.
Edit the appropriate clauses in Microsoft Word, and from the toolbar, insert the file (Insert, Picture, From File) and select the appropriate <filename>.eps file that you just saved.
The image appears within the clause as an empty highlighted box. This is the signature field that will convert and display within the PDF after the document is authored with this clause and prepared for signature.
Adobe uses a postscript image placeholder file to insert signature boxes into a contract document. Adobe places a special postscript signature placeholder file image in the document, such as within a clause or section to gather signatures. When the document is converted to a .PDF, the placeholder field becomes the signature area in the document and enables signers to sign the document using digital IDs.
This example illustrates the delivered postscript SignatureField.eps file:
%!PS-Adobe-3.0 EPSF-3.0 %%BoundingBox: 0 0 200 50 %%Title: (Signature Field) %%Creator: (Adobe Systems Inc.) % This example illustrates how to define a signature field % Each signature field used in a document must have a unique name identified by⇒ "Signature1" at the end of this file % Set __pdfMark__ true if pdfmark is already defined %%BeginPDFMarkPrefix /pdfmark where { pop /__pdfMark__ true def }{ /pdfmark {cleartomark} def /__pdfMark__ false def } ifelse %%EndPDFMarkPrefix % Includes these required entries: % Fields (the array from where all fields in the form can be found) % NeedAppearances boolean, set to true so field appearances are generated when the⇒ document is opened [ /_objdef {afields} /type /array /OBJ pdfmark [ /_objdef {aform} /type /dict /OBJ pdfmark [ {aform} << /Fields {afields} /NeedAppearances true >> /PUT pdfmark [ {Catalog} << /AcroForm {aform} >> /PUT pdfmark %%>> %End AcroForm % Actual signature field Signature field [ /Subtype /Widget /Rect [ 0 0 200 50 ] /F 4 /T (Signature1) /TU (Signature1) /FT /Sig /Ff 0 /MK << /BC [0 0 0] /BG [1 1 1] >> /BS << /W 1 /S /S >> /ANN pdfmark %%EOF
Note. Each of these signature placeholder image files must have a unique signer name as the /T symbol in the SignatureField.eps postcript file when the system creates the document. So, if the created document has three signature fields, the /T value specified in each of the postscript file must be different. PeopleSoft Supplier Contract Management provides visible and invisible signature postscript files. You can edit the postscript files to create as many unique files as you want with either generic signature titles or specific names embedded in the file.
Note. Clauses with signature placeholders cannot be repeating clauses. Otherwise you could have created one clause with one signature file image in it and then treated it as a repeating clause against a list of signers. A signature field must be unique within the document based on signer name.
You create a signature field in the Microsoft Word document using the Microsoft Word - Signature Line feature. So, if you were to create a signature clause, edit the clause content in Microsoft Word, and insert the signature line object. When the entire contract document is prepared for signature, it will be converted to .docx file format where signers will be able to sign the document. The .docx file format is intended for signatures only and the .xml file remains as the editable document. After the signature process begins, the .xml contract document is in a read-only state and cannot be modified. The system will not display the Edit Document button.
The setup for Microsoft Word signatures requires that you edit the Microsoft Word versions of the signature clauses using Microsoft Word 2007, or later version, but in the .xml format, adding the appropriate signature fields within the clause. Generic signatures are recommended when possible. When using Microsoft Word to capture signatures you use generic signatures instead of using postscript files that were previously described for Adobe/PDF signature method.
Note. The requirement for using the .docx format is that all signers, both internal users and external suppliers, must use Microsoft Word 2007, or later version. Unlike the PDF format the .docx format is still a Microsoft Word document and in certain statuses can be edited. After the first signature, for example, the contract specialist, is placed on the document and the .docx file can no longer be modified itself unless all signatures are cleared. Therefore, you should take care when using a .docx format to ensure that the contract specialist signs the document as part of the prepare process, and as a follow-up ensure that the document signatures have not been cleared by other users.
Additionally, you must set the installation option Signature Method field value to Word and setup for installing Microsoft Word 2007, or later version, on the server.
See Understanding System Setup for Microsoft Word Configuration Files and PeopleSoft Integration Broker.
To set up installation options, use the Installation Options component (INSTALLATION_CS).
This section provides overviews of document comparisons and rendering and document comparison and rendering setup and discusses how to define installation options for PeopleSoft Supplier Contract Management.
Document comparisons enable you to compare the current document to a temporarily re-created, refreshed, or last-executed document. Last-executed documents are available only 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. In addition, you can compare any two document versions from history for an understanding of changes between different Microsoft Word-based checked-in versions.
The resulting output document highlights the differences between the documents you chose to compare. You can use this feature to determine what the impact of doing a document refresh or re-creation would be and what changes you would lose or gain as well as to see what changes were made to specific versions in history.
Document rendering is the process in which the system provides files in a .doc or a .pdf format to users who do not want to use Microsoft Word to view the documents. When the system creates XML documents, they are meant to be opened only using Microsoft Word. If suppliers do not have this version available to them or if they prefer to review the documents in a .doc or .pdf format, then you use the Installation Options page to set up information enabling the system to convert the documents from an XML format to a .doc or .pdf format.
Conversion to a .doc or .pdf format is available only 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 or .pdf file formats.
To compare and render documents, you must enable the features using the Installation Options page. Using installation options, you define 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. You also define the machine name of the Windows NT application server and port that has been set up with Microsoft Word and the CSDOCUTIL.DLL file.
Note. The temporary directory should be operating-system specific if a single operating system is being used in the implementation for all applications servers. If multiple operating-system application servers are in the implementation (for example Unix and NT), you should leave the Application Server Path field blank on the Installation Options page.
Oracle delivers the service operations in PeopleSoft Integration Broker with a default status of Inactive. You must activate each service operation before attempting to send or receive data from a third-party source or another PeopleSoft system, such as Supply Chain Management.
Note. Your database administrator will need to assist you with this setup.
See Incoming and Outgoing Request Flows, "Understanding PeopleSoft Integration Broker," PeopleTools PeopleBook: Integration Broker.
To prepare a system to use the compare and render features:
Ensure that a Microsoft Windows-based server machine, such as Windows 2000 or Windows XP, 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.
If you select the Enable Rendering .doc check box in installation options, ensure that the same server machine has Microsoft Word installed on it.
The CSDOCUTIL program interacts with Microsoft Word on the machine.
If you are select the Enable Rendering .pdf check box in installation options, ensure that the same server machine has Adobe Acrobat 8 installed on it.
The CSDOCUTIL program interacts with Adobe Acrobat 8.
Configure the Integration Gateway if it's not already configured for the database.
The integration gateway is a platform that manages the receipt and delivery of messages that are passed among systems through PeopleSoft Integration Broker.
See "Managing Integration Gateways," PeopleTools PeopleBook: Integration Broker.
Activate the CS_DOC_ACTION service operation.
This service operation is a synchronous operation and serves as the integration that handles all requests to the Document Utilities library. Using the library, the system converts documents to a .doc format and enables the comparison of documents using the Document Management page.
To activate the service operation:
Select PeopleTools, Integration Broker, Integration Setup, Service Operations.
Select CS_DOC_ACTION in the Service Operation field.
Click Search.
The service operation appears in the search results.
Click the Service Operation link.
The Service Operations page appears with the service operation definition. The definition consists of general information about an operation, such as its name and alias if one has been defined. It also specifies an operation type, which determines how the operation is to be processed, synchronously or asynchronously. The CS_DOC_ACTION operation is processed synchronously, meaning that the system waits for a response to the message. In addition, the service operation definition contains routings, which determine the direction, inbound or outbound, of the service operation. A service operation has one or more handlers, which contain and run the programming logic for sending or receiving the message and manipulating message content.
See Incoming and Outgoing Request Flows, "Understanding PeopleSoft Integration Broker," PeopleTools PeopleBook: Integration Broker.
See "Managing Service Operations," PeopleTools PeopleBook: Integration Broker.
Ensure that the Active check box is selected in the Default Service Operation Version group box.
If the version that you want is not the default version for the service operation, the default version must also be activated.
Select the Handlers tab.
The page provides summary information about handlers that have been added to an operation. Two individual server processes work together to handle incoming requests. One server process functions as a dispatcher, while the other functions as a handler. You can specify an application class as a handler for a service operation. The CS_DOC_ACTION uses an application class handler.
See "Sending and Receiving Messages," PeopleTools PeopleBook: Integration Broker.
Ensure that Active is selected in the Status field on the Handlers tab.
Click the Save button.
Select the Routings tab.
This page provides access to routing information that has been added to an operation. Routings determine the direction, inbound or outbound, of the service operation. The routing page is where you specify the sending and receiving node. The Sender Node field value should be ANY for both the CS_SEARCH_BINDS and CS_SEARCH_ CLAUSES operations. The Receiver Node field value should equal to the value for the database's default local node. This value appears on the Nodes page and contains Y in the Local Node Name column for the node.
Select the Active check box.
Click the Save button.
See Understanding Integration Setup, "Appendix: Integration Scenarios," PeopleTools PeopleBook: Integration Broker.
Set the CS_DOC_LIBRARY queue status to Run.
A queue isolates different groups of service operations from each other. The CS_DOC_LIBRARY queue queues the CS_DOC_ACTION service operation for processing.
See "Managing Service Operation Queues," PeopleTools PeopleBook: Integration Broker.
To set the queue status:
Select PeopleTools, Integration Broker, Integration Setup, Queues.
Ensure that Run is selected in the Queue Status field.
Click the Save button.
Complete the fields in the Document Compares & Rendering grid in the Installation Options component.
This is a part of setting up the PeopleSoft Supplier Contract Management application and is described in the next sections.
After completing these steps, you can convert documents to a .doc format and compare documents using the Document Management page.
Page Name |
Definition 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 (Supplier Contracts, Supplier Contracts Setup, Installation Options).
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 file attachment server. You might want to select a directory such as c:\temp, which exists on Windows NT application servers. Note. The temporary directory should be operating-system specific if a single operating system is being used in the implementation for all application servers. If multiple operating-system application servers are in the implementation, for example Unix and NT, you should leave this field blank. |
Document Compares and Rendering
Use this section to enable server-side Microsoft Word processing. This includes comparisons of the current authored document with a temporarily created version of a refreshed or re-created 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 or Adobe .pdf version of the XML-generated documents to send to suppliers who might be using a version of Microsoft Word that is prior to the Microsoft Word version that is on your system. After you enable rendering, the system displays the correct rendering options on the Send to Contacts and Dispatch to Contacts pages. You can test the URL and gateway settings to verify that they are correct and running.
Enable Compare Functionality |
Select to permit the document administrator to run a server-side comparison of the current authored document against a re-created version or refreshed version of the document. The comparison displays the differences and is for information purposes only. The compare functionality also enables the system to compare a main amended contract with the last executed version. |
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 the same version of Microsoft Word that your organizations uses and cannot read an .xml version of the file. |
Enable Rendering .pdf |
Select to permit the generation of an Adobe .pdf format document when dispatching a document or sending it to contacts. |
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 and the CSDOCUTIL.DLL file. The Compare/Render Server URL field does not require a web server. This communication is within PeopleTools and messaging is at the application-server level. The request from the application is sent to the application server using the NT machine. The machine is the NT application server machine. The machine and port are passed as parameters using an internal synchronous message that is interpreted by PeopleTools and ensures that the request is run on the NT machine where Microsoft Word or Adobe Acrobat is installed so that the comparison or rendering to .doc or .pdf can take place. The port is the Jolt Server Listener port and should be the same port that was set up with the PeopleSoft application server on the NT machine. |
Verify Server Path |
Click to test the render feature. When you test rendering in DOC or PDF, the system verifies that the application server that you entered in the Compare/Render Server URL field and the gateway are setup correctly and running. The system tests for document rendering setup for Microsoft Word and Adobe PDF formats if those check boxes are selected. The testing assists with establishing the compare and render features for the Document Management component such as document comparisons, dispatch formats, and digital signatures. During the testing, the system provides information messages related to the server connection. For example, if the Compare/Render Sever URL field is blank, a message appears indicating that data was not found in the field. When the test is complete and successful, the system displays this message if rendering check boxes in the Document Compares and Rendering section are selected: "Connect to application server (SERVER NAME): SUCCESSFUL, Test to render document in .doc format: PASSED, Test to render document in PDF: PASSED." The button name is then updated to Setup is Successful which you can use to test the connection at anytime. Note. Upon successful testing of each of the features, the system saves the data that you entered. Other conditions for test results include:
|
Setup is Successful |
Click to test the compare and render features again. This button appears after an initial test has been successful. You can use the button to retest the features, for example if you click the Enable Rendering .doc, the system will verify that the rendering setup is correct and running. |
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. |
Filter Results Without Chunking For Documents |
Select to enable filtering of search results based on user security access to the document. When you select this check box, only rows for users who have access to documents appear in the search results. These users can include administrators or interested parties as examples. This helps reduce the number of results. When you select this check box, the system ignores the chunk size value when searching for documents. |
See Searching for Library and Document Contents.
See Implementing the Verity Search Engine.
Processing Options
Use this group box to define system processing options for purchasing contract syndication and document preferences on various features. 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 deselected.
See Syndicating Supplier Contracts and Contract Messaging.
Enabled Transactional Sources
Use this section to define whether PeopleSoft Supplier Contract Management users can author contracts using purchasing contracts or the purchase orders in the PeopleSoft Purchasing application.
When you select a check box, the system includes that selection in the list of values for source transactions, such as when you add a document or a document type. You can also perform Verity searches based on the transactional source that you select. You do not need to enable the ad hoc source because it is always available.
Purchasing Contracts |
Select to enable document creation from a transactional purchasing contract using the Contract Entry feature in PeopleSoft Purchasing. The default value for the check box is selected. |
Purchase Orders |
Select to enable document creation or association with transactional purchase orders in PeopleSoft Purchasing. The default value for the check box is deselected. |
Cycle Time Settings
Use this section to define cycle-time settings for completing contract documents and amendments. For example, you can ensure that contract requirements are achieved in a timely manner by establishing a time frame for completing documents. The settings that you define on this page apply to this installation of PeopleSoft Supplier Contract Management; however, you can override these settings for specific document types using the Document Type feature.
You can also set the number of days before the target cycle time that you want the system to display indicators. Use the Red: Number of Days Prior to Due Date and Yellow: Number of Days Prior to Due Date fields to set the indicators for documents and amendments.
After defining cycle settings, you use the Find Existing Documents page to search for and access documents. Using the results from document searches, you can view which documents and amendments are overdue or pending for collaboration and for approvals. You can also search for documents based on their cycle-time settings using the workbench.
Enable Cycle Time |
Select to indicate that cycle times should be enabled for this installation of PeopleSoft Supplier Contract Management. After you select the check box, the system makes the related fields available. |
Business Calendar |
Select the business calendar that you want to use for document and amendment cycle times. You use business calendars to determine the days, such as holidays or weekends, that should be removed from any cycle-time calculations. You can also create a calendar specifically for use with documents. To define a business calendar, select Set Up Financials/Supply Chain, Common Definitions, Calendar/Schedules, Business Calendar, Business Calendar. |
Complete when Status is |
Select the status at which you want to stop tracking a document's cycle time. For example, you might want to track document cycles during more critical stages when numerous reviewers or approvers are involved in the cycle and not track it for its entire review cycle. Or, the organization might want to track a critical contract document through to its signed and executed. You can end document and amendment cycle tracking at these statuses: Approved Dispatched Executed/Complete Pending Approval |
Target Cycle Time per Document (days) |
Enter the target number of business days that a contract document should take to complete. This cycle begins when you create the document and ends when the document goes into the status that you select in the Complete when Status is field. The system calculates the cycle time using the business calendar so that only official business days are counted based on the calendar. |
Target Cycle Time per Amendment (days) |
Enter the target number of days that a contract amendment should take to complete. |
Red: Number of Days Prior to from Due Date |
Enter the number of days prior to the due date that you want to flag the document with a red flag indicator. When a document falls within the number of days that you enter, the system inserts a red flag indicator on the search results for the Find an Existing Document page. For example if you enter 2 for a document with a due date of March 10, depending on the business calendar, the system inserts the flag on March 8. You use this field to define a more urgent warning, so the number of days that you enter should be fewer than the days that you enter for the yellow flag indicator. You can define the value for documents and amendments. |
Yellow: Number of Days Prior to Due Date |
Enter the number of days prior to the due date that you want to insert a yellow flag indicator in the document workbench. You can define the value for documents and amendments. |
Internal Collaboration
Use this section to define internal and external collaboration settings. Internal and external collaboration are similar; however, with external collaboration, you must set up external users so that they can access documents.
Notifications |
Select the method that the system should use to notify internal collaborators that a document has been routed to them for collaboration. Values are: Email: Select to notify collaborators using email only. Email and Worklist: Select to notify collaborators using both email and worklist methods. None: Select to indicate that a notification is not required. User Preference: Select to use the method defined on a user's preference. Worklist: Select to notify collaborators using worklist only. |
Routing Template |
Select the generic template that the system should use in routing documents for internal collaboration. This template controls the format of information for email notifications when the system routes a document for collaboration. The DocumentCollabReview system-supplied value appears as the default value for the template. See Defining Generic Templates, "Using Notification Templates," PeopleTools PeopleBook: Workflow Technology. |
Done Template |
Select the template that the system should use when internal collaboration has been completed for a document. The template controls the information that appears in the email to the administrator when the collaboration cycle is complete. The DocumentCollabComplete system-supplied value appears as the default value for the Done template. |
Cancel Template |
Select the template that the system should use to alert any pending collaborators when internal collaboration has been canceled for a document. The DocumentStopCollab system-supplied value appears as the default value for the Cancel template. |
External Collaboration
External Collaboration |
Select to enable external collaboration with suppliers who have access to PeopleSoft Supplier Contract Management documents through the Supplier Portal. To perform external collaboration, Oracle recommends that supplier users use the same Microsoft Word version that your organization uses. This ensures that suppliers can make changes and check in the document as an .xml document. If suppliers do not use the same Microsoft Word version, they can check in a .doc version of the document, but the contract administrator will have to manually reconcile any changes. Note. You must enable external collaboration using this check box before you can enable them for a document type on the Document Type page. |
Notifications |
Select the method that the system should use to notify external collaborators when they are listed as collaborators in the document collaboration process. Values are: Email: Select to notify collaborators using email only. Email and Worklist: Select to notify collaborators using both email and the worklist. None: Select to indicate that a notification is not required. User Preference:Select to use the method defined on the user's preference. Worklist: Select to notify collaborators using worklist only. |
Routing Template |
Select the generic template that the system should use in routing documents for external collaboration. This template controls the format of information for email notifications when the system routes a document for external collaboration. The DocumentExternalCollabReview system-supplied value appears as the default value for the template. See Defining Generic Templates, "Using Notification Templates," PeopleTools PeopleBook: Workflow Technology. |
Done Template |
Select the template that the system should use when external collaboration has been completed for a document. The template controls the information that appears in the email to the administrator when collaboration is complete. The DocumentExternalCollabComplete system-supplied value appears as the default value for the Done template. |
Cancel Template |
Select the template that the system should use to alert the external collaborator when an external collaboration cycle has been canceled for a document. The DocumentStopExternalCollab system-supplied value appears as the default value for the Cancel template. |
Approvals and Signatures
Use this section to indicate whether workflow approvals are required for clauses and documents and whether internal and external users can electronically sign a document.
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 PeopleSoft Approval Framework 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. |
Enable Internal Signatures |
Select to enable internal users to digitally sign a document using Adobe Acrobat or Microsoft Word signatures. When you select this check box, you must also select a value in the Signature Method field. Also, when you select to enable internal signatures, the system makes the Enable External Signatures check box available. Typically, the electronic version of the contract can replace the paper-based version. When you enable internal signatures, the Prepare Document for Signing button appears on the Document Management page. The button enables you to convert a document to a .pdf file, stage it for signing, and signal to the system that the document is available for signing. This invokes additional buttons that enable you to convert the document. Note. Because digital signature methods are installation wide, you must enable internal signatures using this check box before you can enable them for a document type on the Document Type page. |
Signature Method |
Select the method for signing a contract document. If you enable internal signatures, you must select a value in this field or the system displays an error message when you save the settings. Signature method values include: Adobe: Select to sign documents using Adobe Systems software. To use this signature method, you must have Adobe Acrobat 8 on the NT application server that is defined in the Document Compares and Rendering section. In addition, the administrator must have Adobe Professional 8 installed and users, who are required to sign a document, must have Adobe Reader installed. Word: Select to sign documents using Microsoft Word. To use this signature method, you must have Microsoft Word 2007, or later version, on the NT application server that is defined in the Document Compares and Rendering section. In addition, users who are required to sign the document must use Microsoft Word 2007, or later version, to sign the document. |
Sign Template |
Select the template that you want to use to send out to internal signers when a document is routed to them for electronic signatures. The DocumentSign system-supplied value for the Sign template appears as the default value for the field. |
Complete Template |
Select the template that you want to use when the routing for internal signatures is complete. The DocumentSignComplete system-supplied value for the Complete template appears as the default value for the field. |
Cancel Template |
Select the template that you want to use to alert any pending signers when the routing for internal signatures is canceled. The DocumentSignCancel system-supplied default value for the Cancel template appears as the default value for the field. |
Decline Signing Template |
Select the template that you want to use when an internal user declines signing a document. The DocumentRejectSigning system-supplied value for the Decline Signing template appears as the default value for the field. |
Enable External Signatures |
Select to enable external users to sign documents using digital signatures. When you select this check box, the system makes the external signature templates available. These are generic templates that you can use to define the content of emails for certain actions between document approvers. Note. Because digital signature methods are installation wide, you must enable external signatures using this check box before you can enable them for a document type on the Document Type page. |
Signed Template |
Select the template that you want to use when an external user has electronically signed a document. The DocumentSupplierSigned system-supplied value for the Signed template appears as the default value for the field. |
Decline Signing Template |
Select the template that you want to use to alert the contract administrator when an external user declines signing a document. The DocumentExternalRejectSigning system-supplied value for the Decline Signing template appears as the default value for the field. |
Cancel Template |
Select the template that you want to use to alert external users when the external signature process is canceled. The DocumentStopExternalSignatures system-supplied value for the Cancel template appears as the default value for the field. |
To set up clause libraries, use the Clause Library Setup component (CS_LIBRARY).
To set up clause groups, use the Clause Group Setup component (CS_CLS_GROUP_DEFN).
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 alternative 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 |
Definition 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 (Supplier Contracts, Supplier Contracts Setup, Libraries).
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 (Supplier Contracts, Supplier Contracts Setup, Groups).
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.
To set up approval types, use the Approval Type Setup component (CS_APPROVAL_TYPE).
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 are 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 PeopleSoft Approval Framework for Use with Supplier Contract Management
Page Name |
Definition Name |
Navigation |
Usage |
CS_APPROVAL_TYPE |
Supplier Contracts, Supplier Contracts Setup, Approval Types |
Define approval types. |
Access the Approval Type page (Supplier Contracts, Supplier Contracts Setup, Approval Types).
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.
Clause Usage
Select the Clause Usage tab.
Clause Changes in Doc (clause changes in document) |
Select if you want this role name as a required approver when a clause of this approval type is updated or deleted within a contract. |
Clause Exists in Doc (clause exists in document) |
Select if you want this role name as a required approver when a clause of this approval type simply exists in a document. |
To set up clause classes, use the Clause Class Setup component (CS_CLS_CLASS).
This section discusses how to set up classes.
Page Name |
Definition Name |
Navigation |
Usage |
CS_CLS_CLASS |
Supplier Contracts, Supplier Contracts Setup, Classes |
Set up classes for document clauses. |
Access the Clause Class page (Supplier Contracts, Supplier Contracts Setup, Classes).
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. |
To set up mappings for bind variables, use the Bind Mapping Setup component (CS_BIND_MAPPING).
To set up source transaction structures, use the Source Transaction Structures Setup component (CS_SRC_TRANS_STRCT).
This section discusses how to:
Define source transaction structures.
Map binds.
Page Name |
Definition 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 (Supplier Contract, Supplier Contracts Setup, Source Transaction Structures).
Use this page to define the hierarchical structure of source transaction structures. After defining the structure, you can associate a bind variable with the actual record or view the field name from which you want to retrieve data.
See Mapping Binds.
Note. Oracle delivers predefined source transaction structures as system data. Although these are documented here, you cannot change these delivered structures.
Source Transaction |
Select the source transaction type for which you want to maintain the base record hierarchy. Values are: Ad Hoc: This is a general-use source transaction that is not associated with a transactional purchasing contract; however, it does enable the binding of information that is related to the fields that are visible on the Document Management page. Purchasing Contracts: This source transaction enables you to create contract documents that can reference and include transactional purchasing contract information such as vendor name, maximum amounts, and items on the contract. Purchase OrdersThis source transaction enables you to create contract documents that can reference and include transactional purchase order information such as vendor name, items and quantities on the PO. |
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 (Supplier Contract, Supplier Contracts Setup, Source Transaction Structures).
Use this page to map bind variables to record views and source records.
Source Transaction |
Select the source transaction type for which you want to map a bind. Values are: Ad Hoc: This is a general-use source transaction that is not associated with a transactional purchasing contract. Purchasing Contracts: This source transaction enables you to create contract documents that can reference and include transactional purchasing contract information such as vendor name and maximum amounts. Purchase OrdersThis source transaction enables you to create contract documents that can reference and include transactional purchase order information such as vendor name and items. |
Record View |
Select the view from which the system gathers data that it uses to resolve the bind in authored documents. |
Source Record |
Select a source record. Source records are ones 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 that is associated with 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 discusses how to define wizard bind prompt tables.
Page Name |
Definition Name |
Navigation |
Usage |
Wizard Bind Prompt Tables |
CS_PROMPTTBL_DEFN |
Supplier Contracts, Supplier Contracts Setup, Wizard Bind Prompt Tables |
Define wizard bind prompt tables. |
Access the Wizard Bind Prompt Tables page (Supplier Contracts, Supplier Contracts Setup, Wizard Bind Prompt Tables).
Use this page to define a list of values for use in setting up binds. These are tables that you optionally predefine with values that are assigned to a specific bind and that you can then access when you run the wizard while authoring documents. Prompt tables are primarily used for ad hoc document generation where certain values cannot be easily derived from a source transaction, yet the values exist in the system and you want to provide users a list of values from the database. After you define the prompt table, you can create a wizard bind variable that is associated with the prompt table.
Note. The alternate method to providing a list of values through a prompt table is to use a static list that you specifically define for a wizard variable within a question group.
See Defining Question Values and Navigation Details.
Prompt tables for bind variables permit records that contain only a single key that is the value on which you want to prompt. You cannot prepopulate higher-level keys, so records with multiple keys are not permitted. If existing records in the database do not meet your needs, contact your system administrator about creating a new view to retrieve required values.
To permanently delete a prompt table, click the Delete button. The system displays a warning message indicating that you will delete the table record.
Prompt Table |
Select an existing prompt table. |
Prompt Fieldname |
Select a prompt value that you want to use for the wizard bind prompt. |
Description |
Enter the description that you want to use for the prompt table. The system initially populates this field with the description for the prompt field name. You can override that description. |
To set up configurator groups, use the Configurator Group component (CS_TEMPLATE_GROUP).
To set up configurator types, use the Configurator Type component (CS_TMPL_TYPE).
This section provides an overview of configurator groups and types and discusses how to:
Define configurator groups.
Define configurator types.
Configurator groups and types help you organize 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 |
Definition Name |
Navigation |
Usage |
CS_TEMPLATE_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 (Supplier Contracts, Supplier Contracts Setup, Document Configurator Group).
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. The Description and Short Description fields are required.
See Also
Understanding Configurator Groups and Types
Access the Document Configurator Type Definition page (Supplier Contracts, Supplier Contracts Setup, Document Configurator Types).
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
To set up document templates and styles, use the Document Template and Styles component (CS_WORD_TMPL_SETUP).
This section provides an overview of document templates and discusses how to:
Define document templates and styles.
Search for where a template is used.
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 Word 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 PeopleSoft Supplier Contract Management application to manage approvals and collaboration.
See Also
Format and Style Considerations in Microsoft Word
Page Name |
Definition Name |
Navigation |
Usage |
CS_WORD_TMPL_SET |
Supplier Contracts, Supplier Contracts Setup, Document Templates and Styles |
Define document templates and styles. |
|
CS_CONTENTS_XREF |
Supplier Contracts, Supplier Contracts Setup, Document Templates and Styles Click the Where Used link on the Define Document Templates and Styles page. |
Search for where a template is used. |
Access the Define Document Templates and Styles page (Supplier Contracts, Supplier Contracts Setup, Document Templates and Styles).
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.
Normally bind variables are included in individual clauses and sections; however, you can include certain bind variables in a template to bind transactional information, for example into a Microsoft Word template's header or footer fields, which then repeats on authored pages of a document. If a specific Microsoft Word template contains header or footer bind variables, and the template is associated with a document configurator, ensure that the bind variables are mapped for the same source transaction as the document configurator. For example, if you set up a document configurator for use with an ad hoc source transaction, then you must also map the transactional bind variables that are used in the Microsoft Word template to the ad hoc source.
The system does not provide a warning if the source transaction for binds is different from the source for the document configurator. The system also does not resolve the binds in the contract document, but provides a message that the bind is unresolved in the document generation log.
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 Supplier Contract Management 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
Access the Search for All Content Instances page (click the Where Used link on the Define Document Templates and Styles page).
Use this page to view where the selected template is used throughout the PeopleSoft Supplier Contract Management system. When you click the Where Used link from the Define Document Templates and Styles page, the system displays the search results using this page. The page displays the content type and content ID in which the template is used. For example, a clause type along with the clause ID.
Click the Description link to view the content type, such as a document configurator, in which the template is used. When you click the field, the system navigates to that document element.
When you click the Where Used link, the system accesses the Search for All Content Instances page where you can search all uses of the content ID in which the template is used.
An example of using the Where Used link search might be when you search for where a standard template is used, the system provides a list for the usage. The list includes a document configurator, you can select the Description link for that configurator to view that configurator. Then, you can select the Where Used link to search for all the documents in which that configurator is used.
To set up default values for document formats and options, use the Configuration component (CS_CONFIG).
This section discusses how to define default settings for document formats and options.
Page Name |
Definition 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 (Supplier Contracts, Supplier Contracts Setup, Document Format and Options).
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 re-create 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 that is 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. The first 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. Select Amendment Files Only 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-defined fields and describes how to set up user-defined fields.
The purpose of user-defined fields is to provide you with a means of defining some additional user-defined attributes to be associated to a document header. When a document is created, you can set up user-defined fields to be enterable directly within Document Management. They can also be captured as part of a wizard response and stored within the Document Management header page as well. PeopleSoft Supplier Contract Management enables you to set up and use these predefined fields to define and search for more specific document information.
When you define a user-defined field, the system makes the field available across a variety of PeopleSoft Supplier Contract Management features in addition to being visible when searching in and using the Document Management component. You can use the fields to search for documents within Verity as a specific database field. For example, if you create a user-defined field for use with a supplier geographic region, then you can use the search dialog to document management to search for those contracts. You can also create a special workflow step within approvals to require special routings based on the fields.
You can use user-defined fields only when document types are enabled at the installation level. The system displays a warning if you set up user-defined fields without having document types enabled. After you enable the settings for all user-defined fields for the entire system using this page, for each document type, you can then specify to not use any of them, use all of them, or use selected user-defined fields.
Oracle delivers these types of user-defined fields:
Four 10-character fields.
Four 30-character fields.
Two 60-character fields.
Five date fields.
Five eight-integer fields.
Five decimal fields (Three (23.3) fields and two (11.4) fields).
Page Name |
Definition Name |
Navigation |
Usage |
User Defined Fields |
CS_USER_FLD_SETUP |
Supplier Contracts, Supplier Contract Setup, User Defined Fields |
Set up user-defined fields. |
Access the User Defined Fields page (Supplier Contracts, Supplier Contract Setup, User Defined Fields).
Field Name |
Displays a system-supplied user field that you can set up with a specific label to use that meets an organization's needs. |
Description |
Displays the system description for the field. The description identifies whether the field is for use with character, date, integer, or decimal values. The description also provides the character length or decimal positions for a field. |
Enable |
Select to enable a field for use across the installation. The makes the field available when you select to use user-defined field in a document type. When you enable the field, it also makes the remaining fields in the row available for input. |
Required |
Select to indicate that this field is a required field when you are creating documents. |
Use in Searching |
Select to use this field when you are performing document or Verity searches. When user-defined fields are set to be available in searching, the Find an Exiting Document page and Verity Search page include a User Defined Fields section. Using that section, you can limit the search to specific attributes for the field. |
Visible to Supplier |
Select to make this field visible to external supplier users. External users cannot change user-defined field values. |
Label to Display |
Enter the label for the field that is to be displayed on all pages. This label appears on all Document Management component pages that use the field. |
Additional Settings
Select the Additional Settings tab.
Set from Wizard |
Select to extract the value from a contract wizard. This enables you to indicate that the value should come from an answer in the wizard. When you select the Set from Wizard check box, the Bind Variable field becomes available for you to select a bind variable name. When you create, refresh, or re-create the document, the system automatically populates this user-defined field with the wizard answer that corresponds to the bind variable. When you view a wizard field in the Document Management component, the field is display only, indicating that it came from the wizard. This option is helpful if you want to set up your routings in the approval cycle based on a wizard value or if you want to do Verity searches based on a wizard value. Setting selected user-defined values from a wizard can be useful when you want to collect a header-level attribute using a wizard question and also want to store it on the document header for searching, visibility, and for workflow routing purposes. |
Bind Variable |
Select a wizard bind variable that you want to use as the value to populate the field when the wizard is invoked. |
Tie to Prompt Table |
Select this check box to indicate that the list of values for this field should come from a prompt table. This option only applies to character fields and only to fields that are not already set to pull the value from a wizard bind. If you select the check box, you will also need to select a prompt record value. |
Prompt Table |
Select a prompt table for use with this user-defined field. When you select to tie a field to a prompt table, the system provides a list of defined tables from which you can select a value. When you create a document, you can see a Prompt button next to the field to help display the available choices for this field. Note. Valid prompt tables for this option must contain a single key. This is the field on which you want to prompt. To use this feature in an environment, you might need to have the system administrator create specific views for the environment to provide users the appropriate selection of data. |
This section provides an overview of automatic numbering and discusses how to set automatic numbering details.
Automatic numbering applies a system-generated number to new objects as they are entered into the system. You can define automatic numbering specifications for PeopleSoft Supplier Contract Management objects, such as clauses and entire documents. When you use automatic numbering, you define the starting sequence for the object, and as the system processes a new object, it assigns the prefix for the starting sequence, plus the remaining numbering scheme for the ID. PeopleSoft Supplier Contract Management provides system-defined numbering specifications.
The application package SAC_ID_GEN contains classes that the system uses for automatic numbering. The default starting sequence comes from the AUTO_NUM_TBL record. The record appears in the list of values, but you can select a different starting sequence if it has been defined. Data is stored in AUTO_NUMFLD_TBL and you use the CS_ADHOC_ID field name to define the start sequence.
Using the Auto Numbering page, you can define the default value for the clause ID to NEXT when each clause is parsed from the incoming file and added to the page. As it creates each clause, the system then assigns the next number with the specified sequence to the clause. You need to set up automatic numbering data for each setID that you use for automatic numbering.
Note. Automatic numbering is optional for clause ID, contract ad hoc ID, section ID, contract reporting entity ID, and contract number.
To set up and use automatic numbering:
Create an entry for each sequence that you want to use for automatic numbering.
For example, suppose that you want to create an automatic numbering sequence for a series of sections that relate to product inspections. Remember that PeopleSoft Supplier Contract Management provides numbering for section IDs. So you will:
Select Supplier Contracts, Supplier Contracts Setup, Auto Numbering.
Select the Add a new Value tab.
Select Contract Sections in the Number Type field.
The Auto Numbering page appears.
Select CS_OBJECT_ID in the Field Name field.
Complete the numbering details.
For example, you could name the starting sequence for the number INS for inspections. After completing the details, save the new automatic numbering scheme for contract sections. Then, if you wanted, you could add another starting sequence for a different type of inspection or for general sections. With the numbering details set up, you can now select the default value for automatic numbering and automatically generate numbers for sections.
Select INS as the default starting sequence.
This automatically adds a section with the INS starting sequence when you create a section. If you do not select a default value for the starting sequence, the system uses the last sequence that was added as the default, and automatically selects it when you save the page.
Select Supplier Contracts, Manage Contract Library, Sections.
Select the Add a New Value tab.
The system inserts NEXT in the Section ID field. This is a placeholder.
Click Add, and enter the section information.
Save the section.
The system applies the default prefix for the starting sequence and then applies the numbering scheme by using the next available number in the sequence.
Page Name |
Definition Name |
Navigation |
Usage |
Auto Numbering |
AUTO_NUM_PNL |
Supplier Contracts, Supplier Contract Setup, Auto Numbering |
Set automatic numbering details. |
Access the Auto Numbering page (Supplier Contracts, Supplier Contract Setup, Auto Numbering).
You use the Auto Numbering page to define number types and starting sequences for documents. The system uses the row that is marked as the default value for automatic numbering if document type is selected as an installation option. You can use each start sequence later for one or more document types.
Note. For clauses, sections, and contract reporting entities, a single numbering scheme, which is the default value, can be active at any time for each setID. For ad hoc ID numbering, users who are not using document types, or document types for which the sequence is not specified on the Document Type Setup page, you have one active automatic numbering scheme as well. However, if you define numbering schemes for multiple contract ad hoc IDs, you can select which one to use on the Document Type page. This enables the use of a specific nondefault-value numbering scheme for each document type.
Number Type |
Displays the number type to which these automatic-numbering details belong. Number types are provided with PeopleSoft Supplier Contract Management and include: Contract Ad Hoc ID Contract Clause Contract Reporting Entity Contract Section |
Field Name |
Select a field for automatic numbering. The field that you select should be the key field that you want for the type of number that you are generating. Fields for each of the PeopleSoft Supplier Contract Management number types are: Contract Ad Hoc ID: CS_ADHOC_ID Contract Clause: CS_OBJECT_ID Contract Section: CS_OBJECT_ID Contract Reporting Entity: REPORT_ENTITY You can set up automatic numbering in PeopleSoft Purchasing for the transactional purchasing contract. This is similar to the numbering concept for the Contract Entry component in PeopleSoft Supplier Contract Management. |
Start Seq (start sequence) |
Enter a prefix using up to three alphanumeric characters. For example, for the CS_ADHOC_ID field, you might want to use a unique prefix of DOC for generated documents. When you create the document, the system uses the NEXT value as the ad hoc ID, and will automatically number the document DOC with the next available number that is appended to the new ID. This is the number that is used for the last document, plus one. When you enter fewer than 3 characters, the system automatically adds zeros to complete the start sequence. Then, for example, if you use 2 as the starting sequence, the system updates the field to 200. As it assigns numbers, the system then increments the new number by one when assigning new numbers. In the example, if the maximum length is five, then a number might eventually appear as 20025, with the first three numbers representing the start sequence. |
Max Length (maximum length) |
Enter a maximum character length for the number. The length cannot exceed the length of the field that appears with the field name. |
Last Number Issued |
Displays the last number that the system used to generate an automatic number in this numbering sequence. The starting value is zero, meaning that the system will assign 1 as the next ending number. You can change the number. If you change the number, automatic numbering will increment the next number in the sequence by one. |
Default |
Select if you want the system to use a certain sequence as the default value for automatic numbering. You can select only one sequence. If document type is selected in installation options, and no start sequence is specified for a document type, the system uses the sequence that is selected as the default. |
To set up user preferences, use the PeopleSoft Supplier Contract Management Define User Preferences component (OPR_DEF_TABLE_CS).
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 and librarians) 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. Librarians are users who manage and update content in the contract library. This includes clauses, sections, configurators, wizards, and question groups. PeopleSoft Supplier Contract Management provides a sample librarian user role.
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.
Users whom you intend to be capable to generate documents of any type must be set up with at least document administrator capabilities. Also, the use of document types should be considered when you are defining user preferences. For example, if you intend to have documents generated only by contract specialists who are using document types for contracts only or who are not using document types, you might want to grant document administrator capabilities to contract specialists only.
On the other hand, if you intend to use document types for generic purposes, such as a generic request-for-contract type for documents that are tied to requisitions, then you need to set up all users whom you intend to permit requesting documents as document administrators, and use the role filter in document type setup to restrict those users to creating just the request.
See Setting Up Document Types.
In addition to providing user preferences for document administrators and librarians, you use user preferences to define security settings to segregate the duties of approving sections, changing document configurator statuses, and importing documents. These may or may not be the same users as document administrator users.
Page Name |
Definition 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 that users can perform on supplier contract documents. |
Access the User Preferences page (Supplier Contracts, Supplier Contracts Setup, Define User Preferences, and click the Supplier Contract Management link).
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. Those users can approve library sections and set configurator status.
The application administrator completes the setup information for user preferences for any document administrator.
Document and Librarian Authorizations
The application administrator uses this group box to grant security for document administrators and librarians who will manage section approvals and status changes for configurators and who import documents.
Librarian
Use this grid box to set default values for clause librarians. You can set the default approval for sections and clauses and whether the librarian can change the status of a document configurator. The default values apply to the user ID that you select.
Approve Sections |
Select to indicate that a librarian can mark a section as approved, making the section available for use in documents. Section statuses can be changed or set to Approved on the Section Definition page. |
Default Section Status |
Select the default value for the status when this librarian creates a new section. This saves time in submitting the section for approval. Values include Approved and Initial. This field is available when the Approve Sections check box has been selected. When this value is set to Approved, and the librarian checks out an approved section and makes changes, the system does not set the status back to Initial. Rather, it leaves it as Approved. |
Default Clause Status |
Select the default value for the status when this librarian creates a new clause. This saves time when librarians are not using clause approvals by allowing certain librarians to set clauses as approved by default. Values include Approved and Initial. This field is not available when the Clause Approval option is selected on the Installation Options page. In this case, the default value is Initial because all clauses must be submitted for approval. When this value is set to Approved, and the librarian checks out an approved clause and makes changes, the system does not set the status back to Initial. Rather, it leaves it as Approved. |
Change Configurator Status |
Select to indicate that the user can update the status of a document configurator. Configurator statuses can be changed on the Configurator Definition page. |
Authorize Document Access for
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. While members of his department or group are away from the office, the user has the authority to perform tasks for his or her documents.
Note. You can also copy user IDs from the Purchase Order Authorizations page to populate this grid. Click the Copy PO Authorized for Users check box to copy the user IDs.
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. |