Configuring the Mirror to Expose Data to Tableau

The schema and content of the mirror database is managed by Xpress Insight. Apps define their mirror tables and how they are populated. The following companion file fragment defines the table, facility_clients, populated with three arrays:

<database-mirror table-prefix="facility_">
  <mirror-tables>
    <mirror-table name="clients">
      <entity name="CLIENT_LATITUDE"/>
      <entity name="CLIENT_LONGITUDE"/>
      <entity name="DEM"/>
    </mirror-table>
  </mirror-tables>
</database-mirror>

Note The combination of the table-prefix and table-name must not exceed 64 characters. The column name must not exceed 64 characters. The table prefix, table name, column name must be a character in the Unicode range U+0001 to U+FFFF, excluding the back quote (`). Entities of Boolean data type will be mirrored as integers with a value of 1 indicating true and a value of 0 indicating false. The column name, mirror_row_id, is a reserved column name by Xpress Insight.

The following steps configure the mirror database for the Facility Location example.

1. Open and edit the app companion file FacilityLocation.xml.

   <?xml version="1.0" encoding="UTF-8"?>
   <model-companion xmlns="http://www.fico.com/xpress/optimization-modeler/model-companion" version="3.0">
       <client>
           <view-group title="Main">
               <custom-view view-class-id=".customFacilityLocation"  default="true"/>
           </view-group>
       </client>
   </model-companion>
   

2. Configure the mirror database by adding the following section to the companion file before the client element:

   <database-mirror table-prefix="facility_">
     <mirror-tables>
       <mirror-table name="clients">
         <entity name="CLIENT_LATITUDE"/>
         <entity name="CLIENT_LONGITUDE"/>
         <entity name="DEM"/>
       </mirror-table>
     </mirror-tables>
   </database-mirror>

   All three arrays are indexed by the Clients set. The resultant mirror database will therefore contain a table named facility_clients with columns CLIENTS, CLIENT_LATITUDE, CLIENT_LONGITUDE and DEM.

Five further database tables are automatically populated in the mirror database:

• The insight_projects table contains the list of apps that has had one or more scenarios mirrored. The table contains the app id, app name, and the table prefix that is used for the mirrored data.
• The insight_scenarios table contains the list of scenarios in the app that have been mirrored. The table contains the scenario id, app id, scenario name and scenario path
• The insight_security table contains a mapping of users to the scenarios they have access to. The username provided in this table is the user's Tableau username. See Securing Tableau Workbooks for more information.
• The insight_authority_groups table contains a mapping between Tableau user name and authority group names of all the authority groups that the user is assigned in the system.
• The insight_authorities table contains mappings of users to custom authorities, so none of the system defined authorities will be present in this table. These authorities are selected from the authority groups the user is a member of.