Frontend → Agent → Route

Table of Contents

AgentFrontend::Route###001-Framework

Defines the application routes for the agent interface. Additional routes are defined by adding new items and specifying their parameters. “Group” and “GroupRo” arrays can be used to limit access of the route to members of certain groups with RW and RO permissions respectively. “Path” defines the relative path of the route. And “Alias” can be used for specifying an alternative path. “Component” is the path of the Vue component responsible for displaying the route content, relative to the Components/Route folder in the app. “Props” can be used to signal that the path contain dynamic segments, and that their values should be bound to the component as props (use “1” to turn on this feature).

Default value:

---
- Alias: /dashboard
  Component: Dashboard
  Group: []
  GroupRo: []
  Path: /
  Props: '1'
- Alias: ''
  Component: Search
  Group: []
  GroupRo: []
  Path: /search/:searchQuery?
  Props: '1'
- Alias: ''
  Component: StatisticReportOverview
  Group:
  - stats
  GroupRo: []
  Path: /statistic-report
  Props: '1'
- Alias: /statistic/update/:itemId
  Component: StatisticCreateUpdateView
  Group:
  - stats
  GroupRo: []
  Path: /statistic/create/:itemId?
  Props: '1'
- Alias: /statistic-report/update/:itemId
  Component: StatisticReportCreateUpdateView
  Group:
  - stats
  GroupRo: []
  Path: /statistic-report/create/:itemId?
  Props: '1'
- Alias: ''
  Component: TicketNumberDetailView
  Group: []
  GroupRo: []
  Layout: '0'
  Path: /ticket/number/:number
  Props: '1'
- Alias: ''
  Component: TicketDetailView
  Group: []
  GroupRo: []
  Path: /ticket/:itemId
  Props: '1'
- Alias: ''
  Component: TicketListView
  Group: []
  GroupRo: []
  Path: /tickets/:type/:name?
  Props: '1'
- Alias: ''
  Component: TicketCreateEmail
  Group: []
  GroupRo: []
  Path: /ticket/create/email
  Props: '1'
- Alias: ''
  Component: TicketCreatePhone
  Group: []
  GroupRo: []
  Path: /ticket/create/phone
  Props: '1'
- Alias: ''
  Component: TicketCreateSMS
  Group: []
  GroupRo: []
  Path: /ticket/create/sms
  Props: '1'
- Alias: ''
  Component: TicketCreateProcess
  Group: []
  GroupRo: []
  Path: /ticket/create/process
  Props: '1'
- Alias: ''
  Component: KnowledgeBaseArticleDetailView
  Group: []
  GroupRo: []
  Path: /knowledge-base-article/:itemId
  Props: '1'
- Alias: ''
  Component: KnowledgeBaseArticleCreate
  Group: []
  GroupRo: []
  Path: /knowledge-base/article/create
  Props: '1'
- Alias: ''
  Component: KnowledgeBaseArticleListView
  Group: []
  GroupRo: []
  Path: /knowledge-base-articles/:type/:name?
  Props: '1'
- Alias: ''
  Component: WebNotificationListView
  Group: []
  GroupRo: []
  Path: /notifications/:notificationId?
  Props: '1'
- Alias: ''
  Component: CustomerUserCreate
  Group: []
  GroupRo: []
  Path: /customer/user/create
  Props: '1'
- Alias: ''
  Component: CustomerUserDetailView
  Group: []
  GroupRo: []
  Path: /customer/user/:itemId
  Props: '1'
- Alias: ''
  Component: CustomerUserListView
  Group: []
  GroupRo: []
  Path: /customers/user/:type/:name?
  Props: '1'
- Alias: ''
  Component: CustomerCompanyListView
  Group: []
  GroupRo: []
  Path: /customers/:type/:name?
  Props: '1'
- Alias: ''
  Component: CustomerCompanyCreate
  Group: []
  GroupRo: []
  Path: /customer/create
  Props: '1'
- Alias: ''
  Component: CustomerCompanyDetailView
  Group: []
  GroupRo: []
  Path: /customer/:itemId
  Props: '1'
- Alias: ''
  Component: CalendarOverview
  Group: []
  GroupRo: []
  Path: /calendar
  Props: '1'

AgentFrontend::Route###099-OTRSTicketWatchlist

Defines the routes for the ticket watchlist overview and detail.

Default value:

---
- Alias: ''
  Component: TicketWatchlistListView
  Group: []
  GroupRo: []
  Path: /tickets-watchlist/:name?
  Props: '1'

AgentFrontend::Route###200-OTRSServiceManagement

Default value:

---
- Alias: ''
  Component: ServiceListView
  Group:
  - itsm-service
  GroupRo:
  - itsm-service
  Path: /services/:type?/:name?
  Props: '1'
- Alias: ''
  Component: ServiceDetailView
  Group:
  - itsm-service
  GroupRo:
  - itsm-service
  Path: /service/:itemId
  Props: '1'
- Alias: ''
  Component: SLAListView
  Group: []
  GroupRo:
  - itsm-service
  Path: /slas/:type?/:name?
  Props: '1'
- Alias: ''
  Component: SLADetailView
  Group: []
  GroupRo:
  - itsm-service
  Path: /sla/:itemId
  Props: '1'

ExternalFrontend::Route###001-Framework

Defines the application routes for the external interface. Additional routes are defined by adding new items and specifying their parameters. “Group” and “GroupRo” arrays can be used to limit access of the route to members of certain groups with RW and RO permissions respectively. “Path” defines the relative path of the route, and “Alias” can be used for specifying an alternative path. “Component” is the path of the Vue component responsible for displaying the route content, relative to the Components/Route folder in the app. “IsPublic” defines if the route will be accessible for unauthenticated users and in case this is set to “1”, “Group” and “GroupRo” parameters will be ignored. “Props” can be used to signal that the path contain dynamic segments, and that their values should be bound to the component as props (use “1” to turn on this feature).

Default value:

---
- Alias: /home
  Component: HomePage
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /
  Props: ''
- Alias: /c/:slug
  Component: CustomPage
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /content/:slug
  Props: '1'
- Alias: '*'
  Component: ErrorPage
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /error
  Props: '1'
- Alias: ''
  Component: TicketOverview
  Group: []
  GroupRo: []
  IsPublic: '0'
  Path: /ticket/overview/:filter?
  Props: '1'
- Alias: ''
  Component: Search
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /search/:searchQuery?
  Props: '1'
- Alias: ''
  Component: PersonalPreferences
  Group: []
  GroupRo: []
  IsPublic: '0'
  Path: /account/personal-preferences/:category?
  Props: '1'
- Alias: ''
  Component: TicketCreate
  Group: []
  GroupRo: []
  IsPublic: '0'
  Path: /ticket/create/:mode?
  Props: '1'
- Alias: ''
  Component: TicketDetailView
  Group: []
  GroupRo: []
  IsPublic: '0'
  Path: /ticket/number/:ticketNumber
  Props: '1'
- Alias: ''
  Component: ServiceCatalogue
  Group: []
  GroupRo: []
  IsPublic: '0'
  Path: /service-catalogue/:categoryId?
  Props: '1'
- Alias: /knowledge-base/
  Component: KnowledgeBaseOverview
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /knowledge-base/category/:categoryId?
  Props: '1'
- Alias: ''
  Component: KnowledgeBaseDetailView
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /knowledge-base/article/:articleId
  Props: '1'
- Alias: ''
  Component: PersonalNotifications
  Group: []
  GroupRo: []
  IsPublic: '0'
  Path: /personal-notifications
  Props: '1'

ExternalFrontend::Route###002-Survey

Default value:

---
- Alias: ''
  Component: Survey
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /survey/:publicSurveyKey
  Props: '1'

ExternalFrontend::Route###003-OTRSCustomerEventTicketCalendar

Default value:

---
- Alias: ''
  Component: OTRSCustomerEventTicketCalendarOverview
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /appointments/:filter?
  Props: '1'
- Alias: ''
  Component: OTRSCustomerEventTicketCalendarDetailView
  Group: []
  GroupRo: []
  IsPublic: '1'
  Path: /appointments/appointment/:appointmentId
  Props: '1'

Facebook X LinkedIn