Managing Data Source Objects

Let’s say you add an external database as a new data source. This does not automatically add all the tables in the database to your universe. Instead you must add each database table that you want to be included in your universe. To do that, add a new data source object for each table.

This ensures that only those tables that are relevant to designers are presented in the Designer interfaces, such as the Data Entry Designer.

Types of Data Source Object

When you add a data source object, you must specify the type of object. Here is a description of each of the possible types.

Type Description
Parent table A database table that acts as the parent in a parent–child relationship with another database table or tables. Where Syntelate XA is used to store customer details, the CONTACT_X table is a parent table.
Grid table A database table used for a grid.
Grid stored procedure A stored procedure used for a grid.
Interaction table The INTERACTION_X table.
Linked table  

Adding a Data Source Object

If you wish to add an existing database table, view, or stored procedure to your universe, you must add this as a data source object.

If you’d instead like to create a new table in your Syntelate XA database, you can do this directly from the Universe Builder while adding a new data source object.

To add a new data source object, follow these steps:

  1. Click New above the list of data source objects.

  2. Select a data source and then type a description for the new data source object, then click Continue. New fields show.

    Note: You can’t change the data source after continuing.

  3. Select a Data source object type (see Types of Data Source Object).
  4. For the Data source object name, either:
    • Select an existing database table/view to use or, for a data source object type of Grid stored procedure, an existing stored procedure.

    • Add a new database table to use (where the data source is Current Connection only).

      Note: Where creating a new table, you’ll need to specify the name and data type of the primary key field and of one other field. To add further fields, click Add New Field above New table name.

  5. Complete other fields as required:
    • Primary key (optional): Select the field in the database table/view that is the primary key. Not applicable where the object type is Grid stored procedure.
    • Row version field (optional): Select the field in the database table/view that is used for version-stamping rows. Not applicable where the object type is Grid stored procedure.
    • Allow new fields? Defines whether users can add fields to the data source object from elsewhere in the Designer, for example from the Control properties section of the Data Entry Designer. Only shows for objects of the Current Connection data source.
    • Primary key counter key (optional): Select a record in the COUNT1 database table to use as the counter for the primary key in this table/view, or else add a new record to the COUNT1 table.
    • Filter (optional): Type a filter in SQL to restrict what is included in this data source object, for example FIELDX = 1 would only include records where field FIELDX is 1.

  6. Click Save and Close.

Editing a Data Source Object

To edit a data source object, click Edit for the data source object that you want to edit. Edit its details as required and then click Save and Close.

If you wish to add a new field to a database table in your Syntelate XA database, you can do this by editing the relevant data source object. After clicking Edit, click Edit Existing Table and then Add Column To existing table.

Deleting a Data Source Object

To delete a data source object, you must first delete any data source object links that refer to it.

Next click Delete for the data source object that you want to delete. A dialog box shows, warning you that this will break any desktop that uses this data source object. Click Delete to confirm the deletion.