Sonar
This guide includes instructions for generating API credentials to connect Sonar to Layer 9.
Prerequisites
Section titled “Prerequisites”- Access to Sonar with administrator privileges
- Ability to create Roles and Users
Step 1: Create a Role with Required Permissions
Section titled “Step 1: Create a Role with Required Permissions”Create a role in Sonar with the following permissions. Instructions for creating roles can be found in the Sonar documentation.
Module Permissions
Section titled “Module Permissions”Inventory
Section titled “Inventory”- View all inventory
Entity Permissions
Section titled “Entity Permissions”Account
Section titled “Account”- View all account transactions
- View accounts and related entities
Address
Section titled “Address”- View serviceable addresses
Inline Device
Section titled “Inline Device”- View all inline devices
Inventory Item
Section titled “Inventory Item”- Update an inventory item
Network Site
Section titled “Network Site”- View all network sites
- Create a new note
- Update a note
- Delete a note
Package
Section titled “Package”- View all packages
Payment
Section titled “Payment”- View all payment methods
Schedule Availability
Section titled “Schedule Availability”- View all schedule availabilities
Service
Section titled “Service”- View services
- Update a task
Ticket
Section titled “Ticket”- View all non-private tickets
- Create a ticket
- Update a ticket
- Delete a ticket
- View all jobs
- Update a job
- Create a job
- View all schedule blockers
- Allows a user to check anyone in to a job
- Allows a user to complete any job
After creating the role, create a user that will programmatically access Layer 9 and assign the new role to that user.
Step 2: Create a Personal Access Token
Section titled “Step 2: Create a Personal Access Token”Follow the steps in the Sonar documentation to create a Personal Access Token for the newly created user.
Step 3: Coordinate with Layer 9 Team
Section titled “Step 3: Coordinate with Layer 9 Team”Share the following with the Layer 9 team:
- Personal Access Token
- Login credentials for the user account