Introduction

Scope

The purpose of this manual is to provide instructions to configure and use the PAL Dashboard Administration module.

Overview

PAL Dashboard Administration is a module of the PAL Configuration application that is used to configure the Dashboard module.  

Prerequisites

Before proceeding with the configuration, it is necessary to have the FOIAXpress and PAL applications installed and configured on the application server.

Dashboard Administration

The PAL Dashboard module shows an at-a-glance graphical presentation of the current status (snapshot) and historical trends of PAL information. PAL Dashboard Administration provides a simple way to set up the PAL Dashboard application. These configurations are performed by the PAL administrator.

Accessing the Dashboard Administration Module

Administrators can access the Dashboard Administration module by one of the following methods:

• Via the PAL Configuration application

• Via URL

NOTE: To access Dashboard Administration from within PAL Configuration, the Dashboard Module option must be enabled and configured in the Modules Configuration screen.

Follow the steps below to access Dashboard Administration from within the PAL Configuration Application:

1. Login to the PAL Configuration application

2. Click Dashboard Administration

To access Dashboard Administration from a URL:

1. Launch the browser application, (Internet Explorer or Google Chrome)

2. Enter the application URL in the address field in the format http://servername:portnumber/pxconfig

3. “servername” is the name of the server that has the PAL installation

4. “portnumber” is the assigned port for the PAL Configuration site, e.g. port 82

5. “pxconfig” is the resource

6. Press Enter

NOTE: The URL must be the same address configured as the Administration URL in the PAL Configuration application.

7. The Login window appears after signing out of the Dashboard Administration application. The Password is the same used for the PAL Configuration application.  

Database Configuration

After logging into the Dashboard Administration module, the Database Connection Configuration screen appears. The information on this screen is automatically populated from the PAL Configuration application. The table below provides an outline of the fields found on this screen.

NOTE: Changes made on this screen affect the database connection settings in the PAL Configuration application.

Header Configuration

The Header Configuration section allows users to create a header and related text for the PAL Dashboard application.

1. Click Header Config

2. Enter header details based on the fields outlined in the table below

3. Click Save

4. The Header appears on the top left panel of the Dashboard Administration module, and at the top of the Dashboard module.

NOTE: If a logo is uploaded as part of the Enterprise Configuration in the PAL Configuration application, it appears in the Dashboard module when accessed from PAL using the Dashboard link.

Change Password

The Change Password option allows administrators to create a new password for the Dashboard Administration module. Follow the steps below to change a password:

NOTE: Changing the password affects access to the PAL Configuration application.

1. Click Change Password

2. Enter the Old Password in the Old Password field

3. Enter the New Password in the New Password field

4. Confirm the new password by entering the New Password into the Confirm Password field

5. Click Submit

NOTE: PAL Dashboard uses the same Password Policy administered for PAL. This policy must be followed to successfully change the password.

Error Log

The Error Log provides details to help identify problems and for troubleshooting issues that may arise while using the Dashboard module.

1. Click the Error Log link on the left panel

2. Click Clear to remove the Error Log contents

3. Click Save to store a copy of the Error Log to your local or network drive

Entity Configuration

Entity Configuration allows Administrators to configure specific elements of the Dashboard Administration module, such as catalogs and entities. Entity Configuration has the PAL database as the default catalog and Open and Closed Requests as the two default entities.  

Catalog

Catalog is used to store information about a database. The Dashboard Administration Catalog displays the information found on the Database Connection Configuration screen and is the same information used to connect to the PAL database. Users are able to delete, edit, or create a catalog.

Create a New Catalog

Follow the steps below to create a new catalog:

1. Click Catalog(s). The (1) Edit catalog tab is displayed

2. Click the (2) Add new catalog tab

3. Enter information (outlined in the table below) per your agency’s requirements

4. Click Add. The newly created catalog appears in the Catalogs screen

NOTE: The database must already exist in SQL Server to successfully create a new catalog.  

Edit an Existing Catalog

Follow the steps below to edit an existing catalog:

1. From within the Database Connection Configuration screen, click Catalog(s). The Edit catalog tab is displayed

2. Make any necessary edits and click Save

NOTE: Changes made to a catalog affect the database connection settings in the PAL application.

Delete an Existing Catalog

Follow the steps below to delete an existing catalog:

1. From within the Database Connection Configuration screen, click Catalog(s). The Edit catalog tab is displayed

2. Select the desired catalog from the top pane

3. Click Delete. A verification message appears

4. Click Yes to remove the catalog or Cancel to abort deleting the catalog

NOTE: Removing a catalog affects the database connection in the PAL application. It is highly recommended to reconfigure the PAL database prior to deleting a catalog.

Entities

Entities represent a table or view that is associated with a catalog. Each entity has a Primary Key.

NOTE: The selected catalog must coincide with the current database configured for PAL.

Add a New Entity

Follow the steps below to add a new entity:

1. From within the Database Connection Configuration screen, click Entities. The (1) Edit Entity tab is displayed

2. Click the (2) Add new Entity tab

3. Select a catalog from the Select Catalog drop-down list

4. Expand the Tables or Views options and select the desired entity. The selected item automatically populates the Entity Name field and the Primary Key is automatically populated with column names associated with the entity

5. Select the Primary Key

6. Select the Active checkbox to enable this entity in the catalog

7. Click Add. The entity is displayed on the screen

Edit an Existing Entity

Follow the steps below to edit an existing entity:

1. Click Entities. The Edit Entity tab is displayed

2. Select a catalog from the Select Catalog drop-down list to modify existing entity information

3. Make any necessary edits and click Save

NOTE: Changes made to an entity affect how database information is presented in the PAL application.

Delete an Entity

Follow the steps below to delete an entity:

1. Click Entities. The Edit Entity tab is displayed

2. Select the desired entity

3. Click Delete. A verification message appears

4. Click Yes to remove the entity or Cancel to abort deleting the entity

NOTES:

• Entity fields and filters are automatically deleted

• Removing an entity affects how database information is presented in the PAL application. It is highly recommended to reconfigure the PAL database prior to deleting an entity

Entity Fields

Entity fields represent columns in a table (entity). Entity fields are configured once an entity is created and can only be edited for display in the report after the database is configured.

1. Click Entity Fields

2. Select a field

3. Select one or more of the following options based on your agency’s requirements

   2. Report Column: Enables the column to be used in the Dashboard report

   3. Show in Grid: Displays the column name and data in the grid on the Dashboard report

   4. Show as Category: Specifies the data for the horizontal axis of the Dashboard chart

   5. Show in Group By: Specifies the data for the vertical axis of the Dashboard chart

4. Click Save to retain the settings

5. Repeat steps 2 – 4 for each field that needs to be configured

Entity Filters

An Entity filter allows Administrators to manipulate how the data can be viewed and/or the type of data that can be viewed in a report. Entity filters coincide with fields in the selected entity. The data in these columns can be filtered by their values, a range, date, query and/or logical operator.

NOTE: If the field value is numeric, you can set the filter type to Values, Range or Logical Operator. If the field value is a string, you can select Values or Query as the filter type. Fields defined as a date must have Date as the filter type.

Add a New Filter

Follow the steps below to add a new filter:

1. Click the Entity Filters link on the left panel. The Edit Filter tab is displayed

2. Click the Add New Filter tab

3. Select a Catalog from the drop-down list. The Entity field automatically populates with the entity that corresponds to the selected catalog

4. Select the Filter Column from the drop-down list

5. Select a Filter Type based on your agency’s requirements:

   2. Values: Displays the data set for a column

   3. Range: Sets a specific limit on the values for a column

   4. Query: Displays built-in SQL statements for a column

   5. Date: Allows users to select a date in the Dashboard application

6. Logical Operator: Allows users to select a logical operator in the Dashboard application (e.g., greater than, less than, or equal to)

7. Click Save to retain the settings

Edit a Filter

Follow the steps below to edit a filter:

1. Click Entity Filters. The Edit Filter tab is displayed

2. Select the column to modify

3. Make any necessary edits, then click Save

Delete a Filter

Follow the steps below to delete a filter:

1. Click Entity Filters. The Edit Filter tab is displayed

2. Select the column to delete

3. Click Delete