PartI.User's Guide
PartI.User's Guide
PrevNext

PartI.User's Guide

Table of Contents

1. Introduction and installation
1. Introduction to Akeeba Ticket System
2. Requirements and compatibility
3. Migration notes
3.1. Migration from Akeeba Ticket System 2.x or 3.x to 5.x
3.2. Migrating from Akeeba Ticket System 4.x to 5.x
3.3. Akeeba Ticket System 5.x from Joomla 4.0–4.2 to Joomla 4.3
4. Installing Akeeba Ticket System
4.1. Installing or manually updating the component
4.1.1. Install from URL
4.1.2. Upload and install.
5. Upgrading from Core to Professional
6. Automatic updates
6.1. Troubleshooting the update
6.1.1. Addressing server issues
6.1.2. Check the validity of your Download ID
6.1.2.1. Check your subscription status
6.1.2.2. Multiple Professional edition Akeeba extensions with different Download IDs
6.1.2.3. Entering or changing your Download ID after an update is available
6.1.3. Updates are showing after installing the latest version
6.1.4. Updates not showing despite having an older version
6.1.4.1. Check the update site
6.1.4.2. Refresh the update cache
6.1.5. Miscellaneous troubleshooting and information
6.1.5.1. The update fails to download
6.1.5.2. Updating with a third party service fails
6.1.5.3. Manual update
6.1.5.4. Update installation problems
7. Entering your Download ID
8. Requesting support and reporting bugs
9. Uninstallation
2. Overview and Quick Setup
1. Overview
2. Quick Setup
3. Deep dive into advanced features
1. Permissions
2. Configuring Joomla's WYSIWYG editor (TinyMCE)
2.1. In-line images
3. Attachments
4. User custom fields
4.1. Avatar (profile image)
4.2. Country
5. Custom fields
5.1. Custom fields in Categories
5.2. Custom fields in Tickets
5.2.1. Support staff–only fields
5.2.2. Client–only fields
5.2.3. Conditional fields (or how to ask clients for additional information)
5.2.4. Replacing the geolocation field
6. Tags
6.1. Support staff–only tags
7. Nested Categories
8. InstantSearch
8.1. Smart Search menu items
8.2. External search engine
9. Guest tickets
10. Receiving email
10.1. The plugin options
10.2. Integrating with GMail / G Suite
10.2.1. Initial Configuration
10.2.2. Troubleshooting
10.2.3. Frequently asked questions
10.3. Integration with Microsoft 365, Office 365 (or whatever Microsoft calls it this week)
10.3.1. Applicability
10.3.2. Overview
10.3.3. Initial Configuration
11. Customising the frontend layout
11.1. Component view template overrides
11.1.1. Custom fields in view template overrides
11.1.2. Layout overrides
11.2. Module view template overrides
11.3. Media (CSS, JavaScript and image) overrides
11.4. Language overrides
12. Custom module positions in the front-end
13. CRON jobs to set the ticket system offline
4. The Component
1. The Control Panel page
2. Component Options
2.1. Common
2.2. Frontend
2.3. Categories View
2.4. Tickets view
2.5. InstantSearch
2.6. Attachments
2.7. Security
2.8. Automation
2.9. Permissions
3. Categories
4. Tickets
4.1. Editing a ticket
5. Canned Replies
6. Email Templates
6.1. Allowed variables in e-mails
7. Auto–replies
8. The menu item types
5. The plugins
1. The “ats” plugins
1.1. Automatically close old tickets
1.2. Automatic replies
1.3. Delete Manager Notes on ticket close / unpublish
1.4. Fetch email
1.5. Remove Obsolete Attachments
1.6. Web Push Notifications
1.6.1. Subscribing to push notifications
1.6.2. Plugin options
1.6.3. Technical notes
2. The “actionlog” plugins
2.1. Action Log plugin
3. The “console” plugins
3.1. Akeeba Ticket System
4. The “content” plugins
4.1. Akeeba Ticket System Custom Fields Show–on Behavior
5. The “editors-xtd” plugins
5.1. Akeeba Ticket System Canned Replies
6. The “finder” plugins
6.1. Akeeba Ticket System
7. The “user” plugins
7.1. Akeeba Ticket System
6. The modules
1. Administrator modules
1.1. Ticket Graphs
1.2. Ticket Stats
2. Site modules
2.1. Tickets info
7. Automation and CRON scripts
1. CLI script for CRON jobs
2. URL for CRON jobs
3. CRON commands
8. Joomla API integration
1. Requirements and setup
2. API conventions
2.1. Authentication
2.2. Base URL
2.3. Response format
2.4. Error responses
2.5. List ordering and pagination
2.6. User information objects
3. Categories
3.1. List categories — GET /v1/ats/categories
3.2. Show a category — GET /v1/ats/categories/:id
4. Tickets
4.1. Ticket resource fields
4.2. List tickets — GET /v1/ats/tickets
4.3. Show a ticket — GET /v1/ats/tickets/:id
4.4. Create a ticket — POST /v1/ats/tickets
4.5. Update a ticket — PATCH /v1/ats/tickets/:id
4.6. Delete a ticket — DELETE /v1/ats/tickets/:id
5. Posts (replies)
5.1. Post resource fields
5.2. List posts
5.3. Show a post — GET /v1/ats/posts/:id
5.4. Create a post (reply) — POST /v1/ats/tickets/:ticket_id/posts
5.5. Update a post — PATCH /v1/ats/posts/:id
5.6. Delete a post — DELETE /v1/ats/posts/:id
6. Attachments
6.1. Attachment resource fields
6.2. List attachments
6.3. Show an attachment — GET /v1/ats/attachments/:id
6.4. Upload an attachment — POST /v1/ats/posts/:post_id/attachments
6.5. Download an attachment — GET /v1/ats/attachments/:id/download
6.6. Delete an attachment — DELETE /v1/ats/attachments/:id
7. Manager notes
7.1. Manager note resource fields
7.2. List manager notes
7.3. Show a manager note — GET /v1/ats/notes/:id
7.4. Create a manager note — POST /v1/ats/tickets/:ticket_id/notes
7.5. Update a manager note — PATCH /v1/ats/notes/:id
7.6. Delete a manager note — DELETE /v1/ats/notes/:id
8. Endpoint summary
PrevNext
Akeeba Ticket System for Joomla!™ HomeChapter1.Introduction and installation