This section of the document describes setting up the Confirm Street Manager interface.
Step 1 - Get the Street Manager API credentials
Street Manager API access is required to interact with Street Manager from Confirm. You will need a set of generic email IDs to be set up to access the Street Manager system which you can then use in Confirm. Please contact the DfT to obtain an administrative account which will allow you to create the necessary users in each environment.
If you want a generic email addresses on the Confirm on-demand domain as Street Manager API access email IDs, you may use following format when creating the accounts in Street Manager:
- Promoter email address, use the format <confirmcouncil>-promoter@ondemand.confirm.co.uk replacing <confirmcouncil> with your council name.
- Authority email address, use the format <confirmcouncil>-authority@ondemand.confirm.co.uk replacing <confirmcouncil> with your council name.
Please let us know at confirm.support@brightlysoftware.com when you have created the users so that we can forward the activation emails to you. You can use the same email address for Sandbox and Production but they are different "accounts" in Street Manager so should be given different passwords.
You will initially receive a temporary password for the user ID created which you need to change to permanent. Also, your admin user in the Street Manager will need to give all Confirm user accounts the API role. We recommend that an API user to not have a UI role in Street Manager.
You need to ensure that the Promoter API user has access to all of the relevant Workstreams that corresponds with your promoter districts in Confirm. To do this log in as your admin user and select Organisation Users. The select the Promoter API user. Click Manage against their user permissions. We recommend you select all on the Workstream and 'Confirm access'.
Step 2 - Install the Decoupled Confirm Task Processor and Confirm Web beta environment
All the On-demand clients have been set up to use the decoupled Task Processor and Confirm Web beta environment for Development and Production (not Test). We recommend that Development is linked to the Street Manager Sandbox environment and Production to Production.
You will need to access the Confirm web beta environment for Street Manager interface- specific configurations. The On-demand URLs for the Confirm Web beta environments are unique for each customer and look like this:
- Development: https://beta-development-webservices.ondemand.confirm.co.uk/confirm/web/app/?tenant=<Your Profile Name>#/settings
- Production: https://beta-production-webservices.ondemand.confirm.co.uk/confirm/web/app/?tenant=<Your Profile Name>#/settings
Replace "<Your Profile Name>" with your usual profile name, e.g. "Authority Name - Development" without any leading or trailing spaces. Please contact Confirm support team if you are unsure of your Confirm web beta URLs for development and production.
The On-premise clients need to follow the Installation (For On-Premise clients) section of the document to install the decoupled Task Processor and Confirm Web beta environment.
Step 3 - Configuring the Confirm Street Manager interface
Following Street Manager Settings in the Web Settings screen need to be configured
- Street Manager URL - Refer to https://department-for-transport-streetmanager.github.io/street-manager-docs/api-documentation/ and Current Release section for sandbox and production URLs which could change. The current URLs are:
- Document Proxy URL - The URL to the Confirm Web beta that supports the Street Manager document proxy service. Ensure this ends with a trailing slash. For On-demand these URLs are as follows:
- Street Works Web Interface URL - The URL to the Confirm Web beta which is used for launching Street Works. Usually this would be same as 'Document Proxy URL'.
- Legislation URL - The URL is of DfT legislation which contains the latest charges for unreasonably prolonged occupation of the Highway. Current URL as per Street Manager is as below.
- Email Address (for role 'Promoter') - the API access key of a Promoter user for accessing the Street Manager APIs. Required when Confirm is used as Promoter system and for self Promoted works.
- Password (for role 'Promoter') - the API secret of a Promoter user for accessing the Street Manager APIs. Required when Confirm is used as Promoter system and for self Promoted works.
- Email Address (for role 'Highway Authority') - the API access key of an Authority user for accessing the Street Manager APIs. Required when Confirm is used as Authority system.
- Password (for role 'Highway Authority') - the API secret of an Authority user for accessing the Street Manager APIs. Required when Confirm is used as Authority system.
Step 4 - Activating the Confirm Street Manager interface through the decoupled Task Processor
The decoupled Task Processor performs the main task of integration with Street Manager, namely sending and receiving Street Works notifications. The decoupled Task Process takes over the role performed by the Street Works Transfer Agent.
Once the decoupled Task Processor has been installed, it is activated by "tagging" the 'Street Works Transfer' Agent in the Scheduled Tasks screen with the version number of the decoupled Task Processor, e.g. "<V21.20>". The act of tagging the scheduled task ensures that your "main" task processor no longer runs this task, allowing the decoupled task Processor to take over.
Note that the first time the new agent runs it will make the necessary lookup table changes as described in the various Field Mapping sections, so please ensure that you have familiarised yourself and relevant users with these changes in a development environment before activating the new Task Processor in production.
On-premise customers need to ensure that the Task Processor procedure patching has been completed, as described in the installation section, before tagging the agent.