Contents
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.
For installations information, please reference:
> ILINX Installation Guide – This is the Installation Guide for ILINX products.
> ILINX Support Matrix – This document lists the system requirements for each ILINX product.
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’
> (Optional): Select the ‘Enable date filtering’ checkbox. This will expand another section to configure date filtering options.
– Enter the ‘Title’ and select the ‘Position’ the title will be displayed.
– Select the ‘Default dates by’ from the dropdown. Options include:
» No defaults – no additional configurations
» Fixed Dates – Dynamically displays a date picker option to select the ‘Start date’ and ‘End date’.
»Relative dates – Dynamically displays options to enter the number of days ago to configure the ‘Start date’ and the number of days ahead in the ‘End date’.
– Select the ‘Limit dates by’ from the dropdown. Options include:
» No limits – no additional configurations
» Fixed Dates – Dynamically displays a date picker option to select the ‘Start date’ and ‘End date’.
»Relative dates – Dynamically displays options to enter the number of days ago to configure the ‘Start date’ and the number of days ahead in the ‘End date’.
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 or delete the highlighted dashboard, or select ‘Edit’ to add widgets to 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 add widgets to the configured 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.
– Select the ‘Data Field’ from the dropdown. This option requires the eForm to have one of the following fields on the form: Multiple Choice, Drop Down, Checkboxes, Matrix Choice.
> 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.
– Select the ‘Data Value’ from the dropdown. The options include: Batch status, Batches in process, User Productivity, Concurrent User, or System Transactions.
> 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.
– Select the ‘Data Value’ from the dropdown. This option requires the application selected to have a Picklist index field.
> Custom – Connections to a database.
Once the database connection is tested and successfully connected, an Example query is made available. Depending on the expected data to be displayed, enter the fields, table name, and smart fields such as [Current User Name]. The Current Username smart field will allow every user to see widgets/data specific to their activity within ILINX or external system.
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.
Editing Widget
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:
> Select a date field to respond to date filtering – If you enabled date filtering when creating the initial Dashboard, this dropdown allows you to select which date can be used to filter by.
> 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 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.
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 examples below.
Each Widget may be configured to best display the data expected.
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.