20EAI_CreatingVirtualBusinessComponents

Document Sample
20EAI_CreatingVirtualBusinessComponents Powered By Docstoc
					Section Five: Siebel Virtual Business Components




Module 20: Creating Virtual Business Components
                                Module Objectives

     After completing this module you will be able to:
        Create a virtual business component (VBC)
        Describe the scripting required to support a virtual business
         component
        Incorporate a virtual business component into a Siebel eBusiness
         application


     Why you need to know
        These procedures enable you to create and use a VBC




Module 20: Creating Virtual Business Components                    2 of 27
           Creating Virtual Business Components: Overview

         Create virtual business components (VBCs) from the bottom
          up, just like a standard business component
      2 Create User
             Interface       User
               layer         Interface   List Column
                                                         Applet     View
            definitions      Layer        or Control


      1      Create
            Business         Business                    Virtual
           Object layer      Object                                Business
                                            Field       Business
            definitions      Layer                     Component    Object


          No Data Layer
          definitions; the   Data         External      External
           data is not in    Layer
            the Siebel                   (Column?)      (Table?)
             database




Module 20: Creating Virtual Business Components                     3 of 27
                             Creating a VBC: Steps

  1. Define the virtual business component
  2. Create fields for the VBC
  3. Specify user properties for the VBC
  4. Select or create a business service for the VBC
  5. Add the VBC to a business object (and a link, if necessary)
  6. Map an applet to the VBC
  7. Compile and verify the changes




Module 20: Creating Virtual Business Components               4 of 27
                                 1. Define the VBC

     Define a virtual business component in the same way you
      would define a regular business component, except the table
      property is not specified




                                     Add a        Pick the Class   No Table
                                     Name         CSSBCVExtern      value

                                       2                3             4


   Create a new Business
        Component

              1



Module 20: Creating Virtual Business Components                               5 of 27
                         2. Create Fields for the VBC

         Enter the names of the fields for the VBC
           Either the column names in an external database, or
           Field names in an external delimited text file




                                                   Pick the data type    No column value
                                                  of the external data   since there is no
                                                                            table value
                      Enter the field name           3
                                                                         4
      Create             2
      a field

      1




Module 20: Creating Virtual Business Components                                   6 of 27
                   3. Specify User Properties for the VBC

      Enter business component user properties exactly; everything
       must match, or the VBC will not work




                                     Service Parameters (optional): Enter
                                       a text string to be parsed by the
                                           VBC's PreInvokeMethod

       Remote Source
      (optional): Enter a
       data source the
       business service
            will use

                                 Service Name (required): Enter an existing Business Service
                                           or the name of one that you will create


Module 20: Creating Virtual Business Components                                    7 of 27
                        Service Name User Property

     Instructs the VBC to use the specified business service
        This property is required, otherwise the VBC will not work
     Example: Specify the business service to be XML Gateway




           Here the Service
            Name is set to
            XML Gateway




Module 20: Creating Virtual Business Components                       8 of 27
                    Service Parameters User Property

     Pass the transport parameters used by the business service
        This property is optional
     Example: Service Parameters tells the XML Gateway business
      service to call VirtualBusCompServer.dll to access the data




                          Service Parameters




Module 20: Creating Virtual Business Components              9 of 27
              Service Parameters User Property Continued

     Specifies which transport to use
          EAI MQSeries Server Transport
          EAI MQSeries Application Messaging Interface (AMI)Transport
          EAI MSMQ Transport
          EAI DLL Transport
          EAI File Transport
          EAI HTTP Transport              Parameters are name=value
                                          pairs separated by semicolons
          Microsoft BizTalk 2000
     Examples
        Service Parameters = "Transport=EAI HTTP Transport;
        HTTPRequestURLTemplate=http://www.host.com/XMLGateway.asp;
        HTTPRequestMethod=POST"

  Service Parameters = "Transport=EAI MQSeries Server Transport;
  MQModelQueueName=Siebel;MQPhysicalQueueName=SiebelVBC"

Module 20: Creating Virtual Business Components                    10 of 27
                       Remote Source User Property

   Identifies the location of the external data source; for example,
    the ODBC, file, or database location (optional)
   The external application must support Init and Query methods
        Able to process XML requests from the business service and
         respond in the appropriate manner




                      Remote Source



Module 20: Creating Virtual Business Components                  11 of 27
      4. Select or Create a Business Service for the VBC




                      Event
                     handler




             Methods
                                             Programming Language is either
                                            eScript (JS) or Siebel Visual Basic
                                          (SBL) and is set at the parent level for
                                            the object definition in Siebel Tools



Module 20: Creating Virtual Business Components                                      12 of 27
                     XML Gateway Business Service

   Is a prebuilt business service that uses XML to communicate
    between a Siebel application and an external application
   Provides the six methods a VBC requires to use external data
   Can be configured to use:
        MQSeries transport             Workflow Process Manager
        HTTP transport                 Business Integration Manager




                                              The required methods
                                               are already written




Module 20: Creating Virtual Business Components                         13 of 27
                Creating a Business Service for the VBC

     The business service must include the PreInvokeMethod,
      PreCanInvokeMethod, Init, and Query methods
               Update, PreInsert, Insert, and Delete methods are optional
     Add user properties to the VBC




Module 20: Creating Virtual Business Components                              14 of 27
                   Business Service PreInvoke Method

     A VBC calls the PreInvokeMethod of the business service for
      processing support — all business service scripts use this
      method as a standard entry point
        Calls the method specified by MethodName
               Such as Init, Query, Update
                                                        Business Service
           Inputs (property set):
      Business service user properties            PreInvoke            Init
      and the service parameters user              Method
             property of the VBC
                                                                      Query

                                                                     Update

         Outputs (property set):                                    PreInsert
            Returns values to
       CSSBCVExtern for processing                                    Insert

                                                                      Delete


Module 20: Creating Virtual Business Components                                15 of 27
                       Business Service Init Method

     When a VBC is first instantiated, the Init method reads run-time
      parameters and sets up any necessary information in
      preparation for use of other methods
        The Init method must have field names that the VBC supports

                                                        Business Service
           Inputs (property set):
          The Init method gets the                PreInvoke            Init
        Parameters property from the               Method
        property set and processes it                                 Query

                                                                     Update

                                                                    PreInsert
                                  (No outputs)
                                                                      Insert

                                                                      Delete


Module 20: Creating Virtual Business Components                                16 of 27
                      Business Service Query Method

     Is the only way of getting data to the VBC and refreshing the UI
        PreInvokeMethod MethodName = ―Query‖
        Returns values based on the specified query values
               There is a child property set for each record returned

                                                         Business Service

            Inputs (property set):
                                                  PreInvoke                 Init
        List of [field name, field value]
                                                   Method
         pairs representing the query                                     Query

                                                                         Update
           Outputs (property set):                                       PreInsert
        List of [field name, field value]
         pairs with the values of each                                    Insert
         field in the particular record
                                                                          Delete


Module 20: Creating Virtual Business Components                                    17 of 27
                      Business Service Update Method

     Is called to commit a change to a record
        PreInvokeMethod MethodName = ―Update‖



            Inputs (property set):                      Business Service
       A child property set to represent
         each field; each property set
                                                  PreInvoke            Init
       has a Field Name, Field Value,
        and Changed – set to TRUE if               Method
                                                                      Query
             the field was updated
                                                                     Update
           Outputs (property set):
        List of [field name, field value]
                                                                    PreInsert
         pairs to represent any fields
         automatically updated as a
                                                                      Insert
        result of the update operation
                                                                      Delete


Module 20: Creating Virtual Business Components                                18 of 27
                    Business Service PreInsert Method

     Is called to perform a New Record operation
        PreInvokeMethod MethodName = ―PreInsert‖
        Called when a new record is created
        PreInsert returns any default field values for the new record
                                                          Business Service

                                                    PreInvoke            Init
                                      (No inputs)
                                                     Method
                                                                        Query

                                                                       Update
            Outputs (property set):                                   PreInsert
         List of [field name, field value]
          pairs representing fields that                                Insert
               have default values
                                                                        Delete


Module 20: Creating Virtual Business Components                                  19 of 27
                      Business Service Insert Method

     Is called to commit a new record
        PreInvokeMethod MethodName = ―Insert‖



                                                        Business Service
            Inputs (property set):
         A child property set with a list         PreInvoke            Init
           of [field name, field value]            Method
             pairs for a new record
                                                                      Query

                                                                     Update

           Outputs (property set):                                  PreInsert
            List of [field name, field
           value] pairs for any fields                                Insert
            automatically updated
                                                                      Delete


Module 20: Creating Virtual Business Components                                20 of 27
                      Business Service Delete Method

     Is called to delete a record
        PreInvokeMethod MethodName = ―Delete‖



                                                         Business Service
            Inputs (property set):
         A child property set with a list
                                                   PreInvoke            Init
           of [field name, field value]
           pairs for the record being               Method
                                                                       Query
                      deleted
                                                                      Update

                                                                     PreInsert
                                    (No outputs)
                                                                       Insert

                                                                       Delete


Module 20: Creating Virtual Business Components                                 21 of 27
      Developer-Defined Methods for a Business Service

   Are handled in the PreInvokeMethod function
   Use user-defined property sets for Inputs and Outputs
   Are called with a Service.InvokeMethod call


                                                       Business Service

                                                                 Custom Method
        Inputs (property set):                    Invoke
            User-defined                          Method         Custom Method

                                                                 Custom Method

                                             PreInvoke           Custom Method
       Outputs (property set):                Method
           User-defined                                          Custom Method




Module 20: Creating Virtual Business Components                                  22 of 27
                   5. Add the VBC to a Business Object

     Adding a virtual business component to a business object is
      the same as adding a regular business component
        Create a link connecting the VBC to a business component
               A 1:M link specifying the parent/child business component and the
                source/destination field
                  The child business component is the VBC
                  The destination field is the VBC field that is the foreign key to the parent
        Add the link to the business object




Module 20: Creating Virtual Business Components                                          23 of 27
                        6. Map an Applet to the VBC

   Create a new applet with the List Applet or Form Applet wizard
   Select a project and a virtual business component
   Enter the new applet's name and a display title




Module 20: Creating Virtual Business Components              24 of 27
                   7. Compile and Verify the Changes

   Compile projects that contain changes
   Run the application to verify the changes you made
   Use debug in Siebel Tools to check the scripts if necessary
                    Compile to the                Verify changes in the Siebel application
                    appropriate srf                    and in the external application




Module 20: Creating Virtual Business Components                                    25 of 27
                                       Summary

     This module showed you how to:
        Create a virtual business component (VBC)
        Describe the scripting required to support a virtual business
         component
        Incorporate a virtual business component into a Siebel eBusiness
         application




Module 20: Creating Virtual Business Components                    26 of 27
                                           Labs

     In the labs you will:
        Create a VBC to display contact information inside a Siebel
         application
        Create a VBC to display external credit card information inside a
         Siebel application




Module 20: Creating Virtual Business Components                      27 of 27

				
DOCUMENT INFO
Shared By:
Stats:
views:629
posted:2/19/2010
language:English
pages:27
Description: Siebel Enterprise Application Intergration , EAI