Guide Purpose:

• This guide IS designed to:
  • Show where to find use cases from the customers perspective.
    • Help explain use cases from the customer perspective
  • Show where to find where to edit Use Cases as an 3^rdEye Administrator
    • Help explain what the JSON options mean.
• This guide IS NOT designed to:
  • Explain how to write, read, and define fields in JSON.

Finding Use Cases

1. Go to “Administration”
2. Select “Configuration”
3. Go to “Companies”
4. Select a Tenant from the list
5. Scroll down in the “Configuration” section until you hit “Driver Triggered Categories”
6. Shown below in PINK is an example of a Use Case.
   

Examining the Use Case JSON 

YELLOW: These are defining fields to categorize the use case.

• code: This is a special code must be unique per use case within a single tenant. It is important this # is the same for the same use case name across tenants!
• name: This is the name that displays on the tenant Events to Review Page.
• groupName: This is not shown on the JSON, but is use to group multiple use cases together.

GRAY: Relatedto sending notifications to the customer.

• autoEmailNotification: When an event is reviewed by the customer automatically send an email.
• emails: List of emails to distribute notifications to based on autoEmailNotification.
• reviewCallback: If reviewing this use case will be sent back to the customer via the collection API.

PINK: What type of events will be considered for review: exceptions, verifications, both.

• eventType: The type of event that can be reviewed.
  • 0 = Service Verifications
  • 1 = Service Exceptions
  • 2 = Both Verifications and Exceptions

BLUE: What vehicles would be accessible for review in the Use Case.

• lobs: The line of business as applied to the vehicle record.
  • 0 = Commercial
  • 1 = Residential
  • 2 = Industrial
  • 3 = Container Delivery
• bodyType: The body type applied to the vehicle record, this is a string.

GREEN: The type of media that will be reviewed by the use case.

• mediaType: The type of media: “jpeg” OR “video”
• mediaCamera: The specific camera # media that will be reviewed.
• mediaPosition: The specific camera label that would be reviewed, this takes priority over mediaCamera IF AVAILABLE.

RED: The AI Array, this is used to turn on and configure the AI model specific for the tenant.

Examining Feedback Categories

RED: subCategories to the customer show up as Feedback Categories, and are added to the JSON.

• The subcategories go INTO the Use Case they are related to and act as Checkboxes the customer can apply when looking at a Use Case on Events to Review.
  

Feedback Categories Further Explained

YELLOW: These are defining fields to categorize the Feedback Category.

• code: Similarly, to Use Case the Code is a number that must be unique per Feedback Category within a single use case. It is important this should be consistent for the same use case feedback category across tenants!
  • Example: If both Leck Waste Services and Mission Trail use Purif-Eye they should both be Code 8, then if they both have the sub category White Bags the code should both be 8010010.
• name: Similarly to the Use Case, each subcategory needs a name. This Name is used to show the customer what category they would apply when reviewing a use case.
  • Example: If you were reviewing Purif-Eye you may want to highlight if an image is CONTAMINATED. Although it’s helpful to know it’s contaminated you could be more specific and select exactly what is CONTAMINATED in the image to help the customer better understand the contamination. Such as highlighting in a recyclable load you identified a pile of Styrofoam.

GREEN: What vehicles would be accessible for review in the Use Case.

• lobs: The line of business as applied to the vehicle record.
  • 0 = Commercial
  • 1 = Residential
  • 2 = Industrial
  • 3 = Container Delivery

BLUE: Use to group multiple Feedback Categories into a single section for easier access.

groupName: A string or name, for multiple Feedback Categories to fall into a single group the groupName must be the same across the feedback categories within the Use Case.