Introduction
This documentation targets:
- Developers of external BI tool based on the Datamart provided by SecuTix
- Users of the operational reporting tool provided by SecuTix
The structure of this documentation is presented as below:
- Main page : BI and reporting domains
This page contains the list of domains with a small description, its technical name and indicates from which version the domain is available.
This page also presents the links between domains and the technical fields needed to use these links. Therefore, developers are informed on the joints that they can do between different domains.
- Sub pages : for instance Theme: Seats
Each theme has its own page. Themes contain several domains which are detailed in these pages. For each domain, you will find its description and the link to the description of the columns included in this domain.
- Description of domains' data: for instance https://play.demo-pos.secutix.com/tnin/apiDocs/D_SALES_LIST_SALES?lang=en&v=1.0
This page contains the description of the columns of the selected domain. If the description is updated in the database, it will be directly visible in this page. This page contains the most up to date documentation of these data. During the delivery phase of a major release, it may be that your institution does not have the latest version. In order to visualize the correct status of your institution, replace in the URL the "secutix" part of the link with the code of your institution.
The table contains one line per data of the selected domain. Data having their name starting by "T_" are technical identifiers which are only available for the BI (and not for the operational reports).
Operational reports provide additional data which are calculated during their creation. These data are not available in the BI domains. These data will be documented in a later version of this page.
Each line of this table provides the following information:
- Attribute ID: attribute name in the BI domain
- Datatype: type of data
- Nullable: indication if data is optional or not
- Label: Column name in the operational report
- Description: Description of the data
Domains presentation
The following table gives an overview of the domains available in SecuTix BI.
By clicking on one of the report types, you can visualise the detail of the domains linked to this type. You will also find the descriptions of the data contained in these domains.
| Theme | Domain/Sub-theme | Domain description | Technical name of the domain | Available since version | Available in datamart (Yes/No) |
|---|---|---|---|---|---|
| Accounting | Account follow up | Pending account and credit account follow-up | D_ACCOUNT_FOLLOW_UP_V1_0 | Matterhorn V3 | Y |
| Accounting | List of payments | List of payments and refunds | D_ACCOUNT_LIST_PAYMENTS_V1_0 | Matterhorn V3 | Y |
| Accounting | Voucher management | Voucher management | D_VOUCHER_MANAGEMENT_V1_0 | Matterhorn V3 | Y |
| Attendance | Attendance | Attendance statistics | D_ANALYTICS_ATTEND_V1_0 | Matterhorn V3 | Y |
| Availability | Hospitality sale room availability | Hospitality sale room availability | D_AVL_HOSP_ROOM_V1_0 | Gabelhorn V1 | Y |
| Availability | Hospitality inventory availability | Hospitality product/bundles sales room availability | D_AVL_HOSP_PRODUCT_ROOM_V1_0 | Gabelhorn V1 | Y |
| Availability | Product follow up | Product availability | D_AVL_PROD_FOLLWUP_V1_0 | Matterhorn V3 | Y |
| Availability | Room availability | Availability of seats in a given room | D_AVL_ROOM_AVL_V1_0 | Matterhorn V3 | YN |
| Configuration | Comfort variables | Comfort variables of the performances of an event | D_CONFIG_COMFORT_VARS_V1_0 | Whymper V1 | Y |
| Configuration | List of areas | Information on the areas of logical configurations | D_CONFIG_LOGICAL_AREA_V1_0 | Whymper V1 | Y |
| Configuration | List of performances | Detailed information on the performances of an event | D_CONFIG_LIST_PERF_V1_0 | Whymper V1 | Y |
| Configuration | List of products | Detailed information on configured products | D_CONFIG_PROD_LIST_V1_0 | Whymper V1 | Y |
| Configuration | List of operators | List of operators | D_OPERATOR_LIST_V1_0 | Whymper V1 | Y |
| Contact | Contact information | Detailed information of the contact | D_CONTACT_LIST_V1_0 | Piz Bernina V3 | Y |
| Contact | Contact criteria and other values | All contact information depending on the organization | D_CONTACT_ORG_INFO_V1_0 | Piz Bernina V3 | Y |
| Contact | Cultural history | Cultural history of a contact | D_CONCT_CULTURAL_HISTORY_V1_0 | Matterhorn V3 | Y (V_2_0 in datamart) |
| Contact | Links between contacts | All the links between contacts | D_CONTACT_CONNECTION_V1_0 | Whymper V1 | Y |
| External References | List of external references | All the external references for movements or operations | D_TICKET_EXTERNAL_REFERENCES_V1_0 | Bishorn V1 | Y |
| Goods | Purchase diary | Purchase diary (by cultural institution) of a selection of goods | D_GOODS_PURCHASE_DIARY_V1_0 | Matterhorn V3 | N |
| Goods | Stock status | Stock status of a selection of goods | D_GOODS_STATUS_V1_0 | Matterhorn V3 | N |
| Lottery | List of ticket requests | Detailed information on requested tickets via a lottery | D_LOTTERY_TICKET_REQUEST_V1_0 | Whymper V1 | N |
| Lottery | List of lottery users | Detailed information on lottery users | D_LOTTERY_USERS_V1_0 | Whymper V1 | N |
| Lottery | List of requested tariffs | Details on tariffs mentioned in the tickets requested via a lottery | D_LOTTERY_TARIFF_DETAILS_V1_0 | Whymper V1 | N |
| Lottery | List of guests | List of guests planned for the requested tickets | D_LOTTERY_GUESTS_V1_0 | Whymper V1 | N |
| Planned quotas | Planned quotas | Use and availability of planned quotas (contingent type "sub-target group") | D_AVL_PLANNED_QUOTAS_V1_0 | Whymper V1 | Y |
| Planned quotas | Planned quotas of parents contingent | Use and availability of planned quotas (contingent type "target group") | D_AVL_PLANNED_QUOTAS_PARENT_V1_0 | Whymper V1 | Y |
| Sales | Link between operation and payment | Link between operation and payment | D_PAYMENT_OPERATION_LINK_V1_0 | Matterhorn V3 | Y |
| Sales | List of invoices | List of invoices and payment tracking | D_ACCOUNT_LIST_INVOICE_V1_0 | Matterhorn V3 | Y |
| Sales | List of sales | Detailed information on sales | D_SALES_LIST_SALES_V1_0 | Matterhorn V3 | Y |
| Sales | Product revenue | Number of sales and revenue | D_SALES_PROD_RECEIPT_V1_0 | Matterhorn V3 | Y |
| Sales | List of sales and matching payments | Detailed information on sales and their payment | D_SALES_PROD_PAYMENT_V1_0 | Matterhorn V3 | Y |
| Sales | Summary of fees | Revenue due to fees | D_SALES_FEES_V1_0 | Matterhorn V3 | Y |
| Sales | List of movements | Detailed information on movements created during orders | D_SALES_MOVEMENT_V1_0 | Whymper V1 | Y |
| Seats | List of seats | Detailed information on seats | D_SEATS_LIST_SEATS_V1_0 | Matterhorn V3 | Y |
| Tickets | Access control | Access control history | D_ACONTROL_TICKETCHECK_V1_0 | Piz Bernina V1 | Y |
| List of tickets | List of tickets | D_SHIPMENTTICKET_TICKETS_V1_0 | Matterhorn V3 | Y | |
| Tickets | Mobile ticket status | List of mobile tickets | D_MOBILE_TICKET_STATUS_V1_0 | Gabelhorn V1 | Y |
| Tickets | Mobile ticket transactions | List of mobile ticket transactions | D_MOBILE_TICKET_TRANS_V1_0 | Gabelhorn V1 | Y |
| Tickets | Questionnaires | Answers to questionnaires | D_SHIPMENTTICKET_QSTNR_V1_0 | Matterhorn V3 | Y |
| Visits | Guide planning | Guides availability | D_VISIT_GUIDE_AVL_V1_0 | Matterhorn V3 | Y |
| Visits | Visit planning | Visit planning | D_VISIT_PLANNING_DATA_V1_1 | Matterhorn V3 | Y |
Physical data model
Below graphs present the SecuTix BI domains and the interactions between these.
These graphs describe the way to navigate between domains.
- Sales and payments
For instance: From a ticket (D_SHIPMENTTICKET_TICKETS), it is possible to know all controls (D_ACONTROL_TICKETCHECK) of this ticket as well as the answers to potential questionnaire associated to this ticket (D_SHIPTMENTTICKET_QSTNR).
- Following links between two domains are not illustrated in the graph for clarity reasons but are available in order to simplify the access:
- Link between D_PAYMENT_OPERATION_LINK and D_CONCT_CULTURAL_HISTORY via T_OPERATION_ID. Cardinality: 0:n, 0:n
- Link between D_SALES_LIST_SALES and D_ACONTROL_TICKETCHECK via T_OPERATION_ID. Cardinality: 1:1, 0:n
- Link between D_PAYMENT_OPERATION_LINK and _ACONTROL_TICKETCHECK via T_OPERATION_ID. Cardinality: 0:n, 0:n
- Contact
For the contact schema, all the cardinalities are : D_contact_list 0:1 → 0:n other_table
- Lottery
- Configuration
- Goods
- Visits
In above graphs:
- Names starting by "T_" represent the fields allowing to navigate from one domain to another.
: indicates that each instance of the entity A is linked to 0 or several instances of B and each instance of B is linked to exactly one instance of A
- D_SHIPMENTTICKET_QSTNR
- D_GOODS_STATUS