Setting Up PeopleSoft Integration Broker for Microsoft Word
These topics are discussed:
|
Page Name |
Definition Name |
Usage |
|---|---|---|
|
Gateways Page |
IB_GATEWAY |
Configure gateways. |
|
Service Operations - General Page |
IB_SERVICE |
Define and activate a service operation. |
|
Service Operations - Handlers Page |
IB_SERVICEHDLR |
Activate one or more service operation handlers. |
|
Service Operations - Routings Page |
IB_ROUTINGDEFN |
Define and activate routing definitions on the service operation. |
|
Queue Definitions Page |
IB_QUEUEDEFN |
Set the queue used by the service operation to Run. |
|
Node Definitions Page |
IB_NODE |
Activate the node used by the service operation. |
|
Nodes - Connectors Page |
IB_NODECONN |
Verify that the node is connected to the correct network for an outbound service operation. |
For additional information and to navigate to these pages, see PeopleTools: Integration Broker.
Microsoft Office Open XML integration is a core requirement of PeopleSoft Supplier Contract Management. You can use Microsoft Word 2007 or a 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 topic 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 do not 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 Components on Devices.
Example: Using the Microsoft Word - Research Task Pane
After you install components on a 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 terminate in a clause ID, description, or title:
This example illustrates the fields and controls on the Example of a Microsoft Word - Research task pane.
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 then run the install again for the new settings to take effect.
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: Integration Broker.
Steps to Set Up Integration Broker to Use the Microsoft Word - Research Task Pane
Follow these steps 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 is 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: 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
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: Integration Broker.
Verify 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, PeopleTools: Integration Broker.
See "Managing Service Operations," and “Setting Up Service Operations, "Implementing Integrations," PeopleTools: Integration Broker.
To access the Clause Definition Page from a Microsoft Word - Research task pane, you must to establish a URL that appears as the clause name. To do this, you must define a server and location for the EMP_SERVLET URL.
To set up the URL:
Select .
Search for the EMP_SERVLET URL identifier.
Enter a partial URL in the URL field.
An example of the formatting appears on the page. An entry might be: http://pfas027.peoplesoft.com:8001/psp/e900r20bnt/EMPLOYEE/. See the example in the Understanding PeopleSoft Integration Broker Setup for Microsoft Word, Example: Using the Microsoft Word - Research Task Pane topic to view how the URL appears in the Research pane.
See the Integration Broker Setup to Enable Workstation’s Word Research Task Pane Searches subtopic in the Understanding PeopleSoft Integration Broker Setup for Microsoft Word topic.