Detected BIQ Entities Report
Detected BIQ Entities report shows information about each and every detected Entity in BIQ applications (Searches, Widgets, Saved Metrics, Business Journeys, Experience Levels, Schemas and Fields).
Detected BIQ Entities report is produced when:
- Job file included at least one BIQ application Target.Type=
BIQ - Metadata is extracted via Input.DetectedEntities=
true - Report is requested via Output.DetectedEntities=
true
Detected BIQ Entities report has the following file name:
Report\Entities.BIQ.<Job File Name>.<Start Date and Time>-<End Date and Time>.xlsx
For example:
Entities.BIQ.demo2Ecommerce.2017091914-2017091916.xlsx
The data for the report is in the following files:
- Report\ENT\applications.csv
- Report\ENT\controllers.csv
- Report\ENTBIQ\applications.biq.csv
- Report\ENTBIQ\biqfields.csv
- Report\ENTBIQ\biqmetrics.csv
- Report\ENTBIQ\biqschemas.csv
- Report\ENTBIQ\biqsearches.csv
- Report\ENTBIQ\biqwidgets.csv
- Report\ENTBIQ\businessjourneys.csv
- Report\ENTBIQ\experiencelevels.csv
This sheet describes the parameters of the extraction and reporting job that produced this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| UserName | String | User that was used to retrieve data from the Controller |
| Application | String | Name of Application that was queried |
| ApplicationID | Integer | ID of Application in Controller |
| ApplicationType | String | Type of the Application |
This sheet provides quick access to the contents of this report and provides at-a-glance number of rows in each of the sheet's tables.
| Column | Data Type | Purpose |
|---|---|---|
| Sheet Name | String | Name of the sheet in the report |
| Num Entities | Integer | Number of Entities in that sheet |
| Link | Hyperlink | Link to the sheet in the report |
This sheet provides information about Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| Version | String | Version of the Controller |
| VersionDetail | String | Full version string of the Controller |
| NumApps | Integer | Number of All Applications registered in the Controller |
| NumAPMApps | Integer | Number of APM Applications registered in the Controller |
| NumWEBApps | Integer | Number of WEB Applications registered in the Controller |
| NumMOBILEApps | Integer | Number of MOBILE Applications registered in the Controller |
| NumIOTApps | Integer | Number of IoT Applications registered in the Controller |
| NumSIMApps | Integer | Number of SIM Applications registered in the Controller |
| NumBIQApps | Integer | Number of BIQ Applications registered in the Controller |
| NumDBApps | Integer | Number of DB Applications registered in the Controller |
| ControllerLink | URL | Link to Controller |
This sheet lists all Applications of any Type in all Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| ApplicationName | String | Name of Application |
| Description | String | Description of Application, if set |
| Type | String | Type of the Application |
| Types | Array | Types of Application in this application. Most commonly seen are APM and WEB grouped together |
| CreatedBy | String | Who created this Application |
| CreatedOn | Datetime | When the Application was created, local time |
| CreatedOnUtc | Datetime | When the Application was created, UTC time |
| UpdatedBy | String | Who updated this Application last |
| UpdatedOn | Datetime | When the Application was updated, local time |
| UpdatedOnUtc | Datetime | When the Application was updated, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| ParentApplicationID | Integer | ID of Parent Application. Used by MOBILE Applications |
This sheet provides information about all MOBILE Applications in all Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| ApplicationName | String | Name of Application |
| NumSearches | Integer | Number of BIQ Searches |
| NumMultiSearches | Integer | Number of BIQ Searches with multiple queries |
| NumSingleSearches | Integer | Number of BIQ Searches with single queries |
| NumLegacySearches | Integer | Number of BIQ Searches of legacy type |
| NumSavedMetrics | Integer | Number of BIQ Searches saved as Custom Metric |
| NumBusinessJourneys | Integer | Number of Business Journeys |
| NumExperienceLevels | Integer | Number of Experience Levels |
| NumSchemas | Integer | Number of schemas, built-in and custom |
| NumFields | Integer | Number of fields in schemas |
| ApplicationID | Integer | ID of Application in Controller |
| ControllerLink | URL | Link to Controller |
| ApplicationLink | URL | Link to Application in Controller |
This sheet provides information about all Searches in all Applications in all Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| ApplicationName | String | Name of Application |
| SearchName | String | Name of Search |
| Description | String | Description of Application |
| InternalName | String | Internal name of Search (GUID) |
| SearchType | String | Type of Search (MULTI, LEGACY42, SINGLE) |
| SearchMode | String | Mode of Search (BASIC, ADVANCED) |
| Visualization | String | Type of Visualization (AREA, CANVAS, LINE, NUMERIC, TABLE) |
| ViewMode | String | View mode of Visualization (VISUALIZATION, DATA) |
| DataSource | String | Schema that was queried |
| NumWidgets | Integer | Number of Widgets in the Search |
| Query | String | Query invoked by Search |
| CreatedBy | String | Username of the user who created this Search |
| CreatedOn | DateTime | When was Search created, local time |
| CreatedOnUtc | DateTime | When was Search created, UTC time |
| UpdatedBy | String | Username of the User who updated this Search |
| UpdatedOn | DateTime | When was Search updated, local time |
| UpdatedOnUtc | DateTime | When was Search updated, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| SearchID | Integer | ID of Search in Controller |
| ControllerLink | URL | Link to Controller |
| ApplicationLink | URL | Link to Application in Controller |
| SearchLink | URL | Link to Search in Controller |
This sheet uses data in 6.Searches sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Default configuration provides breakdown of BIQ Searches by Mode and Type with counts of Widgets.
| Columns | Rows | Values | Filters |
|---|---|---|---|
| SearchMode | |||
| SearchType | |||
| Controller | |||
| DataSource | |||
| SearchName | |||
| NumWidgets (Sum) | |||
| ViewMode |
Example report showing all Dashboards with word "Business" in BIQ Searches:
This sheet provides information about all Widgets in all Searches in all Applications in all Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| ApplicationName | String | Name of Application |
| SearchName | String | Name of Search |
| SearchType | String | Type of Search (MULTI, LEGACY42, SINGLE) |
| SearchMode | String | Mode of Search (BASIC, ADVANCED) |
| WidgetName | String | Name of Widget |
| InternalName | String | Internal name of Widget (GUID) |
| WidgetType | String | Type of Widget (AREA, COLUMN, FUNNEL, HISTOGRAM, LINE, NUMERIC, PERCENTILE, PIE, TABLE, TREEMAP) |
| LegendLayout | String | Legend layout (HORIZONTAL, VERTICAL) |
| DataSource | String | Schema that was queried |
| Query | String | Query invoked by Search |
| Resolution | Integer | Not sure what this is |
| Width | Integer | Width of Widget |
| Height | Integer | Height of Widget |
| MinWidth | Integer | Minimal width of Widget |
| MinHeight | Integer | Minimal height of Widget |
| Column | Integer | Column location of Widget in the grid |
| Row | Integer | Row location of Widget in the grid |
| IsStacking | Boolean | For Column type (WidgetType=COLUMN), whether columns are stacked |
| IsDrilledDown | Boolean | Is the widget drilled down |
| FontSize | Integer | Size of the Font |
| Color | String | Color of the Font/text (RGB) |
| BackgroundColor | String | Background color (RGB) |
| TimeRangeType | String | Type of time range (BEFORE_NOW, BETWEEN_TIMES) |
| TimeRangeDuration | Integer | Duration of the time (if TimeRangeType=BEFORE_NOW) |
| StartTime | Datetime | Search start time, local time |
| StartTimeUtc | Datetime | Search end time, UTC time |
| EndTime | Datetime | Search end time, local time |
| EndTimeUtc | Datetime | Search end time, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| SearchID | Integer | ID of Search in Controller |
| WidgetID | Integer | ID of Widget in Search |
| ControllerLink | URL | Link to Controller |
| ApplicationLink | URL | Link to Application in Controller |
| SearchLink | URL | Link to Search in Controller |
This sheet uses data in 7.Widgets sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Default configuration provides breakdown of BIQ Widgets in a BIQ Search by Type with counts of Widgets.
| Columns | Rows | Values | Filters |
|---|---|---|---|
| WidgetType | |||
| Controller | |||
| DataSource | |||
| SearchName | |||
| WidgetName | |||
| WidgetID (Count) | |||
| Resolution | |||
| IsStacking |
Example report showing all Widgets and their types in specific BIQ Search:
This sheet provides information about all Saved Searches that get turned into Metrics in all Applications in all Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| ApplicationName | String | Name of Application |
| MetricName | String | Name of Metric |
| MetricDescription | String | Description of Metrics |
| DataSource | String | Schema that was queried |
| EventType | String | Type of the event in the schema. Maps to DataSource |
| Query | String | Query invoked by Search |
| IsEnabled | Boolean | Is this Metric enabled |
| LastExecStatus | String | Status of last execution attempt |
| LastExecDuration | Integer | Duration of last execution, in milliseconds (?) |
| SuccessCount | Integer | Number of Successful executions of this Search to produce Metric |
| FailureCount | Integer | Number of Failed executions of this Search to produce Metric |
| CreatedBy | String | Who created this Metric |
| CreatedOn | Datetime | When the Metric was created, local time |
| CreatedOnUtc | Datetime | When the Metric was created, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| ControllerLink | URL | Link to Controller |
| ApplicationLink | URL | Link to Application in Controller |
| MetricLink | URL | Link to Metric Browser for this Metric |
This sheet uses data in 8.Saved Metrics sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Default configuration provides breakdown of Saved BIQ Metric by last Execution Status.
| Columns | Rows | Values | Filters |
|---|---|---|---|
| LastExecStatus | |||
| Controller | |||
| DataSource | |||
| MetricName | |||
| WidgetID (Count) | |||
| IsEnabled |
Example report showing all Metrics broken down by DataSource and with their LastExecStatus:
This sheet provides information about all Saved Searches that get turned into Metrics in all Applications in all Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| ApplicationName | String | Name of Application |
| JourneyName | String | Name of Business Journey |
| JourneyDescription | String | Description of Business Journey |
| State | String | Name of Business Journey |
| IsEnabled | Boolean | Is this Business Journey enabled |
| KeyField | String | Name of Business Journey |
| Stages | String | List of Business Journey Stages (Stage1->Stage2->Stage3) |
| NumStages | Integer | Number of Stages in Business Journey |
| CreatedBy | String | Username of the user who created this Business Journey |
| CreatedOn | DateTime | When was Business Journeycreated, local time |
| CreatedOnUtc | DateTime | When was Business Journeycreated, UTC time |
| UpdatedBy | String | Username of the User who updated this Business Journey |
| UpdatedOn | DateTime | When was Business Journey updated, local time |
| UpdatedOnUtc | DateTime | When was Business Journey updated, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| JourneyID | Integer | ID of Business Journey in Controller |
| ApplicationLink | URL | Link to Application in Controller |
| MetricLink | URL | Link to Metric Browser for this Metric |
This sheet uses data in 9.Business Journeys sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Default configuration provides breakdown of Business Journeys by their Key Field.
| Columns | Rows | Values | Filters |
|---|---|---|---|
| Controller | |||
| DataSource | |||
| JourneyName | |||
| WidgetID (Count) | |||
| NumStages | |||
| IsEnabled |
Example report showing all Business Journeys with Number of Stages=4:
