Previous Topic

Next Topic

Book Contents

Book Index

Create an External Business Object to Link to External Data

Create a new Business Object to import or link external data. When a new Business Object is created, either import or link external data. If using an existing Business Object, only import data. For more information, see Map an Existing External Business Object to Import External Data.

To create a new Business Object and link or import data:

  1. In the CSM Administrator main window, click the Blueprints category, and then click the Create a New Blueprint task.

    Note: If working on a saved Blueprint, open the existing Blueprint.

    The Blueprint Editor opens, displaying the Object Manager in its Main Pane. The Object Manager lists the existing Business Objects.

  2. Click (New Object), and then click New External Business Object.

    The External Data Wizard opens.

    External Data Wizard Welcome Page

  3. Click Next.

    The Import vs. Linked page opens.

    External Data Wizard Import vs. Linked Page

  4. Click Link to data.
  5. Click Next.

    The Data Source page opens.

    External Data Wizard Data Source page

  6. Select the database connection (External Connection) that was created to connect to the External Database.
  7. Click Next.

    The External Table to Map page opens, listing the Tables and/or Views from the External Database.

    External Data Wizard External Table to Map page

  8. Click to select the Table or View to link to.

    Note: If the Table/View is not listed, check the login account and database owner/schema to ensure it has rights to see the data.

  9. Click Next.

    The Business Object Type page opens.

    External Data Wizard Business Object Type page

  10. Select the Type of External Business Object to create, either:
  11. Click Next.

    The Fields to Map page opens.

    External Data Wizard Fields to Map page

  12. Map fields from the Table/View to a field in the new External Business Object:
  13. Click Next.

    The Unique Key and Timestamp Fields page opens. The screen shots show example fields.

    External Data Wizard Unique Key and Timestamp Fields

  14. Designate a Unique Key and Timestamp field:
  15. Click Next.

    The Read-Only or Updatable page opens.

    External Data Wizard Read-Only or Updatable page

  16. Select the radio button to determine if the data should be read-only or if it can be updated in CSM.

    Note: Unless linking to a very simple flat database, usually this integration should NOT be updatable. This CSM connection does not have any knowledge of the application rules for the receiving end of the updates.

    Note: The database login account that was used to set up the External Connection to the External Database must have rights to insert and update this Table/View. Be aware that Views cannot be updated in some databases.

  17. Click Next.

    The Search Options page opens.

    External Data Wizard Search Options page

  18. Define searching options for the External Business Objects:
    1. Use SQL Server Full-Text Search: Select this check box to enable Full-Text Search.

      SQL Server Note: If the External Database is SQL Server, select the SQL Server Full-Text Search check box to have CSM send full-text queries to the External Database when searches are done. In order to use Full-Text Search, it must be configured in the External Database. Refer to SQL Server documentation for details on how to set up Full-Text Search.

    2. Fields to search: Click Add to select the fields that should display when searches are conducted inside CSM (ex: Quick Search).

      Tip: DBAs might want to set up a database index for these fields in the order specified so that searching is faster.

    3. Select the Search type:
      • Exact match: The search string must exactly match a word or phrase in order for the record to be found. For those familiar with SQL, use the SQL clause:

        where (field = ‘value’)

      • Starts with: This finds records containing words or phrases that start with the search string. This is the recommended selection. For those familiar with SQL, use the SQL clause:

        where (field LIKE ‘value%’)

      • Contains: This returns records that contain the search string. This is slower than the other two options. If the database table contains millions of records, then do not use this option. For those familiar with SQL, use the SQL clause:

        where (field LIKE ‘%value%’)

  19. Click Next.

    The Name and Description page opens.

    External Data Wizard Name and Description Page

  20. Provide a Name for the External Business Object.

    Note: The internal name is always the name of the Table or View from the External Database. By default, the display name is the same. If the Table/View name matches an existing CSM Business Object, alter the name to ensure the name is unique. If the name is not altered, external data cannot be imported to the Business Object.

  21. (Optional) Type a Description for the External Business Object.
  22. Click Next.

    The Summary page opens.

    External Data Wizard Summary Page

  23. Click Finish.

    The Business Object's Properties window opens, displaying current (and editable) properties, including a:

  24. Click OK to close the Properties window.
  25. Create Forms and Grids for the External Business Object just as a new CSM Business Object.
  26. (Optional for Supporting Objects) If needed, create a Relationship between the newly created Supporting Objects and the Major Object they support.
  27. Publish the Blueprint (File>Publish Blueprint) to commit the changes, or save the Blueprint (File>Save Blueprint) to continue making other changes.

See Also

External Business Objects

Designate a Business Object for the External Data

Map an Existing Business Object to Import External Data

Import External Data into an External Business Object