Link External Data to a New External Business Object

Linking Business Objects to external data allows for real-time updates between an external database and CSM. If updates of the external data are permitted, the Business Object can be configured to enforce the appropriate rules. A Business Object can only be linked to one external data connection.

To link external data to a new External Business Object:

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

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

  2. Click New Object from the Object Manager, then select the New External Business Object task.

    The External Data Wizard opens.

  3. Select Next.

    The Import vs. Linked page opens.

  4. Click the Link to data radio button.
  5. Select Next.

    The Data Source page opens.

  6. Click the ellipses button. The External Connection manager opens. Select an existing External Database or click the New button to create a new External Connection.
  7. Select Next.

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

  8. Click to select the Table or View to link to.
  9. Select Next.

    The Business Object Type page opens.

  10. Select the type of External Business Object to create: Major Business Object, Supporting Business Object, or Lookup.
  11. Click Next.

    The Cherwell Group page opens.

  12. Select a radio button to assign the External Business Object to a Group.
  13. Select Next.

    The Fields to Map page opens.

  14. Map fields from the selected table to a field in the new External Business Object:
    1. Click theAdd button.

      The Map Field from External Table manager opens, listing the available fields.

    2. Select an external field (example: Created By).
    3. Select an existing Cherwell Service Management field to map the external field to or create a new field.
    4. Click OK.
    5. Repeat mapping process for all desired fields.
  15. Select Next.

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

  16. Designate a Unique Key and Timestamp field:
    • Field that Holds Unique Key: Select the field from the View that is deemed as the unique identifier (example: MachineID or ComputerID).

      There must be a unique ID field for CSM to use the External Table/View. If the Table/View does not have a Unique Key, add one.

    • Last Modified Date/Time: Select the field from the Table/View that is deemed as the last modified date/time field (example: LastScanDate or date_modified).
  17. Select Next.

    The Read-Only or Updatable page opens.

  18. Select the radio button to establish whether the data should be read-only or if it can be updated in CSM.
  19. Select Next.

    The Search Options page opens.

  20. Define searching options for the External Business Objects (only available for linked external data):
    1. Use SQL Server Full-Text Search: Select this check box to enable Full-Text Search.

      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 show when searches are conducted inside CSM (example: Quick Search).
    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%’)

  21. Select Next.

    The Name and Description page opens.

  22. Provide a Name for the External Business Object.
  23. (Optional) Type a Description for the External Business Object.
  24. Select Next.

    The Summary page opens. The information varies depending on selections throughout the wizard.

  25. Select Finish.

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

    • External Data page: View/edit the field mappings, unique ID, and last modified date/time fields.
    • External Search page: View/edit external search options (if defined).
    • Search Results page: Displays the Full-Text Search and quick search (if defined).
    • Database page: Read-only because the Table/View actually resides in another database.
  26. Click OK to close the Properties window. Create Forms and Grids for the External Business Object just as a new CSM Business Object.

    Create Forms and Grids for the External Business Object just as a new CSM Business Object. (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.