Queries on Custom tables
PerformanceCentre is extending the feature of queries on table records from Sales Commission Table to custom tables. With the help of this new feature, custom tables created can have an option to ‘Enable Queries’ for its records. This feature is facilitated with a checkbox option that is displayed below the column name section of table setup.
This option is will be available to all existing custom tables from this release.
1) Enabling queries during table creation
When a new table is created in PerformanceCentre, if the table needs to be enabled with queries, please ensure that a column is marked as unique as shown below. If this column is not created during table creation, PKID will be chosen as the default unique column.
2) Enabling existing table with query
When an existing table is checked for enabling queries, an alert will be displayed as below.
The alert will be displayed on two occasions.
- If the ‘Enable Queries’ option is marked as ticked for an existing custom table
- When existing table is added with a new column marked as unique and clicking on tick for ‘Enable Queries’
UI after configuration
Below is a screenshot of a custom table list view when the query option is enabled.
A custom table module created for the participant with this table will have the below view.
Please note that Participant Source Data and leaderboard tables will not have this feature option.
Queries in Detailed view of custom table record
When a custom table is enabled with queries, on clicking the record from the list view, the page is navigated to detailed view where the queries section will be displayed on the right side as shown below. Admin and participant are given an option to raise a query on a record. Below are the screenshots from the administrator page.
Click on ‘New’ button to initiate a query and a dialogue box is displayed as below.
After filling the relevant details, clicking on the ‘Send’ button will send the queries to all Recipients. Multiple recipients could be added to the query. All queries are by default send to Administrators without mentioning in the recipient field. Queries will appear in the mailbox of all recipients.
Queries on a record will appear on the right side section as shown below Name, Job Title, subject and latest post in query displayed.
Clicking on a query on an existing record will display a dialogue box as shown below. The recipient will be administrators and the additional recipient will be names entered by the user. Additional recipients could be added to the query by entering the names in Additional Recipients field.
Adding a post to a query
The additional post can be added to the query by entering the post in the field on the left side of ‘+’ button as shown below. clicking on button ‘+’ will append the message below the latest posts.
Closing and reopening queries
The query can be closed and reopened in custom tables. Close Query button at the bottom of the page will help in closing the query. A query can be closed by both admin and participant. clicking on close query button will display the below screen. Clicking on the Reopen button will open the query subsequently. A new post is added when the close/reopen button is clicked.
A closed query will be highlighted in grey color in queries section.
Open and closed queries in Queries section
Queries on Custom table list view
When custom tables are enabled with queries, a new column named queries will be displayed in the list view of the table. This column will be updated with icons which indicate the different status of queries related to respective records. This behavior will be followed in admin and participant sites. Below references are from the administrator site.
Green Envelope Icon
When a record is having queries which are initiated and not closed, they are categorized as Open Queries which are indicated with a green envelope icon in queries column.
Black Envelope Icon
When queries related to a record in the custom table is closed, the query column in list view will be displayed with a Black envelope icon and is categorized as Closed queries.
When queries raised by admin or participant is not read by the recipient, the list view will display a number indicator above the envelop symbol indicating the number of unread posts. The query status is not a factor in displaying the number of unread posts. The number of unread posts will be displayed on Closed queries as well.
Unread on open query
Unread on closed query
Queries can be filtered based on query category. Clicking on More button on the right side of search field will display the filter on Query status where the different status of queries could be selected.
Custom Table queries on mailbox
When custom tables are enabled with queries, the participant recipients in queries will receive an indicator on the mailbox whenever a new query has been raised. Administrators will have a new item in the messages section of the dashboard.
Mailbox icon will have a number decorator indicating the number of unread posts of queries. Clicking on the mailbox icon will display a drop-down of the mailbox with queries.
Accessing the query in participant site could be categorized in two ways.
Participant with a custom table module for which query was enabled
If the recipient participant has a participant module setup with the underlying custom table for which query is enabled, clicking on the query from mailbox will take the participant directly to the detailed view of the record with query dialogue box open.
Participant without a custom table module for which query was enabled
When the participant is not having a custom table module setup, clicking on a query from mailbox dropdown will display the query dialogue box but the underlying table data will not be displayed on the screen. A message indicating the lack of permission will also be displayed as below.