This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation.

Difference between revisions of "Tickets"

From Group-Office Groupware and CRM Documentation
Jump to: navigation, search
(→‎As guest without access to Group-Office)
(added hint to check, if system task module is installed)
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
=Under construction=
+
=New manual in progress=
  
−
==Setting it up==
+
We're working on a new manual. It's not complete but it might already be useful for you:
  
−
First you must make a decision about how users will report tickets. You can have the followin scenarios's:
+
https://www.group-office.com/docs/admin/tickets.html
  
−
#Customers don't have access and only ticket agents will enter tickets
+
With the helpdesk or tickets module you can support your customers. Delegate support calls easily and keep track of the history. Support tickets can be created by e-mail, phone or an easy web form.
−
#Customers will go to the external page at http://your.domain/modules/tickets/extern/createticket.php
+
−
#Customers will logon to Group-Office and only have read access to the tickets module (Recommended).
+
  
−
We recommend that users logon to Group-Office because then they have the rich and user friendly Group-Office interface to post and view their tickets.
+
=Setting it up=
  
−
===Defining types===
+
==Defining types==
−
Ticket types categorize the tickets. For example you could define Sales, Printer problems, Server probles etc. You can define ticket types at:
+
Ticket types categorize the tickets. For example you could define Sales, Printer problems, Server problems etc. You can define ticket types at:
  
 
Administration -> Types
 
Administration -> Types
Line 18: Line 16:
 
Per ticket type you can enable the option to send an e-mail to the ticket agents that have access to this type when a new ticket is created by a customer.  
 
Per ticket type you can enable the option to send an e-mail to the ticket agents that have access to this type when a new ticket is created by a customer.  
  
−
===E-mail templates===
+
==E-mail templates==
 
In the administration window you can set various e-mail templates that are sent to customers when they create a new ticket.
 
In the administration window you can set various e-mail templates that are sent to customers when they create a new ticket.
  
−
==Module permissions==
+
The following template variables can be used to show information about the current logged in user in the outgoing ticket email:
−
Only a member of the "Admins" user group can administrate this module. Users who have manage permissions can respond to, delegate and close tickets. Users with only "Use" permissions on the module can create tickets and view their own tickets only.
+
<pre>
 +
{user:sirmadam} Sir or Madam depending on the gender.
 +
{user:name}
 +
{user:first_name}
 +
{user:middle_name}
 +
{user:last_name}
 +
{user:initials}
 +
{user:title}
 +
{user:email}
 +
{user:home_phone}
 +
{user:fax}
 +
{user:cellular}
 +
{user:address}
 +
{user:address_no}
 +
{user:zip}
 +
{user:city}
 +
{user:state}
 +
{user:country}
 +
{user:department}
 +
{user:function}
 +
{user:department}
 +
</pre>
  
−
==Customizing the create ticket page==
 
  
−
This is only necessary if you don't want users to login to Group-Office.
+
The following template variables can be used to show information about the contact that is set in the ticket:
 +
<pre>
 +
{contact:sirmadam} Sir or Madam depending on the gender.
 +
{contact:salutation} The salutation
 +
{contact:formatted_address} Get the full address formatted according to the country standards.
  
−
You can customize the create ticket page by copying the folder:
+
{contact:first_name} First name
 +
{contact:middle_name}
 +
{contact:last_name}
 +
{contact:initials}
 +
{contact:title}
 +
{contact:email}
 +
{contact:home_phone}
 +
{contact:fax}
 +
{contact:cellular}
 +
{contact:address}
 +
{contact:address_no}
 +
{contact:zip}
 +
{contact:city}
 +
{contact:state}
 +
{contact:country}
 +
{contact:department}
 +
{contact:function}
 +
{contact:work_phone}
 +
{contact:work_fax}
 +
{contact:homepage}
 +
</pre>
  
−
<pre>modules/tickets/extern/template</pre>
+
If the contact has a company set then you can also use these variables to show the company information:
 +
<pre>
 +
{company:formatted_address} Get the full address formatted according to the country standards.
 +
{company:formatted_post_address} Get the full address formatted according to the country standards.
  
−
to a custom folder outside Group-Office.
+
{company:mtime}
−
 
+
{company:ctime}
−
then add the following line to config.php:
+
{company:crn} Company registration number
−
 
+
{company:iban}
−
<pre>$config['tickets_template_path']="/path/to/custom/template/folder/";</pre>
+
{company:vat_no}
−
 
+
{company:bank_no}
−
===Custom fields===
+
{company:comment}
−
You can also add custom fields to the create ticket template. Create the custom fields at Start menu -> Custom fields and look up the database name in the grid (eg. col_1). Add it to the page like this:
+
{company:homepage}
 +
{company:email}
 +
{company:fax}
 +
{company:phone}
 +
{company:post_zip}
 +
{company:post_country}
 +
{company:post_state}
 +
{company:post_city}
 +
{company:post_address_no}
 +
{company:post_address}
 +
{company:country}
 +
{company:state}
 +
{company:city}
 +
{company:zip}
 +
{company:address}
 +
{company:address_no}
 +
{company:name2}
 +
{company:name}
 +
{company:id}
 +
</pre>
  
 +
The following template variables can be used to show information about the ticket itself:
 
<pre>
 
<pre>
−
<input type="text" name="col_1" id="col_1" value="<?php if (isset($_POST['col_1'])) echo $_POST['col_1'];?>" />
+
{AGENT} The current ticket agent that corresponds with the contact.
 +
{MESSAGE} The current message that is about to be sent.
 +
{LINK} Hyperlink to the ticket's page.
 +
{ticket:ticket_number}
 +
{ticket:subject}
 +
{ticket:company}
 +
{ticket:first_name} Contact's first name.
 +
{ticket:middle_name} Contact's middle name.
 +
{ticket:last_name} Contact's last name.
 +
{ticket:email} Contact's email address.
 +
{ticket:phone} Contact's phone number.
 
</pre>
 
</pre>
  
−
The page will automatically process them.
+
==Permissions==
 +
You can control who is a ticket agent per ticket type. If a user has manage permissions on a ticket type he can see all of the tickets and may also claim them and reply to them. If you give a user any lower permission level, this user may only create and view his own tickets.
 +
With read only permissions users can still reply to their existing tickets, but they can't create new tickets.
 +
 
 +
===Deleting tickets===
 +
In version 4.2 and higher tickets cannot be deleted anymore by users that don't have manage permissions on the ticket module.
 +
This is done because tickets normally don't need to be deleted. (Normally the status is set to "closed").
 +
An user with "Manage permissions" on the ticket module can delete them if necessary.
  
 
=Bold tickets=
 
=Bold tickets=
Line 52: Line 134:
 
=Creating a ticket=
 
=Creating a ticket=
  
−
To create a ticket you don't need to be an user of Group-Office. So there are two scenario's.
+
To create a ticket you don't need to be a user of Group-Office. So there are two scenario's.
 
#You are a Group-Office user
 
#You are a Group-Office user
 
#You are NOT a Group-Office user
 
#You are NOT a Group-Office user
Line 61: Line 143:
 
==As a Group-Office user with access to the tickets module==
 
==As a Group-Office user with access to the tickets module==
  
−
If you are a Group-Office user but don't have access to the ticket module then you must read the "As guest without access to Group-Office" scenario.
+
If you are a Group-Office user but don't have access to the ticket module then you must read the "As guest without access to Group-Office" section.
  
−
 
+
If you are a user of Group-Office and have access to the ticket module then you can create tickets in Group-Office itself.
−
If you are an user of Group-Office and have access to the ticket module then you can create tickets in Group-Office itself.
+
  
 
You don't need to use the external webpage.
 
You don't need to use the external webpage.
  
 +
After you have created a ticket, an email will be send to the users' e-mail address with a link inside to the created ticket.
  
−
After you have created a ticket an email will be send to the users email-address with inside a link to the created ticket.
+
If you click on that link then the browser will open a new window (or tab) and you'll need to log in to Group-Office to view the ticket.
−
 
+
−
If you click on that link then the browser will open a new window (or tab) and you need to log in to Group-Office to view the ticket.
+
  
 
==As guest without access to Group-Office==
 
==As guest without access to Group-Office==
−
[[Image:Uncheck_login_required.png|right|thumb|Uncheck_login_required]]
 
−
[[Image:Alternate_url.png|right|thumb|Alternate_url]]
 
  
−
If you are NOT an user of Group-Office then you will need to use the external webpage to create a ticket.
+
Make sure the external page and anonymous access is enabled at Tickets -> Administration -> External page.
 +
 
 +
Then visit:
 +
 
 +
http://yourdomain.com/groupoffice/modules/site/index.php?r=tickets/externalpage/newTicket
 +
 
 +
=Ticket groups=
 +
With ticket groups you can share tickets between users. If users belong to the same ticket group they can see each others tickets. This can be useful if you have users that work at the same company. It's also possible to devide companies into multiple groups with a superuser who can view all tickets.
 +
 
 +
You can add ticket groups in the addressbook at the company profile. See the screenshot. Here we added group "Amsterdam" and "'s-Hertogenbosch" to the company Intermesh. We've also made Merijn Schering and John doe members of these group "Amsterdam". The result will be that all tickets created for Amsterdam will be visible to both Merijn and John.
 +
 
 +
[[Image:Ticket groups.png|Ticket groups]]
 +
 
 +
[[Image:Ticket group.png]]
 +
 
 +
Now when we create ticket for Merijn Schering it will automatically show the ticket group selection (See screenshot).
 +
 
 +
[[Image:Select ticket group.png]]
  
  
−
After you have created a ticket an email will be send to the given email-address with inside a link to the created ticket.
+
=E-mail to tickets=
 +
You can set up at least one e-mail address for the ticket system. Group-Office will periodically poll an IMAP account and convert the e-mails into tickets.  
  
−
If you click on that link then the browser will open a new window (or tab) and will show you a webpage where you can reply to the ticket.
+
First you need to [[E-mail#Setting_up_accounts|setup an e-mail account.]]
  
 +
After that has been done you can go to Tickets -> Administration -> Types -> Double click the type. In this screen you can select the IMAP account to import from. Note that mails will be deleted from the INBOX after conversion so be careful!
 +
You can set up an account for each ticket type if you like.
  
−
So for this case you don't need to log-in to Group-Office.
+
By default Group-Office installs a system task that imports it every 5 minutes. You can adjust this in the "[[Cron_user_manual#Job_dialog|Manage system tasks]]" module (if import does not work, check, if this module is installed).  
  
  
−
'''Note''': The system administrator needs to do 2 things:
+
[[File:Ticket type.png]]
−
* uncheck the "login required" checkbox for the "Ticket" page in the CMS module. (img: Uncheck_login_required)
+
−
*be sure that the "Use alternative URL" in the ticket module administration panel is also set to the url of the ticket page in the CMS system. (img: Alternate_url)
+

Latest revision as of 16:37, 13 March 2014

New manual in progress

We're working on a new manual. It's not complete but it might already be useful for you:

https://www.group-office.com/docs/admin/tickets.html

With the helpdesk or tickets module you can support your customers. Delegate support calls easily and keep track of the history. Support tickets can be created by e-mail, phone or an easy web form.

Setting it up

Defining types

Ticket types categorize the tickets. For example you could define Sales, Printer problems, Server problems etc. You can define ticket types at:

Administration -> Types

Per ticket type you can enable the option to send an e-mail to the ticket agents that have access to this type when a new ticket is created by a customer.

E-mail templates

In the administration window you can set various e-mail templates that are sent to customers when they create a new ticket.

The following template variables can be used to show information about the current logged in user in the outgoing ticket email: 

{user:sirmadam} Sir or Madam depending on the gender.
{user:name}
{user:first_name}
{user:middle_name}
{user:last_name}
{user:initials}
{user:title}
{user:email}
{user:home_phone}
{user:fax}
{user:cellular}
{user:address}
{user:address_no}
{user:zip}
{user:city}
{user:state}
{user:country}
{user:department}
{user:function}
{user:department}


The following template variables can be used to show information about the contact that is set in the ticket: 

{contact:sirmadam} Sir or Madam depending on the gender.
{contact:salutation} The salutation
{contact:formatted_address} Get the full address formatted according to the country standards.

{contact:first_name} First name
{contact:middle_name}
{contact:last_name}
{contact:initials}
{contact:title}
{contact:email}
{contact:home_phone}
{contact:fax}
{contact:cellular}
{contact:address}
{contact:address_no}
{contact:zip}
{contact:city}
{contact:state}
{contact:country}
{contact:department}
{contact:function}
{contact:work_phone}
{contact:work_fax}
{contact:homepage}

If the contact has a company set then you can also use these variables to show the company information: 

{company:formatted_address} Get the full address formatted according to the country standards.
{company:formatted_post_address} Get the full address formatted according to the country standards.

{company:mtime}
{company:ctime}
{company:crn} Company registration number
{company:iban}
{company:vat_no}
{company:bank_no}
{company:comment}
{company:homepage}
{company:email}
{company:fax}
{company:phone}
{company:post_zip}
{company:post_country}
{company:post_state}
{company:post_city}
{company:post_address_no}
{company:post_address}
{company:country}
{company:state}
{company:city}
{company:zip}
{company:address}
{company:address_no}
{company:name2}
{company:name}
{company:id}

The following template variables can be used to show information about the ticket itself: 

{AGENT} The current ticket agent that corresponds with the contact.
{MESSAGE} The current message that is about to be sent.
{LINK} Hyperlink to the ticket's page.
{ticket:ticket_number}
{ticket:subject}
{ticket:company}
{ticket:first_name} Contact's first name.
{ticket:middle_name} Contact's middle name.
{ticket:last_name} Contact's last name.
{ticket:email} Contact's email address.
{ticket:phone} Contact's phone number.

Permissions

You can control who is a ticket agent per ticket type. If a user has manage permissions on a ticket type he can see all of the tickets and may also claim them and reply to them. If you give a user any lower permission level, this user may only create and view his own tickets. With read only permissions users can still reply to their existing tickets, but they can't create new tickets.

Deleting tickets

In version 4.2 and higher tickets cannot be deleted anymore by users that don't have manage permissions on the ticket module. This is done because tickets normally don't need to be deleted. (Normally the status is set to "closed"). An user with "Manage permissions" on the ticket module can delete them if necessary.

Bold tickets

Tickets show up in bold when the customer has created or replied to a ticket. It stays bold until you reply to the customer or close the ticket.

Creating a ticket

To create a ticket you don't need to be a user of Group-Office. So there are two scenario's.

  1. You are a Group-Office user
  2. You are NOT a Group-Office user

In the following sub-items these scenario's are explained.


As a Group-Office user with access to the tickets module

If you are a Group-Office user but don't have access to the ticket module then you must read the "As guest without access to Group-Office" section.

If you are a user of Group-Office and have access to the ticket module then you can create tickets in Group-Office itself.

You don't need to use the external webpage.

After you have created a ticket, an email will be send to the users' e-mail address with a link inside to the created ticket.

If you click on that link then the browser will open a new window (or tab) and you'll need to log in to Group-Office to view the ticket.

As guest without access to Group-Office

Make sure the external page and anonymous access is enabled at Tickets -> Administration -> External page.

Then visit:

http://yourdomain.com/groupoffice/modules/site/index.php?r=tickets/externalpage/newTicket

Ticket groups

With ticket groups you can share tickets between users. If users belong to the same ticket group they can see each others tickets. This can be useful if you have users that work at the same company. It's also possible to devide companies into multiple groups with a superuser who can view all tickets.

You can add ticket groups in the addressbook at the company profile. See the screenshot. Here we added group "Amsterdam" and "'s-Hertogenbosch" to the company Intermesh. We've also made Merijn Schering and John doe members of these group "Amsterdam". The result will be that all tickets created for Amsterdam will be visible to both Merijn and John.

Ticket groups

Ticket group.png

Now when we create ticket for Merijn Schering it will automatically show the ticket group selection (See screenshot).

Select ticket group.png


E-mail to tickets

You can set up at least one e-mail address for the ticket system. Group-Office will periodically poll an IMAP account and convert the e-mails into tickets.

First you need to setup an e-mail account.

After that has been done you can go to Tickets -> Administration -> Types -> Double click the type. In this screen you can select the IMAP account to import from. Note that mails will be deleted from the INBOX after conversion so be careful! You can set up an account for each ticket type if you like.

By default Group-Office installs a system task that imports it every 5 minutes. You can adjust this in the "Manage system tasks" module (if import does not work, check, if this module is installed).


Ticket type.png

Retrieved from "http://www.group-office.com/w/index.php?title=Tickets&oldid=3793"