This chapter discusses the Send Master utility and describes how to:
Start Send Master.
Navigate in Send Master.
Set display preferences.
Set HTTP proxy and keystore options.
Create Send Master projects.
Enter header information in Send Master projects.
Add input files to projects.
Use input file projects.
Use Integration Broker projects.
Use EIP Test (Batch EIP) projects.
Use JMS projects.
Work with groups of projects.
Ping remote nodes.
View processing performance statistics.
Export request messages for viewing.
Allocate additional memory to accommodate posting large files.
The Send Master utility enables you to test PeopleSoft Integration Broker service operation interactions with PeopleSoft and third-party web servers, application servers, and integration gateways. It can test listening connector functionality, target connector functionality, connector introspection and transactions.
Send Master enables you to post any data format, including the PeopleSoft Multipurpose Internet Mail Extensions (MIME) message format, to web and application servers over HTTP and HTTPS. You can also use Send Master to simultaneously test groups of different types of service operations, as well as stress test your system.
Send Master also enables you to perform Get functions and to ping application messaging gateways and third-party servers.
Send Master is installed with the PeopleSoft Pure Internet Architecture on Windows and UNIX systems and is delivered as part of the Integration Broker Connector SDK. Send Master is also delivered as a Windows stand-alone batch file. The stand alone version enables you to use the utility without having to install an integration gateway.
You can start Send Master from the Integration Broker SDK or as a stand-alone version.
Note. The starting size of Send Master is 50 megabytes (MB) and Send Master starts showing issues with startup if other heavy processes like Oracle, eclipse or JDeveloper are running.
The location of Send Master in the Integration Broker SDK depends on the on web server:
For Oracle WebLogic the location is <PIA_HOME>\webserv\<DOMAIN>\<BIN>.
For IBM WebSphere the location is <PIA_HOME>\webserv|<BIN>.
The name of the Send Master startup script on Windows is StartSendMaster.bat; the name of the script on UNIX is StartSendMaster.sh.
The standalone version of Send Master is located in the <PS_HOME>\Sendmaster folder, and is named StartSendMaster.bat. If you attempt to launch the batch file and Send Master does not open, you most likely need to set PS_HOME in the environment variables on your machine.
To set PS_HOME in the environment variables:
Close any DOS windows that might be open.
Right-click My Computer and click Properties.
The System Properties dialog appears.
Click the Advanced tab.
In the Environment Variables section, click Environment Variables.
In the User variables for <user name> section, click New.
A New User Variable dialog box appears.
In the Variable Name field enter PS_HOME.
In the Variable Value field, enter the path to your <PS_HOME> directory (for example, c:\PT852).
Click OK.
The PS_HOME variable name and value appears in the User variables for <user name> section.
Click OK again and navigate to the standalone version of Send Master and double-click the StartSendMaster.bat file.
PeopleSoft Integration Broker introduced its services-oriented architecture in PeopleTools 8.48.
You can use Send Master to test integrations created with the pre-PeopleTools 8.48 framework (PeopleTools 8.47 and earlier releases). To set Send Master for PeopleTools releases prior to PeopleTools 8.48, launch StartSendMaster.bat from the command line with 847 as the argument.
For example:
StartSendMaster.bat 847
Send Master features drop-down menus that you use to create, save and delete projects, and to change your user and display preferences. It also features Project and Batch Processing work spaces where you specify project parameters, view output, and so on.
You can navigate in Send Master using:
Send Master menus.
The Project work space.
The Send Master Batch work space.
Send Master features two menus. This table describes the menus:
Menu |
Menu Option |
Shortcut |
Action |
File |
New Project |
Alt + N |
Creates a new projects. |
File |
Save Project |
Alt + S |
Saves the current project. |
File |
Delete Project |
Alt + D |
Deletes the current project. |
File |
Batch Processing |
Alt + B |
Opens the Batch Processing work space. |
File |
Preferences |
Alt + P |
Opens the Preferences dialog box, from which you can:
|
File |
Export IBRequest |
Alt + E |
Exports a service operation request to a file. |
File |
Exit |
Ctrl + E |
Closes Send Master. |
Help |
About Send Master… |
None |
Displays Send Master version information. |
When you open Send Master, the system displays the Project work space. You use the Project work space to define, modify, and test a Send Master project.
The Send Master Project work space features the Project Definitions section, the Input Information section, and the Output Information section. No fields or buttons are enabled until you define or select a project.
Project Definition Section
Use the Project Definition section to add and define a new Send Master project. The information that you specify in this section includes the web server URL used in conjunction with the selected HTTP action (method) to work with service operations.
This section features the following fields and controls:
Project |
After you create or open a project, the Project field displays the project name and project type. |
Address |
Enter the web server URL to use in conjunction with the test. |
Timeout (secs) |
Enter the timeout interval in seconds. |
Action |
From the Action drop-down list, select the HTTP method to employ for the test. The options are:
|
|
Click the Go button to launch the test. |
|
Click the Stop button to stop test processing. |
Input Information Section
Depending on the type of task that you are performing with Send Master, the Input Information section enables you to create and format MIME messages, as well as specify input files, destination nodes and more.
You need to know the service operation format that the connectors, application servers, and so forth are expecting, and then incorporate the appropriate tags and components into the service operation transaction content. For example, to communicate with PeopleSoft systems, you must specify the service operation name with the version and requesting node.
This section features a toolbar with the following buttons:
|
Click the Open File button to open an existing file and display it in the Input Information area. |
|
Click the Save File button to save the contents displayed in the Input Information area, using a filename and location that you specify. |
|
Click the Save File As button to save the currently displayed file, using another name, location, or both, that you specify. |
|
Click the Refresh the Current File button to reload and display the last saved version of the current file. |
|
Click the Remove File Reference button to delete the contents of the Input Information area. |
|
Click the If Valid XML, Format button to format the code displayed in the section to make it more readable. This button is valid only if the file displayed is an XML file. |
The Output Information section displays information that the system returns when you perform a GET or POST on a web server.
When you work with MIME messages, you can use the provided View drop-down list and choose whether to view the entire raw message response, message metadata, or individual sections of the response.
When you work with message types other than MIME, you can view the raw message response only.
This section features a toolbar with the following buttons:
|
Click the View Header Information button to display the HTTP headers returned during a POST or GET. |
|
Click the Save Output button to save the information in the Output Information section using a filename and location that you specify. |
|
Click the If Valid XML, Format button to format the code displayed in the section to make it more readable. This button is valid only if the file displayed is an XML file. |
|
Click the Clear Output button to delete the contents of the Output Information area. |
The Send Master Batch work space enables you to test groups of projects, as well as stress test a project or group of projects. You can access the Batch Processing work space by starting Send Master, opening an EIP Testing (Batch EIP) project and selecting File, Batch Processing.
The Batch Processing work space features these sections:
Group Definition
Group Projects
Completed Projects Output
Output Information
Group Definitions Section
You use the Group Definitions section to create, select, or delete a group of projects. You can also use this section to specify whether to run the projects in the group all at once, in sequence, or at intervals that you specify.
This section features these two buttons:
|
Click the Start Projects button to start processing the defined group. |
|
Click the Stop Projects button to stop processing the defined groups. |
Group Projects Section
You use the Group Projects section to add, remove, and arrange projects in a group. For each project that you add to a group, you can select the method to invoke, such as GET or POST. You can also specify the number of times to run each project, and specify whether to run project instances all at once, in sequence, or at defined intervals.
This section features a toolbar with the following buttons:
|
Click the Add a New Project button to add a project to the group. |
|
Click the Delete Selected Project button to delete the selected project from the group. |
|
Click the Update Selected Project button to update the selected project with changes and modifications that were made to it since it was added to the group. |
|
Click the Move Selected Project Up button to move the selected project up in the order sequence of projects in the group. |
|
Click the Move Selected Project Down button to move the selected project down in the order sequence of projects in the group. |
Completed Projects Output Section
The Completed Projects Output section provides processing information about each project in a group, including the number of project instances processed, total time to process all project instances, the average amount of time to process a project instance, and more.
This section features a toolbar with the following buttons:
|
Click the Export Results to File button to display a text file that contains processing information about the completed project, such as the number of service operations processed, the total time to process the service operations, the average time to process a service operation, and so forth. |
|
Click the Clear Results button to clear the contents currently displayed. |
The Output Information section displays information that the system returns when you perform a Get or Post on a web server.
When you work with MIME messages, you can use the View drop-down list to view the entire raw message response, message metadata, or individual sections of the response.
When you are working with message types other than MIME, you can view the raw message response only.
This section features a toolbar with the following buttons:
|
Click the View Header Information button to display only the contents within the header tags of the selected message. |
|
Click the Save Output button to save the contents of the Output Information area, using a filename and location that you specify. |
|
Click the If Valid XML, Format button to format the code displayed in the section to make the contents more readable. This button is valid only if the file displayed is an XML file. |
|
Click the Clear Output button to delete the contents of the Output Information area. |
You can set these display preferences for Send Master:
Display font, size, and color.
Background color.
Word-wrapping options.
To set display preferences, use the Display tab of the Preferences dialog box. To access this box, select File, Preference and click the Display tab.
To set the display font, size and color:
Access the Preferences dialog box and click the Display tab.
Set the display font, size and color.
To set the display font, in the Fonts section, from the Font drop-down list, select a font style.
To set the font size, in the field next to the font style, enter a font size.
To set the text color, in the Text Color field, click the color block.
The Choose the Text Color box appears, from which you can select a color for the font.
Click OK to save the changes.
This section describes how to set the background color of Send Master work spaces and sections.
To set the background color:
Access the Preferences dialog box and click the Display tab.
In the Font section, in the Background Color field, click the color block.
The Choose the Text Background Color box appears, from which you can select a background color and click OK.
Click OK to save the changes.
You can enable or disable word wrapping in Send Master input and output sections.
To set word-wrapping options:
Access the Preferences dialog box and click the Display tab.
In the Word Wrap section, enable or disable word wrapping.
To enable word wrapping in input windows, select Input Text Windows.
To enable word wrapping in output windows, select the Output Text Windows.
Click OK to save the changes.
You can set up HTTP proxy and keystore options for use with Send Master. You set these options on the HTTP tab of the Preferences dialog box. To access the dialog box, select File, Preferences.
Specifying HTTP Proxy Settings
To specify HTTP proxy settings for Send Master:
Access the Preferences dialog box and click the HTTP tab.
In the Proxy section of the dialog box, specify the following information:
In the Host field enter the name of the proxy host.
In the Port field, enter the appropriate port number.
Click the OK button.
To specify keystore settings for Send Master:
Access the Preferences dialog box and click the HTTP tab.
In the Keystore section of the dialog box, specify the following information:
In the Certificate Alias field, enter the certificate alias.
In the Certificate Password field, enter the encrypted certificate password.
In the Keystore File field, click the folder icon to specify a keystore file.
In the Keystore Password field, enter the encrypted password for the keystore.
Click the OK button.
You use the Batch Processing tab to set output directory options related to the projects with which you work in the Batch work space.
Directory |
Specify the output directory for Batch project results. |
Create if not found |
Select this check box to create the directory specified in the Directory field if it does not exist. |
Overwrite files |
Select this check box to overwrite files of the same name in the output directory. |
Delete directory before each run |
Select this check box to delete the contents of the directory before you run each batch project. |
Delete directory on exit |
Select this check box to delete the contents of the directory each time that you exit the Batch work space. |
To test service operation and connector processing using Send Master, you use Send Master projects. A Send Master project is a collection of service operation components, values and parameters that defines what you want to test and how you want to test it.
This table describes Send Master project types.
The Input File project type enables you to test servers that are expecting XML data over HTTP(S). |
|
The Integration Broker (MIME) project type enables you to test servers that are expecting MIME data over HTTP or HTTPS. Use this project type to test service operation and connector processing using the PeopleSoft listening connector and for integrations with systems that expect MIME data. This project type is referred to as the Integration Broker (MIME) project type throughout this chapter. |
|
The Integration Broker (XML) project type enables you to test servers that expect XML data in PeopleSoft format over HTTP or HTTPS. Use this project type to test service operation and connector processing using the HTTP listening connector and for integrations with systems that expect IBRequest XML— formatted data. This project type is referred to as the Integration Broker (XML) project type throughout this chapter. |
|
The EIP Testing (Batch EIP) project type enables you to test batches of service operations from a file directory that you specify for automation testing, and enables you to test different transaction values. This project type is referred to as the EIP Testing project type throughout this chapter. |
|
The JMS Project project type enables you to test and post synchronous and asynchronous service operations to JMS queues or topics. This project type is referred to as the JMS project type throughout this chapter. |
The following table describes the type of project to use based on the type of communication that you want to test.
Project Type |
Usage |
Use this project type to:
|
|
Use this project type to:
|
|
Use this project type to:
|
|
You can use this project type to send a directory of MIME-formatted messages into PeopleSoft Integration Broker. This project type enables you to override requesting and destination nodes without having to alter every service operation. |
|
Use this project type to POST service operations to a JMS queue. This project type does not use the HTTP protocol, so no URL is provided. |
To create a Send Master project:
Launch Send Master.
Select File, New Project.
In the Project Name field, enter a name for the project.
From the Project Type drop-down list, select one of the following options:
Input File
Integration Broker (MIME)
Integration Broker (XML)
EIP Testing (Batch EIP)
JMS Project
Click the OK button.
The system populates the Input Information section with various tabs, based on the project type that you selected.
In the Server URL field, enter the server URL of the server with which to communicate.
Note. This field is not used for JMS projects.
In the Time Out field, enter a timeout value.
The timeout value determines the amount of time Send Master attempts to process a service operation. If the request does not complete in the time specified, processing stops. Usual timeout is about 60 seconds. The default is 0 (zero), meaning there is no timeout.
In the Headers box, enter pertinent HTTP header information for the service operation.
Select File, Save Project.
The project name appears in the Project field and the type of the project appears in parentheses next to the project name. The content of the work space varies, based on the project type selected.
See Also
Using Integration Broker Projects
Send Master enables you to specify HTTP, IBInfo, and connector headers. These headers are used in association with the following project types:
Input File
Integration Broker (MIME)
Integration Broker (XML
JMS Project
Use the information in the following table as a guide for entering header information in Send Master.
Header Type |
Project Type |
Location |
Description |
Note. An HTTP header field is present when working with EIP Testing projects; however it is usually not used because you are using the PeopleSoft listening connector. |
Project Definition section, Headers box. |
Provides HTTP protocol header information about the service operation at the server level and relates to how you are sending an entire service operation. You can specify cookies, content-type, encoding, sending program information, and so forth. |
|
Integration Broker (MIME) |
Input Information section, Connector tab. |
Provides required and optional headers that connectors need to pass information and process service operation requests. You can specify information such as service operation compression, encoding, and so forth. You can specify connector header information only while editing connector information in an Integration Broker (MIME) project type. |
|
|
Input Information section, Header Information, and Additional Header Cont. tabs. |
Contains information that is required to route service operations through PeopleSoft Integration Broker, including service operation name, operation type, requesting node, and so on. |
The information in this section applies to all project types except for the EIP Testing project type.
When working with EIP Testing projects, you specify file input and file output directories.
See Specifying File Input and File Output Directories.
To add an input file to a project:
In the Input Information section, click the Input File tab (if necessary).
(Optional.) Select Base64 encode/compress to enable base64 encoding and compression.
This option is not available when working with JMS projects.
(Optional.) Select Non Repudiation to enable nonrepudiation.
This option is not available when working with JMS projects.
In the text box, compose the transaction content of the service operation in the area provided, or import a file.
To import a file, click the Open File button and select a file. The name of the imported file appears under the Input Information section.
Modify the service operation transaction content if necessary.
Click the Save button on the toolbar within the Input Information section.
Select File, Save Project.
After you create an input file, you can modify and format service operation content. Use the following tips when you work with input files. Note that all buttons referenced appear on the toolbar located within the Input Information section.
Use the Refresh button to revert to the last saved version of the input file.
If the service operation content is XML, use the Format button to indent lines of code.
Use the Delete button to delete the contents of the section.
This section describes using Input File projects and describes how to:
Create Input File project types.
Add header information to input file projects.
Create and add input files to input file projects.
Post the input file projects to a web server.
See Also
Understanding Send Master Project Types
The first step to using an input file project is creating the Input File project type. Information about how to complete this task is provided earlier in this chapter.
See Creating Send Master Projects.
Input header information for input files can be added as a query string in the URL or entered in the Header area.
To insert header information in the Header area, double-click a field.
This table lists the header properties:
Header Label |
Description |
From: |
Required. Identifies the node sending the service operation. |
To: |
Optional. Identifies the receiving node. If this header is not entered, it defaults to the default application server specified on the gateway. |
OperationName: |
Required. Identifies the external service operation, including version. This must match the external operation in the routing definition. |
OperationType: |
Required. Identifies the operation type sync, async, or ping. |
OrigTimeStamp: |
Optional. Identifies a timestamp for this service operation. |
SOAPAction: |
Optional. Identifies a SOAP action for this service operation. |
NonRepudiation |
Optional. Identifies if nonrepudiation is enabled (True or False). |
content-type: |
Identifies the content type for the service operation. |
Information about creating and adding an input file to a project is provided earlier in this chapter.
See Adding Input Files to Projects.
After you create the Input File project type, add the input file to the project, and then click the Post button to post the file to the server.
Any server response to the service operation that you post appears in the Output Information section.
This section provides an overview of Integration Broker project types, and describes how to:
Create Integration Broker project types (MIME and XML).
Add header information to the project.
Add an input file to the project.
Specify connector information for the project.
Specify attachments for the project.
Post the project data to a web server.
You can create two types of Integration Broker projects—an Integration Broker MIME project or an Integration Broker XML project.
When you create Integration Broker MIME projects, you use the Input Information section of the work space to supply Send Master with information to build the IBInfo section of the service operation. In addition, you also use the section to specify connector information, add cookie information, specify destination nodes, and so on. PeopleSoft Integration Broker uses the information to build the MIME structure in service operations that are required to communicate with the PeopleSoft listening connector.
For Integration Broker XML projects, Integration Broker uses the information to build the IBRequest.
See Also
Understanding Send Master Project Types
This section discusses the options you can define when working with Integration Broker MIME and Integration Broker XML project types.
Use the Header Information tab to create service operation headers. This table describes the controls on the tab:
Requesting Node |
Identifies the name of the node that is making the request. |
Ext Operation Name |
Identifies the service operation and version. This matches the External Operation on the routing definition parameters page. |
Identifies the operation type. Values are:
|
|
App Serv Domain |
(Optional.) Identifies the application server and domain that will receive the service operation. |
(Optional.) Identifies the password as entered in the node definition, if password authentication is used. |
|
Originating Node |
(Optional.) Identifies the name of the node that started the process. |
Originating Process |
(Optional.) Identifies the name of the process where the publish event originated. For example, a service operation published from the Inventory definitions page would have a process name of INVENTORY DEFIN. |
Originating User |
(Optional.) Identifies the user ID login from where the service operation was initially generated. |
Queue |
(Optional.) Identifies the name of the queue expecting the service operation. |
Sub Queue |
(Optional.) Identifies subprocesses for the queue. |
Visited Nodes (Integration Broker MIME project type only) |
(Optional.) Identifies nodes through which the service operation has passed. Separate the values by semicolons. Visited nodes enable you to mimic visited node information populated when sending PeopleSoft service operations through PeopleSoft Integration Broker. |
Destination Node |
(Optional.) Identifies destination node for the service operation. |
Final Destination Node |
(Optional.) Identifies the final destination node. Use this option when working with a hub configuration. |
Transaction ID |
(Optional.) Identifies a transaction ID for this service operation. |
(Optional.) A unique ID to eliminate duplicate service operations from being delivered to PeopleSoft Integration Broker. The maximum length is 70 characters. |
|
Conversation ID |
(Optional.) Identifies a conversation ID for this service operation. |
You can work with the following controls on this tab.
Note. This tab appears only when you are working with Integration Broker MIME projects.
(Optional.) Identifies cookies that the server might require. Use semicolons to separate multiple cookies. |
|
Select this check box to gather statistics about system performance when posting service operations using Send Master. |
Use this tab to add input files. You can also use this tab to apply nonrepudiation, and base64 encoding and compression. This section describes the controls featured on this tab. Controls that appear on this tab that are not described in this section are documented earlier in this chapter.
See Navigating in Send Master.
This table describes the controls on the Input File tab:
(Optional.) Select this check box to apply base64 encoding and compression to the service operation. |
|
(Optional.) Select this check box to apply nonrepudiation to the service operation. |
This tab appears only when you are working with the Integration Broker MIME project type.
The Connector tab enables you to perform connector introspection on the integration gateway so you can select from all target connectors loaded on the integration gateway. No fields or controls are active on this tab until you enter connector data and select a target connector.
After you select a target connector, you can select specific target connector properties to use and define those property values. In addition, you can specify and define headers and fields that a selected connector needs to be able to pass information and invoke service operation requests.
Note. Header properties with which you work on this tab correspond to properties with the property IDHeaders in PeopleSoft Pure Internet Architecture. Field properties with which you work on this tab correspond to any property ID other than Header in PeopleSoft Pure Internet Architecture.
This table describes the controls on the Connector tab:
|
Click the Load Introspection Data button to load all target connectors that are currently installed on the integration gateway. |
|
Click the Refresh button to apply and make available in Send Master any changes that you make to target connector properties on the integration gateway. |
Connector |
Select a connector from the drop-down list. The default is <None>. You must first click the Load Introspection Data button for any connectors to appear in the list. |
Remote URL |
Enter a URL to redirect service operations to a different URL that is specified in the Server URL field in the Project Definitions section. |
Headers Box |
This area displays the headers, and the current values assigned to them, that you have selected for the target connector. |
Fields Box |
This area displays the fields, and the current values assigned to them, that you have selected for the target connector. |
Value |
Enter the value for the selected header or field. |
|
Click the Update Selected Header/Field Value in List button to apply the value in the Value field to the selected field or header in the Headers box or the Fields box. |
|
Click the Delete button to delete the header or field that is selected in the Headers box or the Fields box. |
Value |
Default header and field values appear in this field. Enter the desired value for the selected header or field in the Headers box or the Fields box. |
|
Click the Add Selected Header/Field and Value button to add the header in the Header field and its default value to the Headers box, or to add the field in the Field field and its default value to the Fields box. |
|
Click the Add All Required Headers/Fields and Their Default Values button to add all of the required headers or fields for the selected target connector and their default values to the Headers box or the Fields box. |
Header |
Use the Header drop-down list to select a value from all defined headers for the selected target connector. When you select a header from the list, its default value, if one exists, appears in the Value field. The Header drop-down list appears only when you work with the Headers subtab. |
Field |
Use the Field drop-down list to select a value from all defined fields for the selected target connector. When you select a field from the list, its default value, if one exists, appears in the Value field. The Field drop-down list appears only when you work with the Fields subtab. |
Value |
The Value field displays the default value, if one exists, for any selected header or field. Use the drop-down list to view and select header and field values. After you select a value in the list, click the Add Header button or the Add Field button to change the value in the value text box, or reenter the value that you want to apply in the box. |
Attachment Sec tab
Use this tab to test attachments. This table describes the controls on the Attachment Sec tab:
Content ID |
Identifies the content ID for the attachment. |
Content Url |
Identifies the content URL for the attachment. |
Content Encoding |
Identifies the encoding used in the attachment. |
Content Base |
Identifies the base property for the attachment. |
Content Location |
Identifies the content location for the attachment. |
Content Disposition |
Identifies the disposition of the attachment. |
Content Language |
Identifies the language for the attachment. |
Content Disposition |
Identifies the disposition of the attachment. |
The first step to using an Integration Broker project is creating the Integration Broker project type. Information about how to complete this task is provided earlier in this chapter.
See Creating Send Master Projects.
To add PeopleSoft header information to the project:
In the Input Information section, select the Header Information tab, if it is not already selected:
Complete the following required fields:
Requesting Node
External Operation Name
Operation Type
Enter values in any of the remaining optional fields as appropriate for your project.
(Optional.) Click the Headers Cont. tab to add cookie information or to gather messaging statistics.
See Also
Entering Header Information in Send Master Projects
Information about creating and adding an input file to a project is provided earlier in this chapter.
See Adding Input Files to Projects.
This section discusses how to specify connector information for Integration Broker MIME projects.
To specify connector information for a project, use the Connector tab in the Input Information section of the Project work space. No fields or controls are active on the tab until you introspect target connector data and select a target connector with which to work.
As noted earlier in this section, header properties with which you work on the Connector tab correspond to properties with the property IDHeaders in the PeopleSoft Pure Internet Architecture. Field properties with which you work on this tab correspond to any property ID other than Header in the PeopleSoft Pure Internet Architecture.
To select a target connector:
From an open Integration Broker MIME project, in the Input Information section, click the Connector tab.
Click the Load Introspection Data button.
From the Connector drop-down list, select a connector.
(Optional.) In the Remote URL field, enter a URL to redirect the service operation to a different URL than that specified in the Server URL field in the Project Definitions section.
Adding Connector Header Properties
To add connector headers properties:
Click the Headers subtab under the Remote URL field.
To add all required header properties for the selected connector, click the Add All Required Headers and Their Default Values button.
All required header properties and their default values, if they exist, appear in the Headers box.
To add more header properties:
In the Connector Header section, from the Header drop-down list, select a header property and click the Add Selected Header and Default Value button.
When you select a header property from the list, its default value, if any, appears in the Value field. Click the Value drop-down list to view all possible values for the property.
Click the Add Selected Header and Default Value button to add the property.
The header property and its default value, if any, appear in the Headers box.
To change the value of a header property:
In the Headers box, select the header property whose value you want to change.
In the Value field, enter the new value to assign.
Use the Value drop-down list in the Connector Headers section to view possible values and verify the format to enter.
Click the Update Selected Value in List button to apply the new value.
To delete a header property, in the Headers box, select the property to delete and click the Delete button.
Save the project.
Adding Connector Field Properties
To add connector field properties:
Click the Fields subtab under the Remote URL field.
To add all required field properties for the connector, click the Add All Required Fields and Their Default Values button.
All required field properties and their default values, if they exist, appear in the Fields box.
To add more field properties:
In the Connector Fields section, from the Field drop-down list, select a field property, and click the Add Selected Fields and Default Value button.
When you select a property from the drop-down list, its default value, if any, appears in the Value field. Click the Value drop-down list to view all possible values for the property.
Click the Add Selected Field and Default Value button to add the property.
The field property and its default value, if one exists, appears in the Fields box.
To change the value of a field property:
In the Fields box, select the field property whose value you want to change.
In the Value field, enter the new value.
Use the Value drop-down list in the Connector Fields section to view possible values and verify the format to enter.
Click the Update Selected Value in List button to apply the new value.
To delete a field property, in the Fields box, select the property to delete and click the Delete button.
Save the project.
To post Integration Broker MIME or Integration Broker XML projects to web servers, click the Post button.
When you POST a service operation using the Integration Broker project type, the system generates a MIME response message. If you POST data to a PeopleSoft listening connector, the MIME response message appears in the Output Information section of the Project work space.
This section describes how to:
Create EIP Testing projects.
Specify file input and output directories.
Override requesting and destination nodes.
Start batch processing.
Use the Batch Project Executor Command Line Tool
The first step to using an EIP Testing project is creating the EIP Testing (Batch EIP) project type. To create a project, select File, New Project. Information about creating projects is provided earlier in this chapter.
See Creating Send Master Projects.
To add input files to this project type, you specify the directory location where the files reside.
To specify input files for EIP Testing projects:
In the Input Information section, in the Input Directory field, select the location of the input files.
In the Output Directory field, select the location where the output files should be written.
(Optional.) Select Create If Not Found to create the input and output directories, if they do not exist.
(Optional.) Select Overwrite File to direct Send Master to overwrite any output files that exist with the same names.
Select File, Save Project.
See Also
Integration Point Data Repository
Send Master reads the request and destination node information from the input files. However, you can override the node information:
To override the requesting and destination node information specified in the input files:
Open an EIP Testing project.
In the Input Information section, in the Optional Overrides section, enter a new requesting node name in the Requesting Node field.
To override the destination node , in the Optional Overrides section, enter a new destination node name in the Destination Node field.
Select File, Save Project.
To post the files in an EIP Testing project, open the project and click the Post button.
To view the output from EIP Testing projects, navigate to the output directory that you specified on the Headers tab in the Input Information section. You can also view output in Send Master in the Output Information section of the Project work space.
The Batch Project Executor enables you to use the functionality of the EIP Testing project type from a command line tool. This section discusses the Batch Project Executor tool, including its:
Usage
Syntax
Parameters
Usage
The standard usage of the Batch Project Executor command line tool is:
BatchProjectExecutor [-options]
Syntax
The syntax for executing a batch project is:
BatchProjectExecutor -in "C:\temp\input" -out "C:\temp\output" -url "http://localhost/PSIGW /PeopleSoftListeningConnector" -result "C:\temp \output\result.txt"
Parameters
The following table describes the parameters you can pass to the Batch Project Executor.
Parameter |
Description |
-in |
Certification directory that contains the raw request files. |
-out |
Output directory to store all of the response files. |
-url |
Server URL to send all of the requests to during processing. |
-result |
Name of the file that will contain the results during batch execution. The contents of this file will be represented as XML. |
-ow |
(Optional.) Overwrite files if they already exist. |
-cd |
(Optional.) Create the output directory if not found. |
-rn |
(Optional.) Override the requesting node found in the IBInfo section. |
-dn |
(Optional.) Override the destination node found in the IBInfo section. |
-? -help |
(Optional.) Show the Help menu. |
Sample Output
The following example shows successful output:
<?xml version="1.0"?> <success> <request elapse="1.953 (s)" end="02:33:55.177" filename= "20030519T130405.request" id="" start="02:33:53.224" success="true"/><request elapse="0.201 (s)" end="02:33:55.408" filename="20030519T150417.request" id="" start="02:33:55.207" success="true"/> <request elapse="0.220 (s)" end="02:33:55.638" filename="20030520T150406. request" id="" start="02:33:55.418" success="true"/> <request elapse="0.190 (s)" end="02:33:55.828" filename= "20030519T150406.request" id="" start="02:33:55.638" success="false"> <![CDATA[Error communicating with server: Connection refused: connect]]> </request> </success>
The following example shows a failure:
<?xml version="1.0"?> <failure> <![CDATA[Error while initializing: Invalid output directory: C:\temp\output]]>
This section discusses how to:
Create JMS projects.
Add header information to JMS projects.
Add input files to JMS projects.
Post JMS projects to queues.
You can use Send Master to create JMS project types and test posting synchronous and asynchronous service operations to JMS queues.
Before you attempt to post service operations to an JMS queue, verify that the following Java Archive (JAR) files are installed, and that you have added them to the CLASSPATH in the StartSendMaster.bat file or the StartSendMaster.sh file. These files are installed as part of the MQSeries installation.
com.ibm.mq.iiop.jar
com.ibm.mq.jar
com.ibm.mqbind.jar
com.ibm.mqjms.jar
fscontext.jar
jms.jar
jndi.jar
providerutil.jar
See the IBM MQSeries documentation.
Corresponding files for other JMS Servers will be installed by respective JMS Server installations.
This section discusses the options you can define when working with a JMS project type.
Use the Headers tab to specify header information for JMS service operations. The following table describes elements on this tab:
Indicates the name of the JMS provider. Valid options are:
|
|
JMS Queue |
Indicates the queue to which the service operations will post. |
JMS Factory |
Indicates the factory to which the queue in the JMS Queue field belongs. |
JMS URL |
Indicates the LDAP directory or local file system address. |
JMS User |
(Optional.) Indicates the name of the JMS user. |
(Optional.) Indicates the name of the JMS user's password. |
|
Requesting Node |
Indicates the name of the requesting node. |
Operation Name |
Indicates the name of the service operation. |
Operation Type |
Indicates the service operation type. Valid service operation types are:
|
Node Password |
(Optional.) Indicates the requesting node password if applicable. |
Destination Nodes |
Indicates the name of the destination node. Use a semicolon to separate multiple destination nodes. |
Final Destination Node |
Indicates the name of the final destination node. |
Queue |
Select this radio button to post to a queue. |
Topic |
Select this radio button to post to a topic. |
The first step to using a JMS project is creating the JMS project type. To create a project, from the Send Master menu, select File, New Project. Information about how to complete this task is provided earlier in this chapter.
See Creating Send Master Projects.
To add header information to the project:
In the Input Information section, select the Header Information tab if it is not already selected:
Select or enter values for the following required fields:
JMS Provider
JMS Queue
JMS Factory
JMS URL
Requesting Node
Operation Name
Operation Type
Enter values in any of the remaining optional fields as appropriate for your project.
Select File, Save Project.
Information about creating and adding an input file to a project is provided earlier in this chapter.
See Adding Input Files to Projects.
To post a JMS project to a queue, click the Post button.
If you are working with a synchronous service operation, the Output Information area displays response information from the target system. If you are working with an asynchronous service operation, no response information is received.
This section describes how to:
Create groups of projects.
Manage groups of projects.
Test groups of projects.
View test output.
Share projects and groups.
To create a group of projects:
Launch Send Master and select File, Batch Processing.
Select File, New Group.
Enter a name for the new group.
Define the project group:
From the Run In drop-down list, select one of the following options to determine how the projects in the group run.
Parallel |
Run all projects in the group at the same time. |
Succession |
Run projects in the group in succession. |
Time Lapse |
Run projects in the group in the interval that you specify in the Delay field. |
(Optional.) In the Override URL field, enter a URL to override the one specified in the Server URL field in the Project work space.
Add projects to the group.
In the Group Projects section, from the Projects drop-down list, select a project.
Click the Add a new project button to add the project to the group.
From the Method drop-down list, select an HTTP method.
In the Amount field, enter the number of instances of the project to include in the group.
From the Run In drop-down list, select one of the following options to specify how the projects run among themselves.
Parallel |
Run all instances of the project at the same time. The limited availability of open ports and other system resources requires you to determine the optimal number of projects to run at a single time. Start with 10 projects and slowly add projects to determine how many concurrent requests the system can process. |
Succession |
Run instances of the project in succession. |
Time Lapse |
Run instances of the project in the interval that you specify in the Delay field. |
Repeat steps a through to add additional projects to the group.
Select File, Save Group.
You might occasionally need to revise projects that you have added to a group. The following information will help you manage groups of projects:
To change the order of a project in a group, in the Group Projects section, use the arrow buttons to move the project.
To temporarily inactivate a project in a group, in the Project Settings section, select Inactive.
To remove a project from a group, in the Group Projects section, select its file and click the Delete button.
After you have created a group of projects, you can test them.
To test a groups of projects:
Open Send Master and select File, Batch Processing.
In the Group Definitions section, from the Group drop-down list, select the group to test.
The projects in the group appear in the Group Projects section.
Make any needed adjustments to the group, such as changing the order of projects in the group, specifying inactive or active projects, and so forth.
Click the Start Projects button to run the test of projects in the group.
After you run a test on a group of projects, you can view processing information and response information for any project in the group.
Viewing Processing Information
After you run a group of projects, the Completed Projects Output section displays all of the projects in the group and the instances for each project in a hierarchical tree format. To expand and collapse a project folder, click the icon to the left of the folder.
When you expand a project folder, the instances for the project appear as shown in the following graphic.
Each page icon represents a project instance. The number in parentheses represents the time needed to process the project instance.
To view detailed processing information about the entire group of projects, select a project, click the Export the Results to File button, and save the contents as a text file. You can then open the text file and view information, such as the total number of project instances in the group, the total time to process all project instances, processing start and end times, and so on. The following example shows the type of output you can view using the Export feature.
Count : 5 Round-trip times Total : 0.961 (s) Minimum : 0.180 (s) [2] Maximum : 0.200 (s) [3] Average : 0.192 (s) Process per second : 5.203 [1] Request : 0.191 (s) [start = 10:19:20.095, end = 10:19:20.286] Response : 200 - OK [2] Request : 0.180 (s) [start = 10:19:20.296, end = 10:19:20.476] Response : 200 - OK [3] Request : 0.200 (s) [start = 10:19:20.486, end = 10:19:20.686] Response : 200 - OK [4] Request : 0.190 (s) [start = 10:19:20.696, end = 10:19:20.886] Response : 200 - OK [5] Request : 0.200 (s) [start = 10:19:21.017, end = 10:19:21.217] Response : 200 - OK
Viewing Response Information for a Project Instance
Send Master enables you to view response information for any project instance in a group of projects.
To view response information for a project instance:
Select a project instance in the Completed Projects Output section.
Click a project instance.
Response information appears in the Output Information section.
When you create projects and groups, the system stores all data in the Send Master properties file. The location of this file depends on the web server.
For Oracle WebLogic the location is <PIA_HOME>\webserv\<DOMAIN>\applications\peoplesoft\PSIGW.war\WEB-INF\classes\com\peoplesoft\pt\sendmaster\sendmasterproperties.xml.
For IBM WebSphere the location is <PIA_HOME>\websev\<DOMAIN>\<BIN>
This file is not created until you use Send Master.
You can share and reuse projects and groups that you or others have created for other versions of Send Master or that have been used on other workstations. You do so by copying the sendmasterproperties.xml file into the Send Master directory. You must rename or delete the existing properties file before you copy the new file into the directory.
After you copy the sendmasterproperties.xml file into the Send Master directory, you can access the project and groups in the normal manner, by accessing them from the Project drop-down list in the Project work space, or from the Group drop-down list in the Batch Processing work space.
To ping a remote node from the Send Master, you post an example service operation to the node’s application server using an Integration Broker (MIME) or Integration Broker (XML) project that specifies a ping service operation type. You then use the Post button to post the service operation to the application server.
The following table describes the type of response returned based on project type.
Project Type |
Response |
Integration Broker (MIME) |
The system returns a MIME response message in the Output Information section of the Project work space. If you post data to a PeopleSoft listening connector, the MIME response appears in the Output Information section of the Project work space. A message with the content <StatusCode>0</StatusCode> indicates that the ping was successful. |
Integration Broker (XML) |
The system returns an HTTP response of 404 with data in the response in the Output Information section of the Project work space. |
You can also use Service Operations Monitor and the Simple Post utility to ping remote nodes.
See Also
Pausing, Testing, and Pinging Nodes
When working with Integration Broker MIME projects, you can gather processing performance statistics.
To enable the Send Master processing performance feature, select Gather Statistics on the Headers Cont. tab.
When the Gather Statistics feature is enabled, Send Master returns processing statistics in the Output Information section after a Post.
To access statistics information , from the View drop-down list, select Meta Data and then click the If Valid XML, Format button.
The data is contained in the following tag:
<IBProfileInformation>
Send Master returns statistics relating to processing on the application server and gateway, as well as response processing.
Note. All values returned are expressed in milliseconds.
This table describes the statistics that Send Master returns related to processing on the application server.
Statistic |
Description |
TransformInbound |
Time to process any inbound transformations. |
OnRoutePeopleCode |
Time to execute OnRoute PeopleCode. |
OnRequestPeopleCode |
Time to execute OnRequest PeopleCode. |
TransformOutbound |
Time to process any outbound transformations. |
DataBase |
Time for processing on the database. |
AppServerSendTime |
Time to send the request to the application server. This value is not applicable in Send Master, because Send Master (not the application) is sending the request. |
AppServerRecvTime |
Processing time on the application server. |
This table describes the statistics that Send Master returns related to processing on the integration gateway.
Statistics |
Description |
Connector |
Time that processing took place on the connector. |
Transform |
Time to perform gateway transformations. |
GatewayTime |
Processing time on the integration gateway. |
This table describes the statistics that Send Master returns related to processing the response service operation.
Statistics |
Description |
Transform |
Time to perform transformation on the response. |
GatewayTime |
Total time for processing the response on the integration gateway. |
The following example shows a sample of statistics that Send Master returns.
<?xml version="1.0"?> <IBInfo> <TransactionID> <![CDATA[QE_UNDERDOG.QE_SALES_ORDER_SYNC_CHNL.af21859e-f5e7-11d7- b7f0-88b716eecd9a]]> </TransactionID> <Status> <StatusCode>0</StatusCode> <MsgSet>158</MsgSet> <MsgID>10000</MsgID> </Status> <ContentSections> <ContentSection> <ID>ContentSection0</ID> <NonRepudiation>N</NonRepudiation> <Headers> <version> <![CDATA[VERSION_1]]> </version> </Headers> </ContentSection> </ContentSections> <IBProfileInformation> <keyword><AppServer></keyword> <keyword><TransformInbound>0</TransformInbound></keyword> <keyword><OnRoutePeopleCode>0</OnRoutePeopleCode></keyword> <keyword><OnRequestPeopleCode>0</OnRequestPeopleCode></keyword> <keyword><TransformOutbound>0</TransformOutbound></keyword> <keyword><DataBase>0</DataBase></keyword> <keyword><AppServerSendTime>0</AppServerSendTime></keyword> <keyword><AppServerRecvTime>0</AppServerRecvTime></keyword> <keyword></AppServer></keyword> <keyword><GatewayRequest></keyword> <keyword><Connector>24844</Connector></keyword> <keyword><Transform>0</Transform></keyword> <keyword><GatewayTime>651</GatewayTime></keyword> <keyword></GatewayRequest></keyword> <keyword><GatewayResponse></keyword> <keyword><Transform>0</Transform></keyword> <keyword><GatewayTime>211</GatewayTime></keyword> <keyword></GatewayResponse></keyword> <keyword></IBProfileInformation></keyword> </IBInfo>
This section describes how to export request service operations. When working with Integration Broker MIME or Integration Broker XML project types, you can use Send Master to export a request service operation to a text file to examine the raw data that gets sent during a transaction.
To export a request service operation:
Open an Integration Broker MIME project or an Integration Broker XML project.
Select File, Export IBRequest .
A Save dialog box appears.
Enter the location to save the file.
You can also view the raw data for a service operation in the integration gateway message log.
When posting files that are 5 megabytes (MB) or larger to the integration gateway, you should allocate additional random access memory (RAM) in Send Master to accommodate larger file sizes.
If Send Master does not have enough memory for a task, an “out of memory” error can occur.
To allocate additional RAM in Send Master:
Close Send Master.
Open StartSendMaster.bat (in Windows) or StartSendMaster.sh (in UNIX).
Add the –XmxZZm parameter, where ZZ equals the amount of RAM, in megabytes, to allocate.
Save the file.
Reopen Send Master.
For example, the value – Xmx128m indicates to allocate 128 MB of RAM. The following example shows how to add the parameter in the StartSendMaster.bat file:
cd "applications\peoplesoft\PSIGW.war\WEB-INF\classes\com\peoplesoft\pt\ sendmaster\"java -Xmx128m -classpath "c:\ptdvl\ webserv\peoplesoft\applications\peoplesoft\PSIGW.war\WEB-INF\lib\xalan.jar;c:\ ptdvl\webserv\peoplesoft\applications\peoplesoft\PSIGW.war\WEB-INF\lib\ xerces.jar;c:\ptdvl\webserv\peoplesoft\applications\peoplesoft\PSIGW.war\ WEB-INF\classes;c:\ptdvl\webserv\peoplesoft\applications\peoplesoft\PSIGW.war\ WEB-INF\lib\mail.jar;c:\ptdvl\webserv\peoplesoft\applications\peoplesoft\ PSIGW.war\WEB-INF\lib\activation.jar;c:\ptdvl\webserv\peoplesoft\applications\ peoplesoft\PSIGW.war\WEB-INF\lib\jmq.jar;c:\ptdvl\webserv\peoplesoft\applications\ peoplesoft\PSIGW.war\WEB-INF\lib\jms.jar;c:\ptdvl\webserv\peoplesoft\applications\ peoplesoft\PSIGW.war\WEB-INF\lib\jndi.jar" com.peoplesoft.pt.sendmaster.SendMaster
You can increase the amount of memory in Send Master to any value you that you want, as long as your machine has the RAM to support the value that you choose.