Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Integer-type Primary Key Required: External data needs a unique integer-type field that can be aliased as an ID.
  • External Data Not on Local Server Needs a Linked Server Relationship: If the external data is not physically stored on the local SQL server where Aptify is installed, then you need to create a Linked Server relationship.
  • External Data Not on Local Server Must Map to a View in a Database on the Local Server: If the external data is not physically stored on the local SQL server where Aptify is installed, then you must also create a view in a local database that points to the virtual entity's data source.

Anchor
_primaryKey
_primaryKey
Integer-type Primary Key Required

Data displayed in Aptify must have a unique integer-type field (int, smallint, bigint) that can be used as the ID value for the record. Aptify requires that primary keys use an integer type for ID values.

...

Note that this requirement is already met if mapping Aptify sub-type data to a virtual entity, since sub-type entities already have an ID field.

Anchor
_linkedServer
_linkedServer
External Data Not on Local Server Needs a Linked Server Relationship

A virtual entity can display external data that is not stored physically in the local SQL Server. However, to display this data in Aptify, the external data source must have a Linked Server relationship with the SQL Server that hosts Aptify.

...

  1. Launch Microsoft SQL Server Management Studio and connect to the SQL server on which Aptify is installed.
  2. In the Object Explorer, expand the server's heading and select Server Objects > Linked Servers.
  3. Right-click the Linked Servers folder and select New Linked Server... from the pop-up menu.

    Creating a Linked Server Connection
  4. Specify the Linked Server name in the field provided. If another SQL server, the Linked Server name must match the server's network name.
  5. Specify the Server type.
    • If another SQL server, select the SQL Server option.
    • If the source is not another SQL server, specify the data source type from the list of available options in the drop-down list.

      Adding a Linked Server
  6. If you set Server type to Other Data source, enter the data source's information in the fields provided.
    • Refer to Microsoft's Help documentation if you need assistance completing this information.

  7. Click the Security page and specify connection credentials for the data source, as appropriate.
    • For example, if connecting to another SQL Server, you must provide login information for this server.
    • Refer to Microsoft's Help documentation if you need assistance completing this page.

  8. Click the Server Options page and modify the default options, as necessary.
    • Refer to Microsoft's Help documentation if you need assistance completing this page.

  9. Click OK to create the Linked Server connection.

Anchor
_databaseMap
_databaseMap
External Data Not on Local Server Must Map to a View in a Database on the Local Server

A virtual entity in Aptify obtains data from a view that is stored in a database on the local SQL server, either in the APTIFY database or another local database. Therefore, if you are creating a virtual entity for external data that is not on the local server or if you creating a virtual entity of Aptify data (such as a sub-type entity), then you need to create a view in a local database from which Aptify can pull the virtual data.

...