Update: Dataset Routing & Approval is no longer available for new customers and is in the process of being deprecated. If you are interested in this functionality please review our Approvals article and reach out to firstname.lastname@example.org for more information.
The Dataset Routing and Approval module is part of the publishing process and allows site Administrators to create a multi-stage process for dataset routing and approval.
The Routing and Approval Process is applied to all PUBLIC datasets that are uploaded and published by those who are not Administrators. Administrators will still be able to approve their datasets even if they are not part of the Routing and Approval process. A dataset that starts off as private will not appear in the queue, but it will appear when the permissions are changed to public.
How to access Routing and Approval:
- Log into your account and click on ‘Administration’ in the upper right-hand corner.
- On the next screen, you will see various administration tools in a few different menus. Click on ‘Routing & Approval’ in the Content section. This will bring you to the Routing & Approval Dashboard.
Setting up the Routing and Approval Process:
- Once you are on the Dataset Routing and Approval Dashboard, click the button on the right-hand side of the screen marked ‘Approval Management,' which will bring you to the following page:
- Create a Name for the process.
- Define the number of days after inactivity that you want to have a dataset marked as ‘stuck.’ A dataset becomes ‘stuck’ when the administrator whose approval is needed at that stage does not act on the dataset (i.e. approve or disapprove) after the specified number of days. The dashboard will indicate which datasets are stuck, what stage they are stuck in, and how many days a dataset has been inactive.
- Choose whether you want your data sets to go through Routing & Approval for every update or only during new dataset creation.
How to define the stages:
After you name the process, you are able to create and define the stages in the approval process, as well as the administrators involved at each stage. The approval process begins when a dataset is added to the website and ends when the dataset is approved at the final stage, which will publish the dataset to the website. The following are the components of a stage:
- Name: This is the name of the stage. The stages occur sequentially from top to bottom.
- Notification Method and Interval: You can choose either ‘One at a time’ or ‘Everyone at once.’ If you choose ‘One at a time’ an email notification will be sent to one approver at a time, with notifications being sent sequentially according to the time interval specified. If you choose ‘Everyone at once’ an email will be sent to all the approvers at once. Approval is needed from all approvers specified before the dataset will be classified in that Stage.
- Approvers: This is a list of the emails of the administrators you want to have notifications requesting approval sent to.
After you define the stages, determine if you want the approval process to be applied to currently existing datasets. If you want the current datasets to go through the approval process, uncheck the box 'Keep current datasets visible in the catalog,' otherwise leave it checked and only datasets added after this time will go through the approval process. Click 'Create' and you're done!
Dataset Routing & Approval Example:
The following is an example of the routing and approval process with the following stages and administrative notifications:
- A dataset is added and published to the website. Note that the dataset was 'published,' but it will not be visible until the dataset goes through the approval process.
- The dataset enters the approval process, and an email notification is sent to the approver in Stage 1 in order to enter that stage. When that approver logs into their account and goes to the Dataset and Routing Dashboard, the following screen will appear. There will be a notification that the dataset needs approval, and it will be classified as ‘Not Ready Yet.’
- Click on ‘Take Action’ or go to ‘Approval Queue.’ The approver will see the following page, where they can either ‘Approve’ or ‘Reject.’
- If the dataset is approved, it will be classified in ‘Stage 1’ on the dashboard.
- An email notification is then sent to the approvers for Stage 2. Just as in Stage 1, the approvers go to the Dataset and Routing Dashboard and choose to ‘Approve’ or ‘Reject’ the dataset. If it is approved by all Approvers, the dataset will be classified as ‘Stage 2.’ In this example Stage 2 is the final stage, meaning the dataset will then be published to the website.