Contents
Have another version? ILINX version 8.6
About
The ILINX Capture Analytics product provides dashboard capabilities for visualizing ILINX Capture workflow statistics and data. The ILINX Analytics product adds more dashboard data sources including ILINX eForms, ILINX Content Store, and external databases.
System Requirements
For general information on supported and recommended hardware, OS, web browsers, databases etc. for ILINX products, please refer to the ILINX Support Matrix.
Operational Considerations and Limitations
ILINX Capture Platform is required as part of the installation for this product.
ILINX Capture Analytics is available as a part of ILINX Capture Platform and ILINX Flex.
ILINX Analytics requires specific licensing. Contact your Account Executive for details.
Configurations
New Dashboards
Step 1: Select the Dashboards option in the ILINX Capture Admin tab navigation panel. This will open a blank screen in the right panel with the option to create a new dashboard.
Step 2: Select the ‘New’ button at the bottom right of the screen.
Step 3: In the properties screen that opens, enter the ‘Dashboard Name’ and ‘Description’
> Select Graphical Dashboard option to display analytics data using graphical widgets.
> Select Report option to display data using formatted reports
Step 4: Select the ‘Save’ button. This will close the properties screen and redirect to the main list of configured Dashboards.
Edits
From the Dashboards option in the ILINX Capture Admin tab navigation panel, you can select to create a new dashboard, update the properties, delete the highlighted dashboard, or select ‘Edit’ to configure the highlighted dashboard.
> By highlighting a Dashboard from the list, select:
– ‘Properties’ button: Will open the screen where you may choose to change the Dashboard Name, Description, or date filtering options.
– ‘Delete’ button: Will open a confirmation box. Selecting ‘Yes’ will delete all related data and configurations and cannot be undone. Select ‘Cancel’ to not delete.
– ‘Edit’ button: Opens a screen to the configured dashboard.
» Graphical Dashboard – Opens window to select widgets to build your dashboards
» Reports – Opens window to configure data source information that will be included in the report.
Graphical Dashboard Widgets
Once a new Dashboard has been created, highlighting it and selecting the ‘Edit’ button will open a new window enabling you to create widgets that will be displayed on the Dashboard.
Note: ILINX Capture Analytics may only be configured using ILINX Capture Datasources. ILINX Analytics licensing may have other datasources configured including ILINX eForms, ILINX Content Store, as well as Custom database string connections.
Step 1: Select from the dropdown ‘Select Widget Type’ to determine the desired layout of the widget. Options include:
> Pie Chart – Displays the a legend for each data value associating the color of the part of the chart. Each part includes the percentage of total data represented. By hovering over any part of the chart, more data is displayed including value name, number of entries, and percentage represented in the overall chart.
> Donut Chart – Displays the a legend for each data value associating the color of the part of the chart. Each part includes the percentage of total data represented. By hovering over any part of the chart, more data is displayed including value name, number of entries, and percentage represented in the overall chart.
> Bar Chart – Displays each data value as a separate bar and includes the percentage of total data represented. The data value type is at the bottom of the chart. By hovering over any part of the chart, more data is displayed including value name and number of entries.
> Line Chart – Displays each value as part of a line with data points representing each specific value as bullets in the graph. This option is good to use with the ‘Date filtering’ option enabled when you configured the initial Dashboard. By hovering over any bullet point on the chart, more data is displayed including value name and number of entries.
> Area Chart – Displays each value as part of a line with data points representing each specific value as vertical lines. This option is good to use with the ‘Date filtering’ option enabled when you configured the initial Dashboard. By hovering over any vertical line on the chart, more data is displayed including value name and number of entries.
> Entries Grid – Displays a grid chart of data based on the values selected. All data will be displayed within this Widget for each data point.
Step 2: Enter the ‘Widget Title’. This will be located at the top of the widget.
Step 3: Select the ‘Datasource’ from the dropdown.
> ILINX eForm
– Select the ‘Batch profile’ from the dropdown. Only Batch Profiles that have an eForm enabled and configured will display as an option.
– Select the ‘eForm’ from the dropdown. Each Batch profile may have multiple eForms configured.
– Configure the categories and values to be displayed:
» Category Field / Horizontal Axis
» Number of Categories (Option to show remaining values as “other”)
» Value Field / Vertical Axis
» Value Operation
» Sort by (ascending or descending)
Note: If eform fields are being replaced, it is recommended that you add the new field before deleting the old to verify the widget will collect data from the new widget.
The following form fields are not available to include in a grid or report:
-
- signature
-
digital signature
-
button
- image
- table
- columns/row_element
- label
- file upload
- section break
- page break
> ILINX Capture – Note: This is the only datasource available with ILINX Capture Analytics. Contact your Account Executive for other ILINX Analytics datasource options.
– Select the ‘Batch profile’ from the dropdown.
– Configure the categories and values to be displayed.
» Category Field / Horizontal Axis
» Number of Categories (Option to show remaining values as “other”)
» Value Field / Vertical Axis
» Value Operation
» Sort by (ascending or descending)
> ILINX Content Store –
– Select the ‘Application’ from the dropdown. Note: Only Applications that are NOT linked with an ILINX Capture Batch Profile will be displayed.
– Configure the categories and values to be displayed.
» Category Field / Horizontal Axis
» Number of Categories (Option to show remaining values as “other”)
» Value Field / Vertical Axis
» Value Operation
» Sort by (ascending or descending)
> ILINX Content Store Views –
– Select the ‘Application’ from the dropdown.
– Configure the categories and values to be displayed.
» Category Field / Horizontal Axis
» Number of Categories (Option to show remaining values as “other”)
» Value Field / Vertical Axis
» Value Operation
» Sort by (ascending or descending)
Step 4: Click the ‘Save Widget’ button.
You will be returned to the Dashboard Widget window. Multiple Widgets may be added by selecting the ‘Add widget’ button. Follow the same steps above to create a new widget.
Edit Options
From the Dashboards Widget window, you can highlight a sample widget and select the ‘Edit’ button. This will open the ‘Editing widget #X’ window (where X represents the widget number on the screen).
Different configuration options will be available depending on your specific configurations (ie, Pie Chart using Checkboxes, eForms using a Line Chart, etc.). Some common configurations include:
> Theme – Widgets have a number of built-in color themes. Also for darker backgrounds, suggestions are available.
> Background Color – Available as part of the theme are the background colors. Using a Hex number or select the desired color from the HTML Color Picker.
> Show Title – Selecting this option will display the Title that was entered when creating the Widget. Also gives the ability to select the Position and Alignment.
> Show Labels – Depending on the type of chart and source, you can select the Template to use to display the Labels. Also gives the ability to select the Position and Alignment.
> Show Legend – Select the Position where the Legend is displayed.
> Show Tooltips – Tooltips are the message boxes that appear when the mouse hovers over a particular section of the chart. These can be adjusted as desired.
> Widget Height – The Widget may be displayed as Small, Medium, or Large, or configuring a custom height in the Height box.
Once you have finished these settings, click the ‘Save’ button.
Edit Query
Selecting this option will open the widget configuration window again where you can make changes to the query Datasources and Category and values that are displayed.
Layout
Once all of your dashboards have been configured, select the ‘Layout’ button from the Dashboards Widget window. Some widgets may require a wider area to be displayed correctly. The Edit Widget section allows you to change the height of the Widget however, here you can change the width by: 1 x 1, 1 x 2, or 1 x 3. See example below. Each Widget may be configured to best display the data expected.
Analytics Report Dashboard
Once a new Report Dashboard has been created, highlighting it and selecting the ‘Edit’ button will open a new window enabling you to select the datasource information that will be displayed on the Dashboard.
Note: ILINX Capture Analytics may only be configured using ILINX Capture Datasources. ILINX Analytics licensing may have other datasources configured including ILINX eForms, ILINX Content Store, as well as Custom database string connections.
Step 1: Enter the ‘Widget Title’. This will be located at the top of the report.
Step 2: Select the ‘Datasource’ from the dropdown.
> ILINX eForm
– Select the ‘Batch profile’ from the dropdown. Only Batch Profiles that have an eForm enabled and configured will display as an option.
– Select the ‘eForm’ from the dropdown. Each Batch profile may have multiple eForms configured.
All values will be displayed at this time. To select individual fields by selecting Edit Options after the report is created.
Note: If eform fields are being replaced, it is recommended that you add the new field before deleting the old to verify the widget will collect data from the new widget.
The following form fields are not available to include in a grid or report:
-
- signature
- digital signature
- button
- image
- table
- columns/row_element
- label
- file upload
- section break
- page break
> ILINX Capture – Note: This is the only datasource available with ILINX Capture Analytics. Contact your Account Executive for other ILINX Analytics datasource options.
– Select the ‘Batch profile’ from the dropdown. All values will be displayed at this time. To select individual fields by selecting Edit Query after the report is created.
All values will be displayed at this time. To select individual fields by selecting Edit Options after the report is created.
> ILINX Content Store –
– Select the ‘Application’ from the dropdown. Note: Only Applications that are NOT linked with an ILINX Capture Batch Profile will be displayed.
All values will be displayed at this time. To select individual fields by selecting Edit Options after the report is created.
> ILINX Content Store Views –
– Select the ‘Application’ from the dropdown. This can also be used to collect data from custom data sources such as other tables or databases as necessary. Selecting “Data View” within the Views settings as well as using the method GetAllDataViewNames will allow dashboards to display the appropriate fields as desired.
All values will be displayed at this time. To select individual fields by selecting Edit Options after the report is created.
> Custom – Connections to the statics tables created when selecting “Enable statistics” in the ILINX Capture batch profile.
Step 3: Click the ‘Save Widget’ button.
Step 4: You will be returned to the Dashboard Widget window. Multiple Widgets may be added by selecting the ‘Add widget’ button. Follow the same steps above to create a new widget.
Edit Options
From the Dashboards Widget window, you can highlight a Report and select the ‘Edit’ button. Next Select the ‘Edit Options’ button to open the Edit Report Dashboard window. Different configuration options will be available depending on your specific Report configurations. Some common configurations include:
> Select User Filtering Options
– No filtering – Disables filtering for users.
– Filtering context menu – Allows users to select filter options from context menus.
– Filtering row – Adds filter field for sorting live reports.
– Allow drag & drop grouping – Allows users to configure grouping options within the live report.
> Theme – The Reports have a number of built-in color themes. Also for darker backgrounds, suggestions are available.
> Show Title – Selecting this option will display the Title that was entered when creating the Report. Also gives the ability to select the Position and Alignment.
> Rows Per Page – Enter the maximum rows to be displayed per page.
> Max Char Length – Enter the maximum character length.
> Select fields to be displayed – The list of fields that are available to be displayed in the Report are available. Select the desired fields to be displayed.
> Default sorting order – Select from the dropdown which fields to default sort the report either ascending or decending.
Once you have finished these settings, click the ‘Save’ button.
Edit Query
Selecting this option will open the Edit Widget Query configuration window, where you can make changes to the query Datasources and Category and values that are displayed.
Permissions
The Dashboard Permissions option allows you to determine which user groups have access to certain views. For a single batch profile, you can, for example, have two user groups and assign a view to each, and each user group will see a completely different set of data in their respective view. NO other permissions are related to Dashboard permissions. Permissions for Views, Human Activities, eForms, etc. are all not related however data may be used within the Dashboard Widget without permissions assigned to those modules.
To set the permissions for a view:
Step 1: From the Admin tab, click Dashboard Permissions. Select your desired dashboard from the drop-down menu and click Add.
Step 2: Click the check boxes next to the user group(s) for which you want to assign permissions, then click OK.
Step 3: On the right side of the page, select Can view dashboard to allow the users in this group to use the dashboard.
Step 4: Once you are satisfied with your selections, click Save.
Accessing Dashboards
ILINX Capture
Dashboards can be accessed within ILINX Capture under the Dashboards tab. Once a dashboard is configured and permissions assigned, the user group will be able to access the dashboard as desired.
Multiple dashboards may be configured and assigned. The User will see the list of assigned dashboards in the left panel once the Dashboard tab is selected.
If the Filter date option is enabled, Users can select the dates the Widgets will use to filter. Entering the dates or using the date pickers, then select the ‘Update Dashboard’ button will filter the results in the widgets based on the dates selected.
At the bottom of the Dashboard Tab main panel are a ‘Refresh’ and ‘Download’ buttons.
> Refresh – Allows user to update the data with new information as necessary.
> Download – Downloads a PDF version of the widgets and data presented. Note: All rows will be included in the downloaded pdf if the Entries Grid Widget is used.
ILINX Flex
ILINX Analytics dashboards can be accessed within ILINX Flex. All dashboard configurations and permission assignments are still set within ILINX Capture. Once all is configured and permissions assigned, the user group will be able to access the dashboard as desired within ILINX Flex.
Multiple dashboards may be configured and assigned. The User will see the list of assigned dashboards under the Dashboards option in the left panel. Expand ‘Dashboards’ to see full list.
If the Filter date option is enabled, Users can select the dates the Widgets will use to filter. Entering the dates or using the date pickers, then select the ‘Update Dashboard’ button will filter the results in the widgets based on the dates selected.
When using the Entries Grid widget, columns can be filter based on values of the given column. User can also select all or clear all selected.
At the bottom of the Dashboard screen are a ‘Refresh’ and ‘Download’ buttons.
> Refresh – Allows user to update the data with new information as necessary.
> Download – Downloads a PDF version of the widgets and data presented. Note: All rows will be included in the downloaded pdf if the Entries Grid Widget is used.