webMethods-To-Siebel Communication

Overview

The following sections describe how to configure and manage adapter services, which you use for webMethods-to-Siebel communication. For a description of adapter services, see webMethods-to-Siebel Communication.

The following table lists the tasks required to use adapter services:

Task Use this tool...
1 Configure an adapter connection. See Adapter for Siebel Connections for details. Integration Server Administrator
2 Select the appropriate adapter service template and configure the adapter service, as described in the following sections. Digital Event Services or Designer
3 If you plan to use an Integration Server flow or Java service to invoke the adapter service, design the flow or Java service to use this adapter service. For details, see the IBM webMethods Service Development Help for your release. Digital Event Services or Designer
4 Manage the adapter service. See Package Management and Logging and Exception Handling for details. Digital Event Services or Designer and Integration Server Administrator
Note: Each service operates on specific fields of a specific Siebel business component. When configuring adapter services, you need to consider the properties (such as default field values) of your Siebel business components. Business components also contain predefined procedures that you can invoke using an adapter service. Therefore, you should be very familiar with your Siebel business components before creating adapter services that operate on them.

Before Configuring or Managing Adapter Services

About this task

To prepare to configure or manage an adapter service

Procedure

  1. Start Integration Server and Integration Server Administrator.
  2. Make sure you have IBM webMethods Integration Server administrator privileges so that you can access Integration Server Administrator's administrative screens. For information about setting user privileges, see the IBM webMethods Integration Server Administrator’s Guide your release.
  3. Using Integration Server Administrator, make sure the WmSiebelAdapter package is enabled. See Enabling a Package for instructions.
  4. Using Integration Server Administrator, configure the adapter connection you plan to use with the adapter service. For instructions, see Configuring Adapter Connections.
  5. Start Digital Event Services or Designer if it is not already running.
    Note: If you are using Digital Event Services 6.1 or later, use the Edit perspective for all procedures unless stated otherwise. If you are using Designer, use the Service Development perspective. For more information, see the IBM webMethods Service Development Help for your release.
  6. Using Digital Event Services or Designer, create a user-defined package to contain the service, if you have not already done so. When you configure adapter services, you should always define them in user-defined packages rather than in the WmSiebelAdapter package. For more information about managing packages for the adapter, see Package Management.

Configuring Query, Insert, Update, and Delete Services

About this task

These services perform the following operations:

Service Description
Query Retrieves business component records based on one or more fields.
Insert Inserts a business component record with values specified for one or more fields.
Update Updates business component records based on the value of one or more fields. You can specify that one or more record fields be updated.
Delete Deletes business component records based on the value of one or more fields.

For more information, see Query Services, Insert Services, Update Services, and Delete Services.

Note: When creating a Query, Insert, Update, or Delete service, you can select a multi-valued link (MVL) to a child record. For more information, see Multi-Valued Links in Services.

To configure a Query, Insert, Update, or Delete service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
    Note: Make sure the server with which you want to use Digital Event Services or Designer is running.
  3. Perform one of the following:
    • If you are using Digital Event Services, select File > New > Adapter Service and click Next.
    • If you are using Designer, perform the following:
      1. Right-click the package in which the service should be contained and select New > Adapter Service.
      2. Select the parent namespace and type a name for the adapter service.
      3. Click Next.
  4. Select IBM webMethods Adapter for Siebel from the list of available adapter types. Click Next.
  5. Select the appropriate Adapter Connection Name and click Next.
  6. From the list of available templates, select the Query, Insert, Update, or Delete template as appropriate and do one of the following:
    • If you are using Digital Event Services, click Next, select a package and folder where the adapter service should be stored, and then click Finish.
    • If you are using Designer, click Finish.
  7. Type a unique name for the service and select the appropriate folder. Click Finish.
  8. You can select the Adapter Settings tab at any time to confirm adapter properties such as adapter type, connection name, and service template, as needed.
  9. Select the Navigation Path tab to specify the records that the service accesses, using the following fields:
    Parameter Description/Action
    Business Object The name of the business object that contains the business component for which you are creating the service.
    Business Component The name of the business component for which you are creating the service.
    Multi-Valued Links Optional. Select a field of the business component to use as a multi-valued link (MVL) to a child record. For example, to query the primary business address of a particular Account, you might select the Account business component's field Company Name, which links to a business component named Business Address. This creates a query that navigates from the Account business component to the Business Address business component. For more information about multi-valued links, see Multi-Valued Links in Services.
    Additional Business Component [1] The parent business component of the business component you selected, if one exists.
    Additional Business Component [2] The parent business component of the business component you selected in Additional Business Component [1], if one exists.
  10. Use the Search tab to define a search expression for the selected business component. To define a search expression, provide values for the fields on the top row of the tab. Also define search expressions for a multi-valued link and up to two additional business components, if you specified them.
    1. Use the icon (or the icon) to create new rows as needed.
    2. Select a logical operator from the AND/OR field, an Operator, and separators (the left and right parentheses) as needed, and provide values for the following parameters:
    Parameter Description/Action
    AND/OR A logical operator.
    Siebel Field A search field of the selected business component.
    Siebel Field Data Type The data type of Siebel Field.
    Operator An operator for the search expression.
    Note: For case insensitive search, select ‘~='. For case sensitive search, select ‘='.
    Input Field An input field of the adapter service.
    Input Field Data Type The data type of Input Field.
  11. If you want to perform a Query service
    1. Select the Output Mapping tab to map the selected Siebel fields to output fields of the adapter service.
    2. Provide values for the following Output Mapping parameters:
    Parameter Description/Action
    Siebel Field Select a Siebel field to use as output to the adapter service.
    Siebel Field Data Type The data type of Siebel Field.
    Output Field The field to map Siebel Field to.
    Output Field Type The data type of Output Field.
    Sort Order Select a sort order (Ascending or Descending).
  12. If you want to perform an Insert or Update service
    1. Select the Input Mapping tab to map the adapter service's input fields to Siebel fields.
    2. Provide values for the following Input Mapping parameters:
      Parameter Description/Action
      Siebel Field Select a Siebel field to use as input to the adapter service.
      Siebel Field Data Type The data type of Siebel Field.
      Input Field The field to map Siebel Field to.
      Input Field Data Type The data type of Output Field.
      Note: When mapping input values for a Siebel field with a drop-down list, make sure you provide the predefined values provided in the drop-down list. For example, assume that the Status field provides the drop-down list values Open, Pending, and Closed. When you insert or update a record that contains the Status field, the Siebel application expects you to provide Open, Pending, or Closed. Otherwise, the adapter throws an exception.
  13. For information about using the Input/Output, Settings, Audit, Permissions, and Results tabs, see the IBM webMethods Service Development Help for your release.

    Digital Event Services and Designer contain the Adapter Settings and Input/Output tabs. The information from the Audit and Permissions tabs now appears in the Properties panel, and the information from the Results tab now appears in the Results panel.

  14. Select File > Save.
  15. To run the adapter service directly from Digital Event Services or Designer at this time, perform the following steps:
    1. If you are using Digital Event Services, set the view to the Test perspective.
    2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to test.
    3. Double-click the service you want to test.

      Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

    4. Perform one of the following
      • If you are using Digital Event Services, select Test > Run.
      • If you are using Designer, select Run > Run As > Run Service.
    5. To connect to the Siebel Server using credentials that are different than the credentials provided at design time, specify the username and password here:
      Parameter Description/Action
      user The user name used to connect to the Siebel Server.
      password The password used to connect to the Siebel Server.
      Note: If you do not provide the user credentials here, the user credentials specified when the connection was configured are used. For more information, see Configuring Adapter Connections and Passing Credentials at Run Time while Invoking an Adapter Service.
    6. For every service input field, you will be prompted to enter an input value. Enter a value for each input field and then click OK.
    7. Click the Results tab to view the output from this service.

      The output for each service is as follows:

      The output for this service ... Is a ...
      Query Document list field named Results. If the Query was successful, a document field (also named Results) displays the fields returned by the service.
      Update String field named Rows Updated, which indicates the number of rows updated by the service.
      Insert String field named Row ID, which indicates the row ID of the row inserted by the service.
      Delete String field named Rows Deleted, which indicates the number of rows deleted by the service.

Configuring Associate Services

About this task

The Associate service performs a Siebel Associate operation. This service establishes relationships among multi-value group (MVG) business component records.

For more information, see Associate Services.

To configure an Associate service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
    Note: Make sure the server with which you want to use Digital Event Services or Designer is running.
  3. Perform one of the following:
    • If you are using Digital Event Services, select File > New > Adapter Service and click Next.
    • If you are using Designer, perform the following:
      1. Right-click the package in which the service should be contained and select New > Adapter Service.
      2. Select the parent namespace and type a name for the adapter service.
      3. Click Next.
  4. Select IBM webMethods Adapter for Siebel as the adapter type and click Next.
  5. Select the appropriate Adapter Connection Name and click Next.
  6. Select the Associate template and click Next.
    • If you are using Digital Event Services, click Next, select a package and folder to contain the service, type a unique name for the service, and click Finish.
    • If you are using Designer, click Finish.
  7. The service is created and its parameters and controls are displayed in the adapter service editor. You can select the Adapter Settings tab at any time to confirm adapter properties such as adapter type, connection name, and service template, as needed.
  8. Select the Navigation Path tab to specify the records that the service accesses, using the following fields:
    Parameter Description/Action
    Business Object The name of the business object that contains the business component for which you are creating a service.
    Business Component The name of the business component for which you are creating the service.
    Multi-Valued Links Select a field of the business component to use as a multi-valued link (MVL) to the business component that you want to associate. For example, if you selected a business component named Orders, you might want to associate with it all the order line items. That is, you might select a field named Line Item, which is a multi-valued link to a business component named Order Line Item.

    You can associate only those component records that are linked by an association relationship. These component records are identified by the suffix *ASSOCIATE. Fields without this suffix are not linked by an association; they represent a one-to-many relationship, rather than a many-to-many relationship.

    Additional Business Component [1] The parent business component of the business component you selected, if one exists.
    Additional Business Component [2] The parent business component of the business component you selected in Additional Business Component [1], if one exists.
  9. Use the Search tab to define a search expression for the selected business component. To define a search expression, provide values for the fields on the top row of the tab. Also define search expressions for a multi-valued link and up to two additional business components, if you specified them.
    1. Use the icon (or the icon) to create new rows as needed.
    2. Select a logical operator from the AND/OR field, an Operator, and separators (the left and right parentheses) as needed, and provide values for the following parameters:
      Parameter Description/Action
      AND/OR A logical operator.
      Siebel Field A search field of the selected business component.
      Siebel Field Data Type The data type of Siebel Field.
      Operator An operator for the search expression.
      Note: For case insensitive search, select ‘~='. For case sensitive search, select ‘='.
      Input Field An input field of the adapter service.
      Input Field Data Type The data type of Input Field.
  10. For information about using the Input/Output, Settings, Audit, Permissions, and Results tabs, see the IBM webMethods Service Development Help for your release.

    Digital Event Services and Designer contain the Adapter Settings and Input/Output tabs. The information from the Audit and Permissions tabs now appears in the Properties panel, and the information from the Results tab now appears in the Results panel.

  11. Select File > Save.
  12. To run the adapter service directly from Digital Event Services or Designer at this time, perform the following steps:
    1. If you are using Digital Event Services, set the view to the Test perspective.
    2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to test.
    3. Double-click the service you want to test.

      Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

    4. Perform one of the following
      • If you are using Digital Event Services, select Test > Run.
      • If you are using Designer, select Run > Run As > Run Service.
    5. To connect to the Siebel Server using credentials that are different than the credentials provided at design time, specify the username and password here:
      Parameter Description/Action
      user The user name used to connect to the Siebel Server.
      password The password used to connect to the Siebel Server.
      Note: If you do not provide the user credentials here, the user credentials specified when the connection was configured are used. For more information, see Configuring Adapter Connections and Passing Credentials at Run Time while Invoking an Adapter Service.
    6. If you defined any variable input fields, you will be prompted to enter their input values. Click OK.
    7. Click the Results tab to view the output from this service. The output is a string field named Rows Associated, which indicates the number of rows of the associated MVG business component record.

Configuring Attachment Services

About this task

An Attachment service creates an attachment file in a business component record, updates an existing attachment, or obtains an attachment. To do this, at run time you specify that the Attachment service invokes one of the following Siebel methods: CreateFile, PutFile, or GetFile, respectively.

For more information, see Attachment Services.

To configure an Attachment service :

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
    Note: Make sure the server with which you want to use Digital Event Services or Designer is running.
  3. Perform one of the following:
    • If you are using Digital Event Services, select File > New > Adapter Service and click Next.
    • If you are using Designer, perform the following:
      1. Right-click the package in which the service should be contained and select New > Adapter Service.
      2. Select the parent namespace and type a name for the adapter service.
      3. Click Next.
  4. Select IBM webMethods Adapter for Siebel as the adapter type and click Next.
  5. Select the appropriate Adapter Connection Name and click Next.
  6. Select the Attachment template and click Next.
    • If you are using Digital Event Services, click Next, select a package and folder to contain the service, type a unique name for the service, and click Finish.
    • If you are using Designer, click Finish.
  7. The service is created and its parameters and controls are displayed in the adapter service editor. You can select the Adapter Settings tab at any time to confirm adapter properties such as adapter type, connection name, and service template, as needed.
  8. Select the Navigation Path tab to specify the records that the service accesses, using the following fields:
    Parameter Description/Action
    Business Object The name of the business object that contains the business component for which you are creating the service. For example, Contact.
    Business Component The name of the business component for which you are creating the service. For example, Contact Attachment.
    Multi-Valued Links Leave blank.
    Additional Business Component [1] Leave blank.
    Additional Business Component [2] Leave blank.
  9. If you plan to use the Attachment service to execute a GetFile or PutFile method, select the Search tab and define a search expression for the selected business component by providing values for the fields on the top row of the tab. Note that if you plan to use the Attachment service to execute a CreateFile method, leave the Search tab blank.
    1. Use the icon (or the icon) to create new rows as needed.
    2. Select a logical operator from the AND/OR field, an Operator, and separators (the left and right parentheses) as needed, and provide values for the following parameters:
      Parameter Description/Action
      AND/OR A logical operator.
      Siebel Field A search field of the selected business component.
      Siebel Field Data Type The data type of Siebel Field.
      Operator An operator for the search expression.
      Note: For case insensitive search, select ‘~='. For case sensitive search, select ‘='.
      Input Field An input field of the adapter service to which you will map the corresponding value in Siebel Field. The adapter automatically populates this field with values identical to the values in Siebel Field.
      Input Field Data Type The data type of Input Field.

      For example, to search on a business component's ID field and map its value to an input field named ID, you would specify:

      ID DTYPE_ID = ID java.lang.String

      The ID field is the Siebel field Row-id.

  10. The Attachment Operation Inputs tab is a display-only tab. You will provide values for the fields on this tab when you test the service, as described in Testing the Attachment Service.
  11. For information about using the Input/Output, Settings, Audit, Permissions, and Results tabs, see the IBM webMethods Service Development Help for your release.

    Digital Event Services and Designer contain the Adapter Settings and Input/Output tabs. The information from the Audit and Permissions tabs now appears in the Properties panel, and the information from the Results tab now appears in the Results panel.

  12. Select File > Save.

Testing the Attachment Service

About this task

To test an Attachment service, you can run it from either Digital Event Services or Designer before you run it in a flow or Java service. You can run any Attachment service to either create, update, or obtain an attachment file. To do this, at run time you specify that the Attachment service invokes one of the following Siebel methods:

Siebel Method Description
CreateFile Creates a file in the Siebel file system from an external source.
GetFile Obtains a file from the Siebel file system and places that file on the local file system of the Siebel Server.
PutFile Updates a file in the Siebel file system with the version of the file on the client machine.

The following procedure describes how to test an Attachment service by running it directly from Digital Event Services or Designer. The procedure provides example values for an Attachment service that invokes the CreateFile method for a business object named Contact and a business component named ContactAttachment.

To test an Attachment service from Digital Event Services or Designer

Procedure

  1. If you are using Digital Event Services, set the view to the Test perspective.
  2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to test.
  3. Double-click the service you want to test.

    Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

  4. Perform one of the following
    • If you are using Digital Event Services, select Test > Run.
    • If you are using Designer, select Run > Run As > Run Service.
  5. To connect to the Siebel Server using credentials that are different than the credentials provided at design time, specify the username and password here.
    Parameter Description/Action
    user The user name used to connect to the Siebel Server.
    password The password used to connect to the Siebel Server.
    Note: If you do not provide the user credentials here, the user credentials specified when the connection was configured are used. For more information, see Configuring Adapter Connections and Passing Credentials at Run Time while Invoking an Adapter Service.
  6. A pop-up dialog box appears, with input parameters for the service. Complete the dialog box appropriately for the Siebel method you want the Attachment service to invoke, as follows:
    • To invoke the Siebel method CreateFile, complete the dialog box as follows:
      CreateFile Input Parameter Description/Action
      Method_To_Invoke Specify CreateFile.
      Keep_Link Applies to URLs. Specify Y (Yes) or N (No) depending on whether a link to the file is stored as an attachment instead of the actual file. The example specifies Y.
      Path_To_Source_File Specify the fully qualified path of the file. The file can be located on the Siebel Server or on another computer that the Siebel Server can access.
      Key_Field_Name Specify the name of the field in the business component that contains the file name. In the example, this is ContactFileName, which is a Siebel field in the ContactAttachment business component.
      Name_Of_ID_Field Specify the ID field of the attachment business component. In the example, this is the field Contact Id of the business component ContactAttachment.
      ID The Siebel Row-id value of the attachment you are creating. In the example, this is the Row # of the contact to which this attachment is assigned.
    • To invoke the Siebel method GetFile, complete the dialog box as follows:
      GetFile Input Parameter Description/Action
      Method_To_Invoke Specify GetFile.
      Keep_Link Leave blank.
      Path_To_Source_File Leave blank.
      Key_Field_Name Specify the name of the field in the business component that contains the file name. In the example, you would specify ContactFileName, which is a Siebel field in the ContactAttachment business component.
      Name_Of_ID_Field Leave blank.
      ID The Siebel Row-id value of the attachment you are retrieving.
    • To invoke the Siebel method PutFile, complete the dialog box as follows:
      PutFile Input Parameter Description/Action
      Method_To_Invoke Specify PutFile.
      Keep_Link Leave blank.
      Path_To_Source_File Specify the fully qualified path of the file on the Siebel Server.
      Key_Field_Name Specify the name of the field in the business component that contains the file name. In the example, you would specify ContactFileName, which is a Siebel field in the ContactAttachment business component.
      Name_Of_ID_Field Leave blank.
      ID The Siebel Row-id value of the attachment you are updating.
  7. Click OK.
  8. Click the Results tab to view the output from this service. The output is a string field named Status, which indicates Success or Failure. If the service invoked a GetFile method, the field also indicates the path of the attachment returned by the service.

Results

Note: To pass empty values for particular fields, leave those fields blank and select the option Include empty values for String Types.

Configuring Services That Invoke Siebel Business Services

About this task

The Business Service service invokes a Siebel business service on your Siebel Server. For more information, see Business Service Services.

To configure a service that invokes a Siebel business service :

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
    Note: Make sure the server with which you want to use Digital Event Services or Designer is running.
  3. Perform one of the following:
    • If you are using Digital Event Services, select File > New > Adapter Service and click Next.
    • If you are using Designer, perform the following:
      1. Right-click the package in which the service should be contained and select New > Adapter Service.
      2. Select the parent namespace and type a name for the adapter service.
      3. Click Next.
  4. Select IBM webMethods Adapter for Siebel as the adapter type and click Next.
  5. Select the appropriate Adapter Connection Name and click Next.
  6. Select the BusinessService template and click Next.
    • If you are using Digital Event Services, click Next, select a package and folder to contain the service, type a unique name for the service, and click Finish.
    • If you are using Designer, click Finish.
  7. You can select the Adapter Settings tab at any time to confirm adapter properties such as adapter type, connection name, and service template, as needed.
  8. Select the Siebel Business Service Inputs/Outputs tab to configure the inputs and outputs of the Siebel business service that the adapter service invokes, as follows:
    1. Use the icon (or the icon) to create new rows as needed.
    2. Provide values for the following parameters:
      Parameter Description/Action
      Business Service Inputs Specify the:
      • Name of the business service.
      • Name of the business service method.
      • Array of Siebel property set keys.
      • Array of Siebel property set values.
      Business Service Property Output Set - Elements Specify the:
      • Array of Siebel property set keys.
      • Array of Siebel property set values.
      • Status of the business service execution.
  9. For information about using the Input/Output, Settings, Audit, Permissions, and Results tabs, see the IBM webMethods Service Development Help for your release.

    Digital Event Services and Designer only contain the Adapter Settings and Input/Output tabs. The information from the Audit and Permissions tabs now appears in the Properties panel, and the information from the Results tab now appears in the Results panel.

  10. Select File > Save.
  11. To run the adapter service directly from Digital Event Services or Designer at this time, perform the following steps:
    1. If you are using Digital Event Services, set the view to the Test perspective.
    2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to test.
    3. Double-click the service you want to test.

      Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

    4. Perform one of the following
      • If you are using Digital Event Services, select Test > Run.
      • If you are using Designer, select Run > Run As > Run Service.
    5. To connect to the Siebel Server using credentials that are different than the credentials provided at design time, specify the username and password here:
      Parameter Description/Action
      user The user name used to connect to the Siebel Server.
      password The password used to connect to the Siebel Server.
      Note: If you do not provide the user credentials here, the user credentials specified when the connection was configured are used. For more information, see Configuring Adapter Connections and Passing Credentials at Run Time while Invoking an Adapter Service.
    6. If you defined any variable input fields, you will be prompted to enter their input values. Click OK.
    7. Click the Results tab to view the output (the result of the Siebel business service execution) from this service.

Configuring Services That Invoke Business Component Methods

About this task

The Invoke Business Component Method service invokes a Siebel business component method on your Siebel Server. For more information, see Invoke Business Component Method Services.

To configure an Invoke Business Component Method service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
    Note: Make sure the server with which you want to use Digital Event Services or Designer is running.
  3. Perform one of the following:
    • If you are using Digital Event Services, select File > New > Adapter Service and click Next.
    • If you are using Designer, right-click the package in which the service should be contained and select New > Adapter Service.
  4. Select IBM webMethods Adapter for Siebel as the adapter type and click Next.
  5. Select the InvokeBusCompMethod template and click Next.
    • If you are using Digital Event Services
      1. Click Next.
      2. Select a package and folder to contain the service.
      3. Type a unique name for the service.
      4. Click Finish.
    • If you are using Designer, click Finish.
  6. You can select the Adapter Settings tab at any time to confirm adapter properties such as adapter type, connection name, and service template, as needed.
  7. Select the Navigation Path tab to specify the records that the service accesses, using the following fields:
    Parameter Description/Action
    Business Object The name of the business object that contains the business component for which you are creating the service.
    Business Component The name of the business component whose method you want to invoke.
    Multi-Valued Links Optional. Select a field of the business component to use as a multi-valued link (MVL) to a child record. For example, to query the primary business address of a particular Account, you might select the Account business component's field Company Name, which links to a business component named Business Address. This creates a query that navigates from the Account business component to the Business Address business component. For more information, see Multi-Valued Links in Services.
    Additional Business Component [1] The parent business component of the business component you selected, if one exists.
    Additional Business Component [2] The parent business component of the business component you selected in Additional Business Component [1], if one exists.
  8. The Invoke Business Component Method - Inputs tab is a display-only tab, with the input fields Business_Component_Method_Name and String_Array_of_Input_Arguments. You will provide values for these fields to run the service, as described in Testing the Invoke Business Component Method Service.
  9. For information about using the Input/Output, Settings, Audit, Permissions, and Results tabs, see the IBM webMethods Service Development Help for your release.

    Digital Event Services and Designer only contain the Adapter Settings and Input/Output tabs. The information from the Audit and Permissions tabs now appears in the Properties panel, and the information from the Results tab now appears in the Results panel.

  10. Select File > Save.

Testing the Invoke Business Component Method Service

About this task

To test an Invoke Business Component Method service, you can run it from either Digital Event Services or Designer before you run it in a flow or Java service.

To test an Invoke Business Component Method service from Digital Event Services or Designer

Procedure

  1. If you are using Digital Event Services, set the view to the Test perspective.
  2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to test.
  3. Double-click the service you want to test.

    Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

  4. Perform one of the following
    • If you are using Digital Event Services, select Test > Run.
    • If you are using Designer, select Run > Run As > Run Service.
  5. To connect to the Siebel Server using credentials that are different than the credentials provided at design time, specify the username and password here:
    Parameter Description/Action
    user The user name used to connect to the Siebel Server.
    password The password used to connect to the Siebel Server.
    Note: If you do not provide the user credentials here, the user credentials specified when the connection was configured are used. For more information, see Configuring Adapter Connections and Passing Credentials at Run Time while Invoking an Adapter Service.
  6. A pop-up dialog box appears, with input parameters for the service.
  7. Type the name of the method to invoke in the Business_Component_Method_Name field.
  8. Use the icon to create a new row in the String_Array_of_Input_Arguments field, and type the arguments for the method.
  9. Click OK.
  10. Click the Results tab to view the output from this service. The output is a string field named Status, which contains the output generated by the method that is invoked.

What to do next

Note: To pass empty values for particular fields, leave those fields blank and select the option Include empty values for String Types.

Testing Adapter Services

About this task

You use Digital Event Services or Designer to test adapter services.

For more information about testing and debugging services, see the IBM webMethods Service Development Help for your release.

To test adapter services

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. If you are using Digital Event Services, set the view to the Test perspective.
  3. In Digital Event Services or Designer, expand the package and folder that contain the service you want to test.
  4. Double-click the service you want to test.

    Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

  5. Perform one of the following
    • If you are using Digital Event Services, select Test > Run.
    • If you are using Designer, select Run > Run As > Run Service.
  6. For every service input field, you will be prompted to enter an input value. Enter a value for each input field and then click OK.
  7. Click the Results tab to view the output from this service.

Viewing Adapter Services

About this task

You use Digital Event Services or Designer to view adapter services.

To view an adapter service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to view.
  3. Double-click the service you want to view.

    Digital Event Services or Designer displays the configured service in the service template's Adapter Service Editor.

Editing Adapter Services

About this task

You use Designer to edit adapter services.

To edit an adapter service

Procedure

  1. In Designer, browse to and open the adapter service that you want to edit.
  2. Double-click the service that you want to edit.

    Designer displays the adapter service in the service template's Adapter Service Editor.

  3. Do one of the following:
    • If you have the VCS Integration feature enabled, right-click the service and select Check Out.
    • If you do not have the VCS Integration feature enabled, right-click the service and select Lock for Edit.
    • If you are using the local service development feature, from the Team menu in Designer, select the appropriate option to check out the service. The options available in the Team menu depend on the VCS client that you use.
  4. Modify the values for the adapter service's parameters as needed. For detailed descriptions of the service's parameters, see the section on configuring a service for the specific type of service you want to edit.
  5. After you complete your modifications, save the service and do one of the following:
    • If you have the VCS Integration feature enabled, right-click the service and select Check In. Enter a check-in comment and click OK.
    • If you do not have the VCS Integration feature enabled, right-click the service and select Unlock.
    • If you are using the local service development feature, from the Team menu in Designer, select the appropriate option to check in the service. The options available in the Team menu depend on the VCS client that you use.
  6. Save the service.

Deleting Services

About this task

You use Digital Event Services or Designer to delete adapter services.

To delete a service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. In Digital Event Services or Designer, expand the package and folder that contain the service you want to delete.
  3. Right-click the adapter service and click Delete.

Validating Adapter Service Values

You can use Digital Event Services or Designer to validate the values for all adapter services or for a single adapter service.

Validating Values for All Adapter Services

About this task

To always validate the values for all adapter services

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
  3. Perform one of the following:
    • If you are using Digital Event Services, select the Tools > Options > Integration Server > Adapter Service/Notification Editor item.
    • If you are using Designer, select the Window > Preferences > IBM > Service Development > Adapter Service/Notification Editoritem.
  4. Enable the Automatic data validation option.
  5. Click OK.

Results

The Automatic data validation option enables data validation for the selected adapter service only. It compares the service values against the resource data that has already been fetched from the adapter. Note that this option can slow operations.

For more information about the Adapter Service/Notification Editor, see the IBM webMethods Service Development Help for your release.

Validating Values for a Single Adapter Service

About this task

To enable automatic data validation for a single adapter service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. In Digital Event Services or Designer, expand the package and folder that contain the service for which you want to enable automatic validation.
  3. Double-click the service for which you want to validate the data.

    Digital Event Services or Designer displays the configured adapter service in the service template's Adapter Service Editor.

  4. Click the icon.

Reloading Adapter Values

You can enable the Adapter for Siebel to reload and validate user-defined data for adapter services at design time in Digital Event Services or Designer. You can reload values for a single adapter service or you can configure Digital Event Services or Designer so it automatically reloads the values for adapter services. Both options could potentially slow your design-time operations.

When you reload adapter values for a single adapter service, Digital Event Services or Designer compares the service values against the resource data that has already been fetched from the selected adapter.

Reloading Values for All Adapter Services

About this task

To reload the adapter values for all adapter services

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. Start Digital Event Services or Designer.
  3. Perform one of the following:
    • If you are using Digital Event Services, select the Tools > Options > Integration Server > Adapter Service/Notification Editor item.
    • If you are using Designer, select the Window > Preferences > IBM > Service Development > Adapter Service/Notification Editor item.
  4. Enable theAutomatic polling of adapter metadata option.
  5. Click OK.

Results

Note: For more information about the Adapter Service/Notification Editor, see the IBM webMethods Service Development Help for your release.

Reloading Values for a Single Adapter Service

About this task

To reload the adapter values for a single adapter service

Procedure

  1. Review the steps in Before Configuring or Managing Adapter Services.
  2. In Digital Event Services or Designer, expand the package and folder that contain the service for which you want to enable automatic validation.
  3. Double-click the service for which you want to validate the data.

    Digital Event Services or Designer displays the configured adapter service in the service template's Adapter Service Editor.

  4. Click the icon.