Virtual Entities

A Virtual Entity is a logical grouping of information, from multiple sources, into re-usable Views. Virtual Entities enable Configuration Consultants or Citizen Developers to use a single configuration structure and integration mechanisms that facilitates re-use and re-factoring.

Standard XMPro Integration using XMConnect can be illustrated in the following figure.

Integration using Virtual Entities can be illustrated in the following figure.

The Virtual Entity Structure is shown in the following figure.

A Virtual Entities View can be built up from information in different tables and fields or objects and properties.

How to Configure Virtual Entities using the Virtual Entity Editor

1. Click the Wizards tab on the Menu Bar to Access the Editor.
2. Click the Virtual Entity Wizards icon as indicated in the previous figure (once created a Virtual Entity can be used on ActivityA specific step in a process.  It will be the user interface for that step (web form or a screen), for example, the Leave Application (screen interface or web form) will be the first Activity in the Leave Requisition process.  The Leave Application Authorization will be the second step or Activity in the Leave Requisition process.  One Process can have multiple activities. level by navigating to the required Activity.
3. Click the  Plus Sign to Add a Virtual Entity.

Virtual Entities can be created (new), updated, or deleted.

4. Select the Connector and relevant source objects:

5. Select the relevant operations (one or more) – Read, Insert, Update, Delete, Export to Excel, Import from Excel. An optional filter can be specified that will restrict the returned data set. Export or Import from Excel is specific to the SQL Connector whereas entities can use a variety of connectors.

6. Map the inputs and outputs of the operation to the Entity Properties.

7. Create the View.

The Virtual Entity can now be used in Processes.

8. Select  Add Virtual Entity on the activity editor in the Work Area as indicated in the example below.

9. Select the Virtual Entity and Objects required.

10. Select the required Entity Operation(s) and click Next.

11. Select the Entity Views and click Next.

12. Map the Properties to the Controls (objects) on your Activity (Screen).

13. Click Finish to save the configuration.

The Virtual Entity displayed on the Activity (screen):

The Virtual Entity in the XMPro Workspace

14. Click Save and Refactor on the Virtual Entity Editor as indicated below to save to all the Activities.

Considerations

• If the Connector does not exist, it will need to be created first. Virtual Entities rely on Connectors to query data sources.
• Objects within a Virtual Entity can be configured to use any operations that are provided by a specific Connector.
• Each Object can make use of a different Connector and multiple operations from that Connector.
• Access rights can be assigned to Connectors but not to Virtual Entity definitions.
• Once data from a Virtual Entity is displayed on a form, those values can be used in:
  • Subsequent Virtual Entity operations and integration
  • Routing
  • Rules
  • Dynamic descriptions
  • Expressions
  • Virtual Entities are not directly linked to (or nested within) other Virtual Entities. Once data from a Virtual Entity is displayed on a form (screen) these values can be used in subsequent Virtual Entity operations and integration.