Fullscreen Image

Manage Dashboard Reports - Company Administration

The Manage Dashboard Reports section of the System Administrator Dashboard is where you manage your dashboard reports. The Dashboard Reports widget displays these reports in your Dashboard. Dashboard reports use a simplified version of the Lucernex Report Builder.

If you would prefer to add a shortcut to an existing report on your Dashboard rather than creating a dashboard report, use the My Favorite Reports widget.

Dashboard reports are intended to be lightweight. You MUST use filters in Step 4 of the Dashboard Report Builder to limit the initial dataset wherever possible. You can also use search / runtime filters for all fields you intend to actively filter.

To navigate to the Manage Dashboard Reports page:

  1. Click Admin in the toolbar in the upper-right corner of the window.

    The System Administrator Dashboard page opens.

  2. Click Manage Dashboard Reports link in the Company Administration column.

    The Manage Dashboard Reports page opens.

  3. Follow a procedure below.

ClosedCreate a Report

Dashboard reports use a simplified version of the Lucernex Report Builder.

To create a dashboard report:

  1. Click Create Report.

    Step 1 of the Dashboard Report Builder opens in a window.

  2. Follow a procedure below.

ClosedStep 1: A Report About What?

To specify the contents of your report:

  1. Do one of the following:

    • If you want to create a report from scratch:

      1. Select the option you want from the First Select column.

        • Entity Filters: Build a detailed report about entities in your portfolio. For example, you could create a report that gave you expense data for all of the contracts in your portfolio.

        • Forms: Build a report about data related to forms and work flows utilized by members of your firm.

        • Budget: Build a report about budget line items or category codes.

        • Company Report: Build a report about your company's data in Lucernex. For example, you could create a report to help you view the security settings of members on a project.

      2. Select either the Active or Inactive check boxes from the Then Select column to include active or inactive entities from the provided options.

    • If you want to base your report on a pre-existing dashboard report:

      1. Select the Start from an existing report option.

      2. Select the existing report you want to base your report upon from the Start from an existing report field.

  2. Click Next.

    The Step 2: Geographic Restrictions page of the Dashboard Report Builder opens.

ClosedStep 2: Geographic Restrictions

If you are basing your report on an existing report, the system may skip this step.

Filtering by Portfolio in this step is typically used when you want to impose a hard restriction on the report that you don't want users to change. This method is most commonly used for integrations, scheduled reports, and portfolio-specific reports.

To filter your report by a geographic area:

  1. Select the option for the category of geographic restriction you want to apply.

    Example restrictions include Portfolio, Region, and Sub Region.

    The available filters appear in the This list will be limited based on the selected filters below field.

  2. Select the filters you want to apply.

    Press and hold CTRL on your keyboard to select multiple values.

  3. Click Add Filter.

    The filters you select will appear in the Reports will be limited to data section of the window.

    To remove a filter, click Remove link.

  4. Click Next.

    The Step 3: Select Data Group and Fields page of the Dashboard Report Builder opens.

ClosedStep 3: Select Data Group and Fields

Avoid pulling fields from unrelated tables as your report will generate too many results. However, it is common to pull fields from tables that have directly related parent-child relationships. For example, a report might pull from the Contract, Expense Setup, and Expense Schedule tables, which are Parent, Child, and Grandchild tables, respectively.

To add data fields to your report:

  1. Do one of the following:

    • Type the name of the field in the Search field.

    • Click the folders in the column on the left side of the page to open sub-folders.

  2. Double-click the field name to add it to the Fields included in report field.

  3. Repeat steps 1 - 2 until you have added all fields you want to include in your report.

    To remove a field, select the field from the Fields included in report and click Remove Selected.

  4. Click Next.

    The Step 4: Field Detail and Criteria page of the Dashboard Report Builder opens.

ClosedStep 4: Field Detail and Criteria

The Step 4: Field Detail and Criteria page of the Dashboard Report Builder allows you to configure how field data appears in the widget, and allows you to add custom fields to your reports.

Clicking the Delete link in the Actions column of a field will delete the field from your report. You can re-add the field by clicking the < < Previous at the bottom of the window, and following the Step 3: Select Data Group and Fields procedures above.

Dashboard reports are intended to be lightweight. You MUST use filters in Step 4 to limit the initial dataset wherever possible. You can also use search / runtime filters for all fields you intend to actively filter.

ClosedEdit Your Field Details and Criteria

The fields that appear on the Field Details page will differ depending upon the data type of your field.

To configure your field details and criteria:

  1. Click Edit in the Actions column of the record.

    The Edit Item window opens.

  2. Make your changes.

    The available options are described below:

    • Select the filter criteria you want from the Criteria / Conditions field.

      • Is any value: Include any value in the results.

      • Is in: Only include values in the range you specify in the results.

      • Is not in: Only include values not in the range you specify in the results.

      • Is not specified: Only include results where the record does not have a value in the field.

      • Is specified: Only include results where the record has a value in the field.

      • not selected: Only include results where the value is No.

      • selected: Only include results where the value is Yes.

      • search / runtime filter: Prompt the user to specify a filter for this field when they run the report.

    • Select the appropriate field conditions from the Criteria / Conditions field.

      You can enter multiple conditions to a field - for example, the value is greater than 1,000 but less than 5,000.

      The following conditions can be applied to a field:

      • = Equals

      • < > Less than or greater than

      • > Greater than

      • > = Greater than or equal to

      • < Less than

      • < = Less than or equal to

    • Select or clear the following:

      • Do one of the following:

        • Show Field Count on Report: Display number of instances of the field on the report.

        • Show Field Value on Report: Display the value of the field on the report.

      • Show Total Field Count in End Column: Add an additional column to the end of the report that displays the number of instances of the field in the report for that row.

      • Show Total Value for Groups / Report Bottom: Add a row for the total of the group below each group, and a grand total at the bottom of the report.

      • Show Avg value for Groups / Report Bottom: Add a row for the average of the group below each group, and an overall average at the bottom of the report.

    • Select whether to display all values and ignore a date range, or display by an effective date from the Show field by field.

    • Select or clear the following check boxes:

      • Accept HTML: Allow HTML formatting for this field.

      • Hide Decimals: Hide decimal values for this field.

    • Do one of the following:

      • Select the Yes option for the Field view wrap setting if you would like to wrap the text in the field.

      • Select the No option for the Field view wrap setting if you do not want to wrap the text in the field.

    • To filter by a field's attribute value:

      This functionality allows you to select alternate field values from a foreign table. This gives you increased abilities to filter data in your reports.

      1. Select the Show [Field Name] Value check box at the bottom of the window.

        The field to the right of the Show [Field Name] Value check box becomes active.

      2. Select the value you want to filter by from the field.

        A message appears that reads: Please click update to enable selection of criteria.

      3. Click Update.

        The window closes.

        The field will now be sorted in the table according to the field name you selected from the field.

      4. Click Edit in the Actions column of the record.

        The Edit Item window opens.

      5. Use the criteria / conditions filters to filter your report according to the field you selected.

        The available filters differ depending on the data type of the field by which you are filtering.

      6. Click Update.

        The window closes.

    • (DROP-DOWN DATA TYPE ONLY) Select one of three display options under the Show label:

      • Name

      • Description

      • Both

    • (DATE DATA TYPE ONLY) If you would like the date to appear in YYYY-MM-DD format, select the Date Format YYYY-MM-DD check box.

    • If you would like to have decimals displayed for this field, select the number of decimals you want displayed from the Number of Decimals field.

    • (CURRENCY DATA TYPE ONLY) If you would like the year to display in the header rather than the field name, select the Show Year for Label when Report Runs check box.

      This option is only available for fields in certain reports, such as the FASB Minimum Lease Obligation Report.

  3. Click Update.

    The window closes. Your changes are saved.

ClosedAdd a Mathematical Operations Field

To add a mathematical operations field to your report:

  1. Click Add a mathematical operations field link below the Field Name on Report column.

    The Create Math Field window opens.

  2. Enter the name of the field in the Field name on report field.

  3. Select from the following options to specify what type of values will appear in the field:

    • Number

    • Currency

    • Percentage

  4. Build your mathematical operation.

    You can build your mathematical field using three components: other fields, numeric constants, and operations.

    • As you use fields and numeric constants, click the operations buttons to add them to the Current operation field.

    • To move a field from the Available fields to the Current operation field:

      1. Select the field you want to use in the Available fields field.

      2. Click > > in the center of the window.

        The field is moved from the Available fields to the Current operation field.

    • To add a numeric constant to your operation:

      Note:

      A numeric constant is a number that does not change.

      1. Enter the number value you want to add to your current operation in the Numeric Constant field.

      2. Click > > to the right of the Numeric Constant field.

        The number is moved from the Numeric Constant to the Current operation field.

    • To add a new field to your Available fields field:

      1. Select the table from the first field under the Add Entity Field label.

      2. Select the sub-table from the second field under the Add Entity Field label.

      3. Select the field from the third field under the Add Entity Field label.

      4. Click > > below the Add Entity Field label.

        The field is added to the Current operation field.

  5. Click Submit.

    The Details pane of the Create Math Field window opens.

  6. Select the filter criteria you want from the Criteria / Conditions field.

    • Is any value: Include any value in the results.

    • Is in: Only include values in the range you specify in the results.

    • Is not in: Only include values not in the range you specify in the results.

    • Is not specified: Only include results where the record does not have a value in the field.

    • Is specified: Only include results where the record has a value in the field.

    • not selected: Only include results where the value is No.

    • selected: Only include results where the value is Yes.

    • search / runtime filter: Prompt the user to specify a filter for this field when they run the report.

  7. Select the appropriate field conditions from the Criteria / Conditions field.

    You can enter multiple conditions to a field - for example, the value is greater than 1,000 but less than 5,000.

    The following conditions can be applied to a field:

    • = Equals

    • < > Less than or greater than

    • > Greater than

    • > = Greater than or equal to

    • < Less than

    • < = Less than or equal to

  8. Select or clear the following check boxes:

    • Do one of the following:
      • Show Field Count on Report: Display number of instances of the field on the report.

      • Show Field Value on Report: Display the value of the field on the report.

    • Show Total Field Count in End Column: Add an additional column to the end of the report that displays the number of instances of the field in the report for that row.

    • Show Total Value for Groups / Report Bottom: Add a row for the total of the group below each group, and a grand total at the bottom of the report.

    • Show Avg value for Groups / Report Bottom: Add a row for the average of the group below each group, and an overall average at the bottom of the report.

  9. Select whether to display all values and ignore a date range, or display by an effective date from the Show field by field.

  10. Select or clear the following check boxes:

    • Accept HTML: Allow HTML formatting for this field.

    • Hide Decimals: Hide decimal values for this field.

  11. Do one of the following:

    • Select the Yes option for the Field view wrap setting if you would like to wrap the text in the field.

    • Select the No option for the Field view wrap setting if you do not want to wrap the text in the field.

  12. If you would like to have decimals displayed for this field, select the number of decimals you want displayed from the Number of Decimals field.

  13. If you need to edit your mathematical operation, click Edit link under the Mathematical operations heading.

  14. Click Submit.

    The window closes. Your new field appears in the Report Builder window.

ClosedAdd a Date Expression

To build a date expression field:

  1. Click Add a date expression link below the Field Name on Report column.

    The Create Date Expression window opens.

  2. Enter a name for the field in the Field name on report field.

  3. Choose between three options:

    • To create a date expression for a difference between two dates:

      1. Select the Difference in days option.

      2. Select the date you want to subtract from, from the first field.

      3. Select the date you want to subtract from the first date from the second field.

    • To create a date expression for a date plus a fixed number of days:

      1. Select the Add Days option.

      2. Select the date you want to add days to from the field.

      3. Enter the number of days you want to add in the field to the right of the field.

    • To create a date expression for a date minus a fixed number of days:

      1. Select the Subtract Days option.

      2. Select the date you want to subtract days from the field.

      3. Enter the number of days you want to subtract in the field to the right of the field.

  4. Click Submit.

    The Details pane of the Create Date Expression window opens.

  5. Select the filter criteria you want from the Criteria / Conditions field.

    • Is any value: Include any value in the results.

    • Is in: Only include values in the range you specify in the results.

    • Is not in: Only include values not in the range you specify in the results.

    • Is not specified: Only include results where the record does not have a value in the field.

    • Is specified: Only include results where the record has a value in the field.

    • not selected: Only include results where the value is No.

    • selected: Only include results where the value is Yes.

    • search / runtime filter: Prompt the user to specify a filter for this field when they run the report.

  6. Select the appropriate field conditions from the Criteria / Conditions field.

    You can enter multiple conditions to a field - for example, the value is greater than 1,000 but less than 5,000.

    The following conditions can be applied to a field:

    • = Equals

    • < > Less than or greater than

    • > Greater than

    • > = Greater than or equal to

    • < Less than

    • < = Less than or equal to

  7. Select or clear the following check boxes:

    • Show Total Value for Groups / Report Bottom: Add a row for the total of the group below each group, and a grand total at the bottom of the report.

    • Show Avg value for Groups / Report Bottom: Add a row for the average of the group below each group, and an overall average at the bottom of the report.

    • Accept HTML: Allow HTML formatting for this field.

    • Hide Decimals: Hide decimal values for this field.

  8. Do one of the following:

    • Select the Yes option for the Field view wrap setting if you would like to wrap the text in the field.

    • Select the No option for the Field view wrap setting if you do not want to wrap the text in the field.

  9. If you need to edit your date expression, click Edit link under the Date expression heading.

  10. Click Submit.

    The window closes. Your new date expression field appears in the Report Builder window.

ClosedAdd a Time Expression

To build a time expression field:

  1. Click Add a time expression link below the Field Name on Report column.

    The Create Time Expression window opens.

  2. Enter a name for the field in the Field name on report field.

  3. Choose between three options:

    • To create a time expression for a difference between two times:

      1. Select the Difference in hours option.

      2. Select the date you want to subtract from, from the first field.

      3. Select the date you want to subtract from the first date from the second field.

    • To create a time expression for a date plus a fixed number of days:

      1. Select the Add Days option.

      2. Select the date you want to add days to from the field.

      3. Enter the number of days you want to add in the field to the right of the field.

    • To create a time expression for a date minus a fixed number of days:

      1. Select the Subtract Days option.

      2. Select the date you want to subtract days from the field.

      3. Enter the number of days you want to subtract in the field to the right of the field.

  4. Click Submit.

    The Details pane of the Create Time Expression window opens.

  5. Select the filter criteria you want from the Criteria / Conditions field.

    • Is any value: Include any value in the results.

    • Is in: Only include values in the range you specify in the results.

    • Is not in: Only include values not in the range you specify in the results.

    • Is not specified: Only include results where the record does not have a value in the field.

    • Is specified: Only include results where the record has a value in the field.

    • not selected: Only include results where the value is No.

    • selected: Only include results where the value is Yes.

    • search / runtime filter: Prompt the user to specify a filter for this field when they run the report.

  6. Select the appropriate field conditions from the Criteria / Conditions field.

    You can enter multiple conditions to a field - for example, the value is greater than 1,000 but less than 5,000.

    The following conditions can be applied to a field:

    • = Equals

    • < > Less than or greater than

    • > Greater than

    • > = Greater than or equal to

    • < Less than

    • < = Less than or equal to

  7. Select or clear the following check boxes:

    • Show Total Value for Groups / Report Bottom: Add a row for the total of the group below each group, and a grand total at the bottom of the report.

    • Show Avg value for Groups / Report Bottom: Add a row for the average of the group below each group, and an overall average at the bottom of the report.

    • Accept HTML: Allow HTML formatting for this field.

    • Hide Decimals: Hide decimal values for this field.

  8. Do one of the following:

    • Select the Yes option for the Field view wrap setting if you would like to wrap the text in the field.

    • Select the No option for the Field view wrap setting if you do not want to wrap the text in the field.

  9. If you would like to have decimals displayed for this field, select the number of decimals you want displayed from the Number of Decimals field.

  10. If you need to edit your time expression, click Edit link under the Time expression heading.

  11. Click Submit.

    The window closes. Your new time expression field appears in the Report Builder window.

ClosedAdd a JavaScript Expression Field

To create a JavaScript expression field:

  1. Click Add a JavaScript expression field link below the Field Name on Report column.

    The Create Script Field window opens.

  2. Select the table this field will be associated with from the Table Association field.

  3. Enter a name for the script in the Script Name field.

  4. Select the type of return data this field will provide from the Return Data Type field.

    The options in this field are:

    • Boolean

    • Date

    • Money

    • Number

    • Text

  5. Select the Show Evaluated Script check box if you want JavaScript with substituted parameters to be returned, rather than the evaluated value.

  6. Enter the JavaScript code in the JavaScript Code field.

  7. Click Add Field.

    The Details pane of the Create Script Field window opens.

  8. Enter the name of the field in the Field Name on Report field.

  9. Select the filter criteria you want from the Criteria / Conditions field.

    • Is any value: Include any value in the results.

    • Is in: Only include values in the range you specify in the results.

    • Is not in: Only include values not in the range you specify in the results.

    • Is not specified: Only include results where the record does not have a value in the field.

    • Is specified: Only include results where the record has a value in the field.

    • not selected: Only include results where the value is No.

    • selected: Only include results where the value is Yes.

    • search / runtime filter: Prompt the user to specify a filter for this field when they run the report.

  10. Select the appropriate field conditions from the Criteria / Conditions field.

    You can enter multiple conditions to a field - for example, the value is greater than 1,000 but less than 5,000.

    The following conditions can be applied to a field:

    • = Equals

    • < > Less than or greater than

    • > Greater than

    • > = Greater than or equal to

    • < Less than

    • < = Less than or equal to

  11. Select or clear the following check boxes:

    • Show Total Value for Groups / Report Bottom: Add a row for the total of the group below each group, and a grand total at the bottom of the report.

    • Show Avg value for Groups / Report Bottom: Add a row for the average of the group below each group, and an overall average at the bottom of the report.

    • Accept HTML: Allow HTML formatting for this field.

    • Hide Decimals: Hide decimal values for this field.

  12. Do one of the following:

    • Select the Yes option for the Field view wrap setting if you would like to wrap the text in the field.

    • Select the No option for the Field view wrap setting if you do not want to wrap the text in the field.

  13. If you would like to have decimals displayed for this field, select the number of decimals you want displayed from the Number of Decimals field.

  14. If you need to edit your JavaScript, click Edit link under the JavaScript expression heading.

  15. Click Submit.

    The window closes. Your new JavaScript field appears in the Report Builder window.

Once you are satisfied with the fields on your report, click Next.

The Step 6: Choose Grouping and Sorting page of the Dashboard Report Builder opens.

Note:

Dashboard reports do not utilize Step 5: Choose Filters of the Lucernex Report Builder, so the system skips this step.

ClosedStep 6: Choose Grouping and Sorting

To group and sort your data in a report:

  1. Click Add.

    The Add window opens.

  2. Select the field you want to sort by from the Sort by field.

  3. Select the sort option you want:

    • Sort Descending: Sort the values in your report in descending order based upon the value of this field for the item.

    • Sort across Entities: Sort the values in your report across entity types.

  4. Click Add.

    The window closes. The grouping or sorting field is added to the table.

  5. Repeat steps 1 - 4 to add additional grouping or sorting fields to your report.

  6. To reorganize your grouping or sorting fields, click either the Up Arrow A small gray button with an upwards-facing arrow on it. or the Down Arrow A small gray button with a downwards-pointing arrow on it. in the column to left of the Field Name column.

    The field moves either up or down the list.

  7. To edit a grouping or sorting field:

    1. Click Edit in the Actions column of the record.

      The Edit Item window opens.

    2. Make your changes.

    3. Click Update.

      The window closes. Your changes are saved.

  8. To delete a grouping or sorting field:

    1. Click Delete in the Actions column of the record.

      A dialog opens, asking you to confirm your choice.

    2. Click Yes.

      The grouping or sorting field is deleted. It no longer appears on the page.

  9. Click Next.

    The Step 7: Choose the View Type and Currency page of the Report Builder opens.

ClosedStep 7: Choose the View Type and Currency

You cannot change the View Type of a dashboard report, as it is intended to only appear on the Dashboard.

To configure your view and currency settings:

  1. Select the appropriate currency from the Currency field.

    This field will convert currencies based upon the exchange rate specified at the firm-level. If there is no exchange rate specified at the firm level, the Dashboard Report Builder will use the exchange rate listed for the specified currency on Fixer.io.

  2. Select the Display multiple values in separate cells check box to have fields with multiple values display each value in a separate cell.

    This will create separate lines for each piece of data. If you clear this check box, the data will all appear in the same row.

  3. Click Next.

    The Step 8: Layout the Report page of the Report Builder opens.

ClosedStep 8: Layout the Report

If you created your report based upon an existing report, the layout may already be configured.

To configure your report layout:

  1. Select the option you want:

    • Show group nested: Select if you have grouped data fields and want to nest the data based on your group hierarchy. This adds columns and rows to the report.

    • Show group side-by-side: Select if you have grouped data fields and want to group the data side-by-side in the layout. This adds columns to the report.

    • Show group in first column: Select if you have grouped data fields and want to group data within the first column of the report. This adds rows to the report.

  2. Select the first field you want to add to your report from the top field on the right side of the window.

    Once you select a field, it will appear in your layout.

  3. To configure the field in your report:

    • To add an additional field prior to the existing field, click A small gray button with an ellipses on it. at the top-left corner of the field cell.

    • To delete the field, click A small gray button with a black x in the center. in the field cell.

    • To align cell data, click:

      • Left-Align: Align the contents of your field to the left.

      • Center-Align: Center-align the contents of your field.

      • Right-Align: Align the contents of your field to the right.

    • To toggle text wrapping on and off, click the link to the right of the alignment buttons in the cell:

      • Click Wrap to toggle text wrapping on in the cell.

      • Click Fit to toggle text wrapping off in the cell.

    • To change how a field appears on a page:

      1. Click A small square gray button with an ellipses on it. to the right of the alignment buttons.

        Note:

        This may also appear on the field label.

        A window opens. There are several aspects of the field that you can modify, such as the field name on the report, the criteria / conditions, and the display options.

      2. Make your changes.

        For guidance on the changes you can make to the configuration of a field on a report, see the Edit Your Field Details and Criteria section above.

      3. Click Update.

        The window closes.Your changes are saved.

  4. Repeat steps 2 - 3 for all the fields you want to add to your report.

  5. Click Next.

    The Step 9: Modify and Save the Report page opens.

ClosedStep 9: Modify and Save the Report

The final step in the Report Builder is also the page which opens when you click Edit link on the Manage Dashboard Reports page. This step allows you to access all previous steps in the Report Builder, save your report, schedule your report to run, and to run your report.

Note:

Dashboard reports are always available for everyone in your company.

To modify and save your report:

  1. Enter a title for the report in the Report Title field.

  2. Enter a description of the report in the Report Description field.

  3. If you need to make changes to the report, click Edit link next to the appropriate step.

    The system returns you to the step.

  4. Click Save.

    The window refreshes. Your report is saved, and appears on the Manage Dashboard Reports page.

ClosedEdit a Report - Old Report Builder

To edit a dashboard report:

  1. Click Edit-old link in the Actions column of the record.

    Step 9 of the Dashboard Report Builder opens.

  2. Click Edit link next to the step you want to make changes to.

  3. Make your changes.

  4. Click Finish.

    Step 9 of the Dashboard Report Builder opens.

  5. Click Save.

    The page refreshes. Your changes are saved.

  6. Click the system Close to close the Dashboard Report Builder.

ClosedEdit a Report - New Report Builder

To edit a dashboard report using the new Report Builder:

  1. Click Edit in the Actions column of the record.

    The Report Builder opens.

  2. Edit your report.

ClosedDelete a Report

To delete a dashboard report:

  1. Click Delete in the Actions column of the record.

    A dialog opens, asking you to confirm your choice.

  2. Click Yes.

    The dialog box closes. The page refreshes, and your report is deleted.

ClosedExport a Report

To export a dashboard report to an . xml file:

  1. Click Export link in the right-most column of the dashboard report you want to export.

    A system download dialog box opens.

  2. Do one of the following:

    • Open the file with a XML editor software.

    • Save the file to your computer.

Add a Dashboard Report to the Dashboard

Manage Dashboard Report Security