Connect for Siebel User's Guide

CHAPTER 3

Creating Siebel Components and Services

To create a Component or Service that utilizes the exteNd ComposerTM Connect for Siebel, you need to do three things:

Each of these processes is discussed in detail in this chapter.

 
Top of page

Creating Connection Resources

Before creating a component that interacts with a Siebel system, you need to create a Connection Resource, which is a lightweight Composer object (xObject) that encapsulates basic connection information (parameter values) associated with a connection to a back-end system.

In addition to a connection resource, a Siebel Component requires that you have already created XML templates so that you have sample input and output documents for use in designing your component. For more information, see "Creating an XML Template" in the Novell exteNd Composer User's Guide.

If your component design calls for any other resources (e.g., custom scripts, XSL, XSD, XDR) you should create these before creating the Siebel Component or Service. For more information, see "Creating Custom Scripts" in the Novell exteNd Composer User's Guide.

 
Top of section

Types of Connection Resources

You create different types of connection resource depending on the type of interaction with the Siebel system that is desired. If your application needs to initiate Siebel business events using Siebel Business Objects and Business Services, you need to create a Siebel Connection resource. If your application needs to process data when a business event occurs within a Siebel Integration Object, you need to create an inbound connection resource. Inbound connection resources include file, HTTP, and MQ Series connection types.

 
Top of section

About Constant-Driven and Expression-Driven Connection Parameters

You can specify Connection parameter values in one of two ways: as Constants or as Expressions. A constant-driven parameter uses the value you type in the Connection dialog every time the Connection is used. An expression-driven parameter allows you to set the value using a programmatic expression, which can result in a different value each time the connection is used at runtime. This allows the Connection's behavior to be flexible and vary based on runtime conditions each time it is used.

For instance, one very simple use of an expression-driven parameter in a Connection would be to define the User ID and Password as PROJECT Variables (e.g. PROJECT.XPATH("USERCONFIG/MyDeployUser"). This way when you deploy the project, you can update the PROJECT Variables in the Deployment Wizard to values appropriate for the final deployment environment. At the other extreme, you could have a custom script that queries a Java business object in the Application Server to determine what User ID and Password to use.

Procedure To switch a parameter from Constant-driven to Expression driven:

  1. Click the right mouse button in the parameter field you are interested in changing.

  2. Select Expression from the context menu and the editor button will appear or become enabled.

    Ch2Constants

  3. Click on the button and then create an expression that evaluates to a valid parameter value at runtime. (Strings should be wrapped in double-quotes.)

 
Top of section

Creating a Siebel Connection Resource

Procedure To Create a Siebel Connection Resource:

  1. Select File > New > xObject. The New xObject dialog box is displayed.

  2. Select the Resource tab.

  3. Double-click on Connection. The "Create a New Connection Resource" wizard is displayed.

  4. Type a name for the connection object in the Name field.

  5. Optionally, type a description of the connection object in the Description field.

  6. Select Next. A connection parameters panel is displayed.

    CreateNewConnectionRes

  7. Select Siebel Connection from the Connection Type list.

  8. Type the host name or IP address of the Siebel gateway server in the Gateway Server field. The Siebel Gateway Server is a single entry point for accessing Siebel servers. It consists of the Name Server and an optional Connection Brokering component.The Name Server keeps track of all Siebel Server parameters. Enterprise components query the Name Server for connectivity information.

  9. Type the Enterprise Server name in the Enterprise Name field.

  10. Type the Siebel Server name in the Siebel Server field.

  11. Type a User ID for the selected Siebel server in the User field.

  12. In the Password field, type the password for the user that you specified in previous step.

  13. Select the three-letter NLS character set code for the default language from the Language list. The default is "enu" (US English).

  14. Type the name of the Siebel Object Manager in the Object Manager field.

    NOTE:   In some Siebel configurations, it may be necessary to append the three-letter NLS character set code (e.g., "_enu" for English) to the Object Manager name (e.g., "MyObjectManager_enu"). This code should be the same as the code selected in the Language list.

  15. Type the name of the Siebel Repository in the Repository Name field.

  16. Type the desired maximum pool size in the Maximum Pool Size field. This is a JCA setting that specifies the maximum number of connections to be allowed in the connection pool (not applicable for non-managed environments).

  17. If desired, select Test to see if your connection parameters and network environment allow you to create a live connection. Composer displays a message indicating the success or failure of the test. The test connection is discarded immediately after the test. You can continue working with the connection resource, even if the connection fails.

    NOTE:   This test does not test the connection pool.

  18. Select OK. The newly-created resource connection object appears in the Composer Connection Resource detail pane.

 
Top of section

Creating a File Service Connection Resource

Procedure To Create a Siebel File Service Connection Resource:

  1. Select File > New > xObject. The New xObject dialog box is displayed.

  2. Select the Resource tab.

  3. Double-click on Connection. The "Create a New Connection Resource" wizard is displayed.

  4. Type a name for the connection object in the Name field.

  5. Optionally, type a description of the connection object in the Description field.

  6. Select Next. A connection parameters panel is displayed.

    ConnectionRscrc File

  7. Select Siebel File Service Connection from the Connection Type list.

  8. Use the Browse button next to the Polling Location field to select the target file system location for the Siebel XML file.

  9. In the File Mask field, type the file name to be used for the output file generated as a result of this operation. The default is ".*".

  10. Select REQUEST, REQUEST_RESPONSE, or REQUEST_ACK from the Synchronization Type list. Select the option that is correct for the Workflow with which you are integrating (e.g., if your Workflow is set up to process a response, select REQUEST_RESPONSE). The Synchronization Type selected also determines the tabs that are displayed in the Service Request Native Environment pane (e.g., if REQUEST_RESPONSE is selected, both Request and Response tabs are displayed).

  11. Use the Browse button next to the Response/Ack Directory field to select the directory to which responses or acknowledgements from your application will be written.

  12. Use the Browse button next to the Error Directory field to select the directory to which error information will be written.

  13. In the Poll Interval field, type the interval (in milliseconds) in which the Polling Location is checked for input. The default is 3000 (3 seconds).

  14. Select Threaded or Sequential from the Processing Mode list. Threaded indicates processing of multiple requests simultaneously. Sequential indicates serial processing of requests.

  15. If Threaded processing mode is selected in the Processing Mode list, use the Thread Limit field to specify the maximum number of requests that can be processed simultaneously.

  16. From the Metadata Connection list, select a Siebel connection resource from the list of defined connection resources. This connection is used for acquiring metadata from the Siebel system.

  17. Type the desired maximum pool size in the Maximum Pool Size field. This is a JCA setting that specifies the maximum number of connections to be allowed in the connection pool (not applicable for non-managed environments).

 
Top of section

Creating an HTTP Service Connection Resource

Procedure To Create a Siebel HTTP Service Connection Resource:

  1. Select File > New > xObject. The New xObject dialog box is displayed.

  2. Select the Resource tab.

  3. Double-click on Connection. The "Create a New Connection Resource" wizard is displayed.

  4. Type a name for the connection object in the Name field.

  5. Optionally, type a description of the connection object in the Description field.

  6. Select Next. A connection parameters panel is displayed.

    ConnectionRscrc http

  7. Select Siebel HTTP Service Connection from the Connection Type list.

  8. In the Listener Port field, type the number of the port on which the application will listen for Siebel event data. The default port is 8080.

  9. To use HTTPS for this connection, select HTTPS.

  10. Select REQUEST, REQUEST_RESPONSE, or REQUEST_ACK from the Synchronization Type list. Select the option that is correct for the Workflow with which you are integrating (e.g., if your Workflow is set up to process a response, select REQUEST_RESPONSE). The Synchronization Type selected also determines the tabs that are displayed in the Service Request Native Environment pane (e.g., if REQUEST_RESPONSE is selected, both Request and Response tabs are displayed).

  11. From the Metadata Connection list, select an outbound Siebel Connection resource from the list of defined connection resources. This connection is used for acquiring metadata from the Siebel system.

  12. Type the desired maximum pool size in the Maximum Pool Size field. This is a JCA setting that specifies the maximum number of connections to be allowed in the connection pool (not applicable for non-managed environments).

 
Top of section

Creating an MQSeries Service Connection Resource

Procedure To Create a Siebel MQSeries Service Connection Resource:

  1. Select File > New > xObject. The New xObject dialog box is displayed.

  2. Select the Resource tab.

  3. Double-click on Connection. The "Create a New Connection Resource" wizard is displayed.

  4. Type a name for the connection object in the Name field.

  5. Optionally, type a description of the connection object in the Description field.

  6. Select Next. A connection parameters panel is displayed.

    ConnectionRscrc MQ

  7. Select Siebel MQSeries Service Connection from the Connection Type list.

  8. In the Queue Manager field, specify the name of the queue manager to which the application will connect.

  9. In the MQ Server Host field, type the name of the host on which the MQ Server is located.

  10. In the MQ Server Port field, type the name of the port to use to connect to an MQ Server queue manager.

  11. In the MQ Server Channel field, specify the name of the channel to use to connect to the remote MQ Server queue manager. The name is case-sensitive.

  12. Select the XML Document checkbox.

  13. In the Queue Name field, type the name of the queue in which the message will be routed and where request documents are received. The name of the queue is case-sensitive.

  14. Select REQUEST, REQUEST_RESPONSE, or REQUEST_ACK from the Synchronization Type list. Select the option that is correct for the Workflow with which you are integrating (e.g., if your Workflow is set up to process a response, select REQUEST_RESPONSE). The Synchronization Type selected also determines the tabs that are displayed in the Service Request Native Environment pane (e.g., if REQUEST_RESPONSE is selected, both Request and Response tabs are displayed).

  15. In the Message Wait Interval field, specify the interval (in milliseconds) in which the queue is checked for new input. The default is 3000 (3 seconds).

  16. Select Threaded or Sequential from the Processing Mode list. Threaded indicates processing of multiple requests simultaneously. Sequential indicates serial processing of requests.

  17. If Threaded processing mode is selected in the Processing Mode list, use the Thread Limit field to specify the maximum number of requests that can be processed simultaneously.

  18. From the Metadata Connection list, select an outbound Siebel Connection resource from the list of defined connection resources. This connection is used for acquiring metadata from the Siebel system.

  19. Type the desired maximum pool size in the Maximum Pool Size field. This is a JCA setting that specifies the maximum number of connections to be allowed in the connection pool (not applicable for non-managed environments).

 
Top of page

XML Templates for Siebel Components and Services

Before creating a Siebel Component or Service, you should create any XML templates that might be needed. XML templates are used to tell Composer which XML sample documents (e.g., input, output, scratch pad, fault, XSD, or DTD) to use. Once you've specified the XML templates, you can create a component or service that uses the sample documents to represent the inputs and outputs processed by your component. For more information about XML templates, see "Creating a New XML Template" in the Novell exteNd Composer User's Guide.

 
Top of page

Creating Siebel Components

As part of the process of creating a Siebel Component, you can select an existing Siebel connection resource, or you can create a new one. If you create the connection beforehand, it is available for use by any Siebel Components in the current project. If you have not already created at least one Siebel connection resource in the current project, you will be prompted to do so when you try to create a Siebel Component.

NOTE:   You can still create a Component without first creating a connection resource, but you won't be able to use any debug features that depend on a live connection.

Procedure To Create a New Siebel Component:

  1. Select File > New > xObject. The New xObject dialog box is displayed.

    NOTE:   Alternatively, under Component in the Composer Navigator pane (Explorer view), you can highlight Siebel, click the right mouse button, then select New.

  2. Select the Component tab.

  3. Double-click on "Siebel."

    If you have not previously defined a connection resource, you are prompted to do so now (see Creating Connection Resources).

    If you have already defined a connection resource, the "Create a New Siebel Component" Wizard is displayed.

    CreateNewComponent-1

  4. Type a Name for the new Siebel Component.

  5. Optionally, type Description text.

  6. Select Next. The XML Input/Output Message Property Info panel of the New Siebel Component Wizard is displayed.

    CreateNewComponent-2

  7. Specify the Input and Output templates as follows:

  8. Select an XML template for use as an Output DOM using the procedure described in the previous step.

    NOTE:   You can specify an input or output XML template that contains no structure by selecting {System}{ANY} as the Input or Output template. For more information, see "Creating an Output Document without Using a Template" in the Novell exteNd Composer User's Guide.

  9. Select Next. The Temp and Fault XML Template panel is displayed.

    CreateNewComponent-3

  10. If desired, specify a template to be used as a scratch pad under the "Temp Message" pane of the dialog box. This can be useful if you need a place to hold values that will be used temporarily during the execution of your component. Select a Template Category if it is different than the default category. Then select a Template Name from the list of XML templates in the selected Template Category.

  11. Under the "Fault Message" pane, select an XML template to be used to pass back to clients when an error condition occurs.

  12. To add additional input XML templates, click Add and choose a Template Category and Template Name for each. Repeat as many times as desired. To remove an input XML template, select an entry and click Delete.

  13. Select Next. The Connection Info panel of the Create a New Siebel Component wizard is displayed.

    CreateNewComponent-4

  14. Select a Siebel connection from the Connection list. The Connection list displays the names of the Siebel connection resources that have been defined in this project.

  15. Select Finish. The component is created and the Siebel Component Editor is displayed.

 
Top of section

About the Siebel Component Editor Window

The Siebel Component Editor includes all of the functionality of the XML Map Component Editor. It contains mapping panes for Input and Output XML documents, as well as an Action Model.

The Siebel Component Editor also includes a Native Environment pane, which appears as a grey pane until you create a Siebel Request action, at which time it will show a tabs for Request and Response panes with corresponding XML trees.

The Native Environment pane shown in the illustration is blank, because no Siebel Request action has been created.

 
Top of section

Creating Actions in the Component Editor

You can create all the normal Composer actions in the Action Model of your Siebel component (e.g., XML Map, Function, Log, Send Mail). In addition, you can create a Siebel Request action.

The Siebel Request action communicates requests (XML request documents) from your Siebel system and fetches responses back from the same system.

The Composer GUI for creating a Siebel Request action allows you to

You will see how this works in the following procedure.

Procedure To Create a Siebel Request Action

  1. Right-click in the Action Model at the location in which you want the new action to appear, then select New Action > Request.

    CreateAction1

    The Function pane of the Request dialog box is displayed. You use this pane to browse the available Siebel Business Objects and Business Services.

    CreateAction1a

  2. Click on the plus (+) sign to the left of a node in the tree view to expand the tree view for that node.

    NOTE:   If no nodes are displayed on the Function page, there may be an incorrect parameter in your connection resource. Check the parameters needed for connecting to your Siebel server, then update your connection resource if necessary (see Creating Connection Resources).

    CreateAction2

    Position the mouse pointer over a node in the tree view to get ToolTip information about the node. ToolTips display the following information, depending on the node type:

  3. Click on the plus sign to the left of a node to see the contents of the node.

  4. Right-click on the desired operation, then select Get Schemas from the context menu.

    createAction3

    After a few seconds, the Request and Response tabs of the Request dialog box are enabled.

  5. Select the Request tab. The Request pane is displayed.

    CreateAction4

  6. Type a name for the request message in the Request Message field, or accept the default name as shown in the preceding illustration.

  7. Expand the nodes of the Request Tree by clicking on the plus signs to the left of the nodes.

  8. Select the elements that you want to include in the Request document by selecting or deselecting the check boxes in the node tree. Some nodes are greyed out (disabled). This is because the document schema determines the nodes that you can edit.

    Composer strictly enforces schema rules. In other words, Composer will not let you specify an invalid request document. Items that you should not edit are disabled, and items that you can edit have context-menus that non-customizable nodes do not have. For example:

    ToolTips are an important aid in using the Request and Response panes, because they display document-structure rules from the request and response document schema. Familiarize yourself with the ToolTip feature by letting the mouse hover over various nodes, as shown in the following illustration.

    tooltip1

    NOTE:   The ToolTips that appear in this tree are also available in the Native Environment pane.

  9. If a node has a Maximum Occurrence property of greater than one, a command called "Create new..." is available by right-clicking on the node. Selecting that command brings up the following dialog box:

    createNewNode

    Enter the number of additional instances of this node-type that you want to insert in the document, then click OK. New nodes are added to the document structure.

    CAUTION:    There is no Undo for this operation.

  10. If an enumeration button (EnumButton) is displayed to the right of a given node, you can click the button to choose from the list of appropriate (schema-allowed) values for that enumeration.

    attrTypes

    For example, the Siebel QueryWithView method allows different presentations of data depending on how the Siebel environment is configured. You can specify a View mode by selecting a parameter from an enumeration, as shown in the following illustration.

    addUpdateDelete

  11. Visit all of the nodes in the request tree that are of interest to you, and use the Composer user interface features described in the preceding steps to customize the request document structure.

  12. Click the Response tab at the top of the dialog box to bring the Response document pane forward. This pane shows a tree view of the Response document, similar to the one shown for the Request document. The same user interface features that applied to the Request document pane apply to the Response document pane.

    responseTab

  13. Type a name for the response message in the Response Message field, or accept the default response message name.

  14. Select or deselect Filter Response, as desired. Filter Response is selected by default. If deselected, the tree will be disabled and greyed (no longer editable), indicating that a default schema configuration will be used. If selected, you can customize the structure of the request document by selecting the nodes to be included in the response document.

  15. Visit all of the nodes in the Response document tree and customize the settings as desired.

  16. Select OK. The dialog closes and a new action appears in the Action Model of your component. The Native Environment Pane changes to show the Request and Response tabs along with tree views of the request and response documents.

  17. To map a node of the Input document to a node in the Request document, drag a node from the Input pane and drop it on a node in the Request tab of the Native Environment pane. This automatically creates a new XML Map Action in the Action Model.

  18. To map a node of the Response document to a node in the Output document, drag a node from the Response tab of the Native Environment pane and drop it on a node in the Output pane. This automatically creates a new XML Map Action in the Action Model. You can cut, copy, or delete the actions once they appear in the Action Model pane.

  19. Add or remove actions from the Action Model to create the desired business logic.

 
Top of section

Returning to Schema-Edit Mode

Once you have created a Request Action in your Action Model (see Creating Actions in the Component Editor), you can go back and edit the Request and Response schema trees by double-clicking the Request Action in the Action Model. Double-clicking causes the Request dialog box to be displayed. You can use the Request and Response tabs to navigate the request- and response-document schemas and change your customizations as desired. When you exit from of the dialog box, your changes are reflected in the Native Environment Pane.

NOTE:   If you manually edit the Request or Response documents in the Native Environment Pane (see Manually Editing the Request and Response Documents), you will not be able to reopen the Request Action dialog. Avoid manually editing request/response documents. Instead, make modifications through careful use of the XML Map Action or by using Request.createXPath( ) and DOM methods in a Function Action.

 
Top of section

Request and Response Documents

After you have created a Request Action (see Creating Actions in the Component Editor), the Native Environment Pane portion of the Composer editor view displays Request and Response documents in tree-view form, as shown in the following illustration.

NEP1

You can drag and drop data from the Input document to the Request document to create XML Map actions. You also can use drag-and-drop mapping to map from Response to Output. In the preceding illustration, a node is displayed in red. The red color indicates that data has been mapped to the node.

Manually Editing the Request and Response Documents

If you right-click anywhere inside the Request or Response tree views in the Native Environment Pane, a menu is displayed.

NEP2

The Edit Document command in this menu opens the document in a text-editor, as shown in the following illustration.

NEPEdit

In this window, you can manually edit the Request or Response document.

CAUTION:    If you manually edit the document, it may no longer conform to the original schema. As a result, you will no longer be able to open the document in the Request Action dialog box.

If you have manually edited a Request or Response document, double-clicking on the corresponding Request Action in the Action Model will cause the following message to be displayed:

Error

If this message appears, and you want to work with the document using the Request Action dialog box, you must recreate the action in order to see the original Request or Response document. Manual edits will be lost.

To prevent this situation from occurring, avoid making manual edits to Request or Response documents. Instead use XML Map Actions and Function actions to modify documents or node contents. Be aware that doing so may violate schema constraints. This will not necessarily cause runtime problems for your component when executing in the Composer Enterprise Server environment, because Composer does not validate the request document against the schema at runtime. However, your Siebel system may validate incoming requests, in which case a manually-edited Request document can cause errors that are difficult to troubleshoot.

 
Top of section

"Before Execute" and "After Execute" Actions

Whenever a Siebel Request action is created in the Action Model, Composer adds two additional lines to the action list: Before Execute Actions and After Execute Actions. These are header labels (grouping labels) for blocks of actions that occur before the request is sent to the Siebel system, or after a response document has come back, respectively. Typically you will want to map data fields from Input to Request and have those actions be grouped under the "Before Execute Actions" header. Likewise, any map actions or other action logic that you need to perform on the Response document after the Siebel system executes your request should be grouped under the "After Execute Actions" heading.

beforeAfter

 
Top of page

Creating Siebel Services

The exteNd ComposerTM Connect for Siebel supports access to Siebel Integration Objects by using Siebel XML. Before you create a Siebel Service you must use the Siebel Tools Schema Wizard to generate an XDR schema with a Siebel Message envelope. The XDR schema is used as input to Composer when generating schemas for Integration Objects. After you generate the XDR schema, Composer uses the XDR file to generate the XML schema.The XDR file must be located in a directory that can be accessed by Composer. Refer to your Siebel documentation for information about generating XDR files for Integration Objects.

As part of the process of creating a Siebel Service, you can select an existing Siebel connection resource, or you can create a new one. If you create the connection beforehand, it is available for use by any Siebel Services in the current project. If you have not already created at least one Siebel connection resource in the current project, you will be prompted to do so when you try to create a Siebel Service.

NOTE:   You can still create a Siebel Service without first creating a connection resource, but you won't be able to use any debug features that depend on a live connection.

Procedure To Create a New Siebel Service:

  1. Select File > New > xObject. The New xObject dialog box is displayed.

    NOTE:   Alternatively, under Service in the Composer Navigator pane (Explorer view), you can highlight Siebel Service, click the right mouse button, then select New.

  2. Select the Process/Service tab.

  3. Double-click on "Siebel Service."

    If you have not previously defined a connection resource, you are prompted to do so now (see Creating Connection Resources).

    If you have already defined a connection resource, the "Create a New Siebel Service" Wizard is displayed.

    CreateNewService-1

  4. Type a Name for the new Siebel Service.

  5. Optionally, type Description text.

  6. Select Next. The XML Input/Output Message Property Info panel of the New Siebel Service Wizard is displayed.

    CreateNewService-2

  7. Specify the Input and Output templates as follows:

  8. Select an XML template for use as an Output DOM using the procedure described in the previous step.

    NOTE:   You can specify an input or output XML template that contains no structure by selecting {System}{ANY} as the Input or Output template. For more information, see "Creating an Output Document without Using a Template" in the Novell exteNd Composer User's Guide.

  9. Select Next. The Temp and Fault XML Template panel is displayed.

    CreateNewService-3

  10. If desired, specify a template to be used as a scratch pad under the "Temp Message" pane of the dialog box. This can be useful if you need a place to hold values that will be used temporarily during the execution of your component. Select a Template Category if it is different than the default category. Then select a Template Name from the list of XML templates in the selected Template Category.

  11. Under the "Fault Message" pane, select an XML template to be used to pass back to clients when an error condition occurs.

  12. To add additional input XML templates, click Add and choose a Template Category and Template Name for each. Repeat as many times as desired. To remove an input XML template, select an entry and click Delete.

  13. Select Next. The Connection Info panel of the Create a New Siebel Service wizard is displayed.

    CreateNewService-4

  14. Select a Siebel File, HTTP, or MQSeries Service connection from the Connection list. The Connection list displays the names of the Siebel connection resources that have been defined in this project.

  15. Select Finish. The component is created and the Siebel Service Editor is displayed. The features of this window are identical to the features described in About the Siebel Component Editor Window. The following sections describe the steps required to create a Siebel Service Action.

 
Top of section

Creating Siebel Service Actions

You can create all the normal Composer actions in the Action Model of your Siebel Service (e.g., XML Map, Function, Log, Send Mail). In addition, you can create a Siebel Service Request action.

The Siebel Service Request action is similar to a Switch action (see "The Switch Action" in the in the Novell exteNd Composer User's Guide). A Switch action allows program control to branch to a block of actions based on a match between an input value and a Case value. In a Siebel Service Request, Composer receives a DOM, and compares a series of cases against the DOM. If an exact match occurs between the DOM and a case, execution branches to the actions listed underneath the case in the Action model. Cases are tested in the order listed; and once a match is found, execution of the match logic precludes execution of any other logic in the Siebel Service Request.

Procedure To Create a Siebel Service Request Action

  1. In the Action Model, right-click on Siebel Service Request:

    ServiceReq-EditAction

  2. Select Edit Action. The Service Request dialog box is displayed.

    ServiceRequestDialog

  3. In the Function tree, click on the plus (+) sign to the left of the Integration Object node to expand the tree view for that node.

    ServiceReq-IntegrationObjTreeView

  4. Left click on the name of the Integration Object for which you have created an XDR file (this highlights the name), then right-click on the name to display a context-sensitive menu.

    ServiceReq-AddEvent

  5. Select Add Event. The Add Schema dialog box is displayed.

    ServiceReq-AddSchema

  6. Type a name for the event node in the Node Name field.

  7. Use the Browse button next to the XDR File Location field to locate the XDR file that was created for the Integration Object.

  8. Select OK. A function node is added to the Function tree.

  9. Right-click on the function name and select Add Case, or double-click on the function name.

    ServiceReq-AddCase

    The Adapter Service Request dialog box is displayed. This dialog box is similar to the Siebel Request dialog box (see Creating Actions in the Component Editor).

    ServiceReq-AdptrServRequest

  10. Select or deselect Filter Request, as desired. Filter Request is selected by default. If deselected, the tree will be disabled and greyed (no longer editable), indicating that a default schema configuration will be used. If selected, you can customize the structure of the request document by selecting the nodes to be included in the request document.

  11. Expand the nodes of the Service Request Tree by clicking on the plus signs to the left of the nodes.

  12. Select the elements that you want to include in the Service Request document by selecting or deselecting the check boxes in the node tree. Some nodes are greyed out (disabled). This is because the document schema determines the nodes that you can edit.

  13. If the Service Response tab is enabled (this depends on the Synchronization Type setting in the Connection resource), click the Service Response tab at the top of the dialog box to bring the Service Response document pane forward. This pane shows a tree view of the Response document, similar to the one shown for the Request document. The same user interface features that applied to the Request document pane apply to the Response document pane.

  14. Visit all of the nodes in the Response document tree and customize the settings as desired.

  15. Click the Case Expression tab at the top of the dialog box to bring the Case Expression pane forward. This pane provides an Expression Builder that you use to build a case expression.

    ServiceReq-CaseExpression

  16. Type the static string values or the ECMAScript expressions that will be checked against the input DOM.

  17. Select the OK button. The Service Request dialog box is displayed.

    ServiceReq-OneCase

  18. To add another case, repeat Step 4 through Step 17. The cases are listed from top to bottom in the order in which they are evaluated. Each Case value will be checked in turn, in the order you list them.

  19. When you have finished adding cases, select OK. The Service Request dialog box closes and a new action appears in the Action Model of your component. The Native Environment Pane changes to show the Request and Response (if the Synchronization Type is set to REQUEST_RESPONSE in the Connection resource) tabs along with tree views of the request and response documents.

    ServiceReq-ActionModel

  20. In the Action Model, add actions to be performed to each case to create the desired business logic.

 
Top of section

Managing Deployed Siebel Services

Once a project containing Siebel Services has been deployed (see "Deploying Your Project" in the Novell exteNd Composer User's Guide), the Listener objects actively listen for messages each time you start your server. To manually start and stop these services you need to use the exteNd Siebel Services Console. This browser-based console allows you to see the list of Siebel Services, the status of each service (running or not running), the running tally (Count) of messages received, other administrative information, and a Start/Stop button.

Procedure To display the exteNd Siebel Services Console:

  1. Make sure that your application server is running.

  2. From the Windows Start menu, select Programs > Novell Extend 5.2 > Composer > Composer Server Console. A dialog box for entering the application server administrator ID and password is displayed.

  3. Type your administrator ID and password, then select OK. The Composer Server Console page is displayed.

  4. Scroll down the About Products list on the left side of the page until you see the link titled "sblservice".

    ComposerServerConsole

  5. Select the "sblservice" link. A page is displayed that provides information (e.g., version, license number, copyright) about the Connect. It also displays a Console button.

  6. Select the Console button. The Siebel Service console page is displayed. This page lists any Siebel Services that have been deployed.

    Console

  7. To stop a Siebel Service, select the appropriate Stop button (the button will then change to Start).

    NOTE:   If messages are being handled by a service at the time of the Stop command, there may be some delay before the service actually exits. Select the Refresh button periodically until the "Running" column of the console says No for the service.

Procedure To undeploy a Siebel Service:

  1. Make sure that your application server is running.

  2. From the Windows Start menu, select Programs > Novell Extend 5.2 > AppServer > Server Management Console.

  3. Login as an administrator (File > Login).

  4. Select the Deployment icon (DeploymntInfoButton-SMC)from the toolbar.

  5. Select Deployed Objects:

    DeployedObjects

  6. Expand the database containing the deployed objects that you want to manage:

  7. Select the object that you want to undeploy.

  8. Select the Undeploy button.

 
Top of page

ECMAScript Extensions

See Appendix A to this guide for a list of ECMAScript extension methods that can be used with the PeopleSoft Connect.



Copyright © 2004-2005 Novell, Inc. All rights reserved. Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003 SilverStream Software, LLC. All rights reserved.  more ...