Page tree





Administration GUI of Compliance Checker allows users with administrator privileges to execute the following:

        • Update the Knowledge Base of regulations.
        • Monitor the running services and settings.
        • Check default categories/countries
        • Create, modify, delete user-defined category groups.
        • Create, modify, delete user-defined categories.
        • Search in File check history and delete all data of a file check.
        • Search in Single check history.
        • Search in Database update history.
        • Create, modify, delete report templates.

Login

Administration GUI is available after login as administrator on the web GUI of Compliance Checker and clicking on the Administration button in the upper right corner.

Update the regulations

After setting up an update server, users and admins get a warning message when the Knowledge Base version is not up to date:

 


Admins can update the Knowledge Base from the Administration page by clicking on the  Update the regulations  button. 
Actual regulations are covered by a rule set and an exclusion set which are sets of special chemical query structures confirming the actually valid and relevant legal regulations.
The scope of the legal relevancy depends on the scope of the Compliance Checker license you have.

Two ways are provided for the update:

Manual DB update
  • Admins can execute the update by selecting your own jar file containing the appropriate database by clicking on Update to selected file button.
  • Or the Knowledge Base can be updated automatically - if the update server was configured - by clicking on the Download and update to latest version button.
Automatic DB update
  • Automatic update can be configured that monitors if there is a newer update on the update server and updates the Knowledge Base automatically.

System monitor

Click to open the System monitor page where you can check the actual status of the system and the running services.

System status

The System status shows the details of the MongoDB, the System user, the Eureka services, the Config service and Settings. There are settings which can be applied only after restart and another group of settings that can be changed on the fly. If the latter settings were changed, they should be reloaded by clicking on the Reload settings from config file button.

Available services

Three types of services can be monitored here:

  • cc-api
  • cc-backend
  • cc-bigdata
  • cc-web

Category groups

Click to open the Category group editor page.

This page lists the Available category groups in three groups: 

    •  Countries
    •  International regulations
    •  User-defined category groups

These Countries and User-defined category groups will be displayed on the Compliance Checker User Interface in the Regulation categories section as 'Available countries' and as 'Available category groups'.

Default categories

Countries

The displayed 'Countries' are in accordance with your license file.

Here you can check which regulations are included in the individual countries.

You can clone the available countries and the created clone will become a new User-defined level.

Editing or deleting 'Countries' is not available.

International regulations

The displayed 'International regulations' are in accordance with your license file.

Here you can check which regulations are included in each individual group.

You can clone the available 'International regulations'. The created clone will be a new User-defined category group.

Editing or deleting 'International regulations' is not available.

Category group editor

User-defined category groups can be created by clicking on the Create new category group button on the top of the page. This lets the admin to create a new category group, named and defined by the admin.

Clicking on an existing user-defined category group opens a dropdown with the Edit and Delete buttons:

    • Edit:  opens the Edit category group page displaying the actual content of the selected 'User-defined category group' and makes possible to make changes.
    • Delete: displays a confirmation popup where clicking 'Yes' will delete the selected 'User-defined category group'.

Creating a new category group

The Create new category group button on the top of the Available category groups page opens the Create new category group page.
To narrow the search in the Available categories you can use the Countries and international regulations dropdown and/or the Quick search filter.
 

Name: enter the name of the new level

ID: unique identifier

Available categories: By default all categories are listed here. Two filters are provided to help to select the needed rules for the new level. The set values of these two filters are combined and taken into account with AND logic.

Countries and international regulations: a country or an international regulation can be selected from the dropdown.

Quick Search: an input box for a free text filter.

Select all: this button moves all pre-filtered categories to the Selected categories panel on the right.

Selected categories: lists the already selected regulations.

Clear: moves all selected categories to the Available categories panel on the left.

Save: button that saves the new user-defined category group.

Cancel: cancels the creation of the user-defined category group.


Editing a category group

When you click on an existing user-defined category group  you can check which categories are included in this definition. 

There are 3 available options: CloseEdit and Delete this user-defined category group.

Close: Closes this user-defined category group's drop-down

Edit: Opens the Edit category group page displaying the actual content of the selected user-defined category group and makes possible to make changes in the selected categories.

After the changes you have to click on the Save button to save these changes. Clicking on the Cancel button or opening another page results in discarding the changes.



Deleting a category group

To delete the selected user-defined category group the 'Yes' button should be clicked on the confirmation popup:
 

User-defined categories


The admin can create/modify/delete a custom user-defined regulation category based on the selected set of categories belonging to the same country.
Further refinement of the selected categories is possible to select/unselect which "Substance IDs" (regulations/queries) should this user-defined category contain.
However you cannot add new rules to this category. But you can remove regulated substances you have license for.

Click on the  button on the left navigation bar to start the User-defined category editor.


User-defined category editor

Creating a new user-defined category

Clicking the Create new category button a short guide is displayed:


After selecting a country (Switzerland) only one category (7144 - CH ... Narcotics List D) is selected for editing:


The table of the displayed regulations can be filtered by free-text search of Substance ID / Substance name / Category and System updates, plus in the Show dropdown llist the Selected/Unselected.
Above the table the Selected regulations (Selected 182 of 188) are shown on the left and the Displayed (filtered) regulations (Displayed 6 of 188) are shown on the right side:

In this example Not modified regulations containing ethylamphetamine and methylamphetamine were filtered and unselected from this user-defined category.

After editing this user-defined category the  button should be clicked. On saving a unique Category code is generated by the system, starting from 100001.


Editing/Deleting a user-defined category

When there are existing earlier created user-defined categories saved in the system, clicking on the  User-defined category editor icon displays a list of these in a table.

In the Actions column you can select Edit or Delete.

Edit

Opens the editor where you can easily review - with the above described filters - the Added/Modified/Deleted/Not changed substances in your custom category which were affected by the latest Knowledge Base update.

After editing this user-defined category the  button should be clicked. 

Delete

You can delete an existing user-defined category by clicking the Delete button in the Actions column.

A confirmation popup will be displayed that you should accept for the deletion.


Notifications after Knowledge Base update!

Notifications column shows the number of substances - system updates - in a user-defined category that were Added/Deleted/Modified during the latest Knowledge Base update. 
You can review and accept each user-defined category one by one selecting Edit in the User-defined category list.


What happens on a Knowledge Base update?

  • When the Knowledge Base is updated all unaccepted notifications will become automatically accepted.

So before the Knowledge Base update all user-defined categories with Notifications should be reviewed and modified if needed.

A warning popup is displayed on a Knowledge Base update to remind you that all unaccepted notifications will become automatically applied.

 


You should review and accept each user-defined category - that has system updates - one by one selecting Edit in the User-defined categories table.

In the following example the user-defined categories were created with Knowledge Base v17.10.04.3 and the Knowledge Base was updated recently to v18.07.11.0:

Reviewing (Edit) the SwissEF user-defined category and applying the System updates filters (Added/Modified/Deleted/Not changed) in the above example, 20 substances were deleted, 38 substances were added and 2 substances were modified between the October 04, 2017 and the July 11, 2018 Knowledge Base.


  • Modified substance gets automatically selected at the Knowledge Base update- even if that substance was deselected in the user-defined category.



  • Modified category of a substance results in Add/Delete, i.e. 2 system updates.


Checking against user-defined categories

Because Single check or File check can only be run against countries or category groups, a user-defined category group should be created that contains your user-defined category.
After that you can run the check against that category group.



Database update history

Clicking on the History button on the left navigation bar opens the History page. Selecting the Database update history tab the updates are listed and they can be searched.

The following filters are available to narrow the search:

Legislation code (from-to numbers)

Update date (from-to dates)

Substance ID (from-to numbers)

Legislation name (free text search)

Update type (ADD/UPDATE/DELETE drop-down)

 

This table is sorted by the Substance id and clicking on a line opens the Database update history data popup with the details: Example, Name, Synonyms, CAS#, Legislation, Reference, DEA# and the Query molecule. Titles of modifications are highlighted in red.

 

File check history

Clicking on the History button on the left navigation bar opens the History page. Selecting the File check history tab the latest File checks are listed.
Data of earlier File checks can be searched and their generated reports can be downloaded.

The following filtering parameters can be set on the input panel to narrow the search:

    • User name
    • File name
    • Upload starting date  (from-to dates)

Below that a table of the latest results sorted by their Upload started date. Above the  last column the actually displayed row numbers of total are shown.


 

Clicking on a row the File check details popup is displayed from where the generated reports can be downloaded.

 

Delete all data of an individual File check from the system 

The administrator can now delete all (e.g. confdential) data from the system of a user's File check by clicking on the Delete button - in the Action column - on the File check history page. (See above.)

Before the delete operation is started a confirmation dialog is dislplayed:


This action is irreversible, so all data of an earlier File check is deleted. 

Delete the File check history periodically

In the application.properties file the batch.cleanup.scheduler function can be configured to periodically delete the Batch check history, the reports and the uploaded files from the server.

Settings of batch.cleanup.scheduler can be modified according to the following examples:

# Enables to schedule the removal of all File report related data from the database.
# The value should be a cron-like expression, which extends the usual UN*X definition to include triggers
# on the second as well as minute, hour, day of month, month and day of week.
# Example patterns:
#    "0 0 * * * *" = the top of every hour of every day.
#    "*/10 * * * * *" = every ten seconds.
#    "0 0 8-10 * * *" = 8, 9 and 10 o'clock of every day.
#    "0 * 6,19 * * *" = 6:00 AM and 7:00 PM every day.
#    "0 0/30 8-10 * * *" = 8:00, 8:30, 9:00, 9:30 and 10 o'clock every day.
#    "0 0 9-17 * * MON-FRI" = on the hour nine-to-five weekdays
#    "0 0 0 25 12 ?" = every Christmas Day at midnight

# batch.cleanup.scheduler=0 0/30 15-17 * * *

 

Single check history

Clicking on the History button on the left navigation bar opens the History page. Selecting the Single check history tab the latest Single checks are listed.
Data of earlier single checks can be searched and their generated reports can be downloaded.

The following filtering parameters can be set on the input panel to narrow the search:

    • User name
    • Check date  (from-to dates)

 

Clicking on a row the Single check details popup is displayed from where the generated reports can be downloaded.

Report template editor

Admins can create and customize Report templates from the Administration page by clicking on the  Report template button.

The available Report templates are listed on the left side in the Report templates panel.


Selecting a Report template from the list it's content will appear on the right side. The default template can be selected by clicking the Set as default button and will be marked with a checkbox on the Report templates panel.
The templates can be deleted - except the Default template.

New templates can be created by clicking the Create new button and drag-and-drop the required fields from the Available columns to the Selected columns panel.

These are the Available columns:

  • Input #
  • ID
  • Input molecule image
  • Input molecule source
  • Input data fields
  • Controlled?
  • What is controlled?
  • Legislation
  • Example molecule image
  • Example molecule source
  • Synonyms
  • CAS Registry Number®
  • DEA #

The order of these columns can be modified also by dragging. After adding a Report template name the template has to be saved. When the new template is saved then it will be listed in the Report templates panel - and the User can select it at the File check report generation.

The listed templates can be edited and modified the same way as above. After editing the template it has to be Saved.

When Input molecule source is moved from Available columns to Selected columns then the Input molecule source format can be selected from a dropdown:
MRV/MOL/SMILES/NAME.


Before starting a File check users can select a template from the Report template dropdown list :


And also before generating a new report from an earlier File check:

 

Selection of a Report template is not available for Single check, so the report will be generated according to the default Report template.