Chat now with support
Chat with Support

Welcome, ApexSQL customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

KACE Systems Management Appliance 9.1 Common Documents - Administrator Guide

About the KACE Systems Management Appliance (SMA) Getting started
Configuring the appliance
Requirements and specifications Power-on the appliance and log in to the Administrator Console Access the Command Line Console Tracking configuration changes Configuring System-level and Admin-level General Settings Configure appliance date and time settings Enable Two-Factor Authentication for all users Verifying port settings, NTP service, and website access Configuring network and security settings Configuring Agent settings Configuring session timeout and auto-refresh settings Configuring locale settings Configuring the default theme Configure data sharing preferences About DIACAP compliance requirements Configuring Mobile Device Access Enable fast switching for organizations and linked appliances Linking Quest KACE appliances Configuring history settings
Setting up and using labels to manage groups of items Configuring user accounts, LDAP authentication, and SSO Using Replication Shares Managing credentials Configuring assets
About the Asset Management component Using the Asset Management Dashboard About managing assets Adding and customizing Asset Types and maintaining asset information Managing Software assets Managing physical and logical assets Maintaining and using manual asset information Managing locations Managing contracts Managing licenses Managing purchase records
Setting up License Compliance Managing License Compliance Setting up Service Desk Configure the Cache Lifetime for Service Desk widgets Creating and managing organizations Importing and exporting appliance resources
Managing inventory
Using the Inventory Dashboard Using Device Discovery Managing device inventory
About managing devices Features available for each device management method About inventory information Tracking changes to inventory settings Managing inventory information Finding and managing devices Provisioning the KACE SMA Agent Manually deploying the KACE SMA Agent Using Agentless management Adding devices manually in the Administrator Console or by using the API Forcing inventory updates Managing MIA devices Obtaining Dell warranty information
Managing applications on the Software page Managing Software Catalog inventory
About the Software Catalog Viewing Software Catalog information Adding applications to the Software Catalog Managing License assets for Software Catalog applications Associate Managed Installations with Cataloged Software Using software metering Using Application Control Update or reinstall the Software Catalog
Managing process, startup program, and service inventory Writing custom inventory rules
Deploying packages to managed devices
Distributing software and using Wake-on-LAN Broadcasting alerts to managed devices Running scripts on managed devices Managing Mac profiles Using Task Chains
Patching devices and maintaining security
About patch management Subscribing to and downloading patches Creating and managing patch schedules Managing patch inventory Managing Dell devices and updates Maintaining device and appliance security
Using reports and scheduling notifications Monitoring servers
Getting started with server monitoring Working with monitoring profiles Managing monitoring for devices Working with alerts
Using the Service Desk
Configuring Service Desk Using the Service Desk Dashboard Managing Service Desk tickets, processes, and reports
Overview of Service Desk ticket lifecycle Creating tickets from the Administrator Console and User Console Creating and managing tickets by email Viewing tickets and managing comments, work, and attachments Merging tickets Using the ticket escalation process Using Service Desk processes Using Ticket Rules Run Service Desk reports Archiving, restoring, and deleting tickets Managing ticket deletion
Managing Service Desk ticket queues About User Downloads and Knowledge Base articles Customizing Service Desk ticket settings Configuring SMTP email servers
Maintenance and troubleshooting
Maintaining the appliance Troubleshooting the KACE SMA
Appendixes Glossary About us Legal notices

About POP3 email accounts

About POP3 email accounts

You can configure the KACE SMA to receive email from POP3 servers.

To do so, you need to:

Optional. Configure Service Desk email preferences. See Configure email preferences.

If you do not use a POP3 email server, you can use the KACE SMA's built-in SMTP server to accept incoming email messages from your internal email server.

Create and configure POP3 email accounts

Create and configure POP3 email accounts

You can create and configure POP3 email accounts for use by the Service Desk users and staff.

The two accounts are:

Support@mydomain.com. This email address is used to:

The email delivered to this address is not read, but Service Desk staff is notified of the ticket changes resulting from the email.

DefaultTicketOwners@mydomain.com. This email alias is used to:
1.
Create Support@mydomain.com as a valid email address on your POP3 email server.
2.
Configure DefaultTicketOwners@mydomain.com as the Service Desk staff email alias, and add all of your Service Desk staff email addresses to it. This is the general-purpose email alias that your Service Desk staff uses to communicate with each other.
4.
Optional. Configure Service Desk email preferences. See Configure email preferences.

Configure email preferences

Configure email preferences

You can create and configure preferences for the email sent to and from the Service Desk users and staff.

By default, the Service Desk is configured to use an internal SMTP server for sending ticket-related emails. You have an option to use an external SMTP server, however, you must configure it in the appliance network settings. For more information, see Change appliance network settings.

1.
Go to the Service Desk Email Preferences page:
a.
Log in to the KACE SMA Administrator Console, http://KACE_SMA_hostname/admin. Or, if the Show organization menu in admin header option is enabled in the appliance General Settings, select an organization in the drop-down list in the top-right corner of the page next to the login information.
b.
On the left navigation bar, click Service Desk, then click Configuration.
c.
On the Configuration panel, in the Email Configuration section, click Configure Service Desk Email Preferences.
2.
On the Service Desk Email Preferences page that appears, in the Outbound Email section, select the Include "Reply above this line" text on outbound email communications check box.
a.
In the Inbound Email section, in the Ignore emails with following text in the subject field, type the words that you want to detect. You can specify multiple entries, using a semi-colon as a separator. For example: Out of Office;Mail Delivery Failure.

Option

Description

Total Emails

The maximum number of all emails the Service Desk receives and responds with email notifications. The default value is 100 emails.

Received within the interval of x minutes

The time interval in minutes during which the specified number of emails are received. The default value is one minute.

To disable this restriction, you can set to a high number such as 99999.

Option

Description

Total Emails per Ticket

The maximum number of all emails the Service Desk receives for each ticket, and responds with email notifications. The default value is 5 emails per ticket.

Received within the interval of x minutes

Specify the time interval in minutes during which the specified number of emails for each ticket are received. The default value is one minute. To disable this restriction, set this option to a high number such as 99999.

6.
Click Save.

Next, you can configure POP3 email accounts for specific Service Desk queues. For more information, see Configure queue-specific email settings.

Configuring email triggers and email templates

Configuring email triggers and email templates

You can set up triggers that automatically send email from the KACE SMA and use templates to set the content of those email messages.

The Email on Events section determines which actions trigger an email to the various KACE SMA users. Email templates determine the content of the messages.

Timing of email messages

The following email events trigger the KACE SMA to send email immediately:

Comment: The system sends email notifications for comments when users add comments and click Submit on the ticket form. When users add comments and click Save on the ticket form, however, only the Any Change notification is sent.
Ticket Closed: If the Satisfaction Survey is enabled, an email that describes the Satisfaction Survey is sent immediately when tickets are closed.

The following email events trigger the KACE SMA to send email every few minutes to prevent email overload:

Configure email triggers

You can configure email triggers for a queue. If you have multiple queues, you can configure the email triggers for each queue separately.

1.
Go to the Service Desk Queue Detail page:
a.
Log in to the KACE SMA Administrator Console, http://KACE_SMA_hostname/admin. Or, if the Show organization menu in admin header option is enabled in the appliance General Settings, select an organization in the drop-down list in the top-right corner of the page next to the login information.
b.
On the left navigation bar, click Service Desk, then click Configuration.
c.
On the Configuration panel, click Queues.
d.
Display the Queue Detail page by doing one of the following:
Select Choose Action > New.
2.
On the Queue Detail page, under Email Address, click Configure Queue Email Settings link to display the Service Desk Queue Email Settings page.
3.
On the Service Desk Queue Email Settings page, in the Email on Events section, select the options for sending email when the specified events occur. Each column represents a type of Service Desk user (role) and each row represents a ticket event.

Service Desk user (role)

Description

Owner

The person who is expected to resolve the ticket.

Submitter

The person whose issue is being resolved.

Approver

The person who can approve or reject the ticket for processing.

Ticket CC

One or more email addresses that are stored in the CC field of the ticket.

Category CC

One or more email addresses that are stored in the CC List of the Category Value of the ticket. See Configure CC lists for ticket categories.

Queue Owners

One or more owners of the ticket queue, as specified by the Owner label. This only applies to the New Ticket Via Email and New Ticket via Portal events.

When a ticket event occurs, email is sent to the selected roles or users. For example, if you select the Any Change box in the Owner column, email is sent to the ticket owner whenever the ticket is changed. For the Comment and Ticket Closed triggers, email is sent immediately. For other ticket changes, however, email is sent every few minutes to prevent email overload.

Option

Description

Any Change

Any information on the ticket is changed.

Owner Change

The ticket's Owner field is changed.

Status Change

The ticket's Status field is changed.

Comment

Information, attachments, or screen shots are added to the ticket's Comments section. The system sends email notifications for comments when users add comments and click Submit on the ticket form. When users add comments and click Save on the ticket form, however, only the Any Change notification is sent.

Approval Change

The ticket's approval status has changed.

Resolution Change

The ticket's resolution has changed.

Escalation

The ticket has not been updated to a stalled or closed status within the escalation time defined by the ticket priority.

SLA Violation

The ticket has not been resolved by its due date.

Ticket Closed

The ticket's Status field is changed to Closed. This event is used to present a Satisfaction Survey to submitters. See Using the Satisfaction Survey.

New Ticket Via Email

A user sends an email message to the Service Desk and a ticket is created.

New Ticket Via Portal

A ticket is created through the User Console.

4.
Click Save.
Configure email templates

You can configure the email templates that Service Desk uses to generate email messages for a queue. If you have multiple queues, you customize the email templates for each queue separately.

1.
Go to the Service Desk Queue Detail page:
a.
Log in to the KACE SMA Administrator Console, http://KACE_SMA_hostname/admin. Or, if the Show organization menu in admin header option is enabled in the appliance General Settings, select an organization in the drop-down list in the top-right corner of the page next to the login information.
b.
On the left navigation bar, click Service Desk, then click Configuration.
c.
On the Configuration panel, click Queues.
d.
Display the Queue Detail page by doing one of the following:
Select Choose Action > New.
2.
On the Queue Detail page, under Email Address, click Configure Queue Email Settings link to display the Service Desk Queue Email Settings page.
3.
On the Service Desk Queue Email Settings page, in the Email on Events section, click Customize Emails to display the Service Desk Email Notifications page.
4.
On the Service Desk Email Notifications page, change the following email templates as needed.

Ticket-related template

Description

Default recipients

Ticket Escalated

Used to send periodic notifications according to the Escalation Time configured for the ticket priority in the queue. For example, if tickets with the priority of High have an Escalation Time of 30 minutes, this email is sent every 30 minutes for High priority tickets until the ticket priority changes or until the ticket is closed.

Owners, the ticket CC list, and ticket Category CC list

Ticket Created from Email

Used to acknowledge that a ticket has been created through email.

Submitters

Ticket Modified

Used to notify recipients when ticket information is changed or added.

Owners and the ticket CC list

Comment Submitted

Used to notify recipients that comments have been added to tickets.

Owners, submitters, approvers, the ticket CC list, and the ticket Category CC list

Ticket Closed

Used to present a Satisfaction Survey to submitters when tickets are closed. See Using the Satisfaction Survey.

Submitters

Email Ticket Manually

Used to for messages that are forwarded using the Email Ticket action on Ticket Detail pages.

TIP: If you use HTML/Markdown, the $ticket_fields_visible token must be enclosed in the <pre> tag to prevent formatting, such as line breaks, from being discarded. For example:

<pre>$ticket_fields_visible</pre>

Manually entered by the sender

SLA Violated

Used to notify recipients that a ticket has remained open past the due date calculated using the SLA (Service Level Agreement) settings and the ticket priority.

None. Configurable on the Queue Detail page

Error-related template

Description

Recipients

Error Creating Ticket from Email

Used to notify senders that the ticket could not be created for reasons other than unknown email address.

Submitters

Unknown Email Address Response

Used to notify senders that the ticket could not be created because the submitter's email address is unknown.

Submitters

Table 6. Tokens used in all email templates

Token

Description

$helpdesk_email

The email address associated with the Service Desk queue. This address is configured on the Queue Detail page.

$helpdesk_name

The name of the Service Desk queue. This name is configured on the Queue Detail page.

$userui_url

A link to the User Console. Access to the User Console requires login credentials.

Table 7. Tokens used in ticket-related email templates

Token

Description

$change_desc

A formatted representation of the changes that were made the last time the ticket was saved, including both field changes and comments.

$last_attachment

The most recent attachment added to the ticket.

$last_comment

The most recent comment added to the ticket.

$mobile_ticket_url

A link to the ticket KACE GO mobile app. When displayed in an email on an Android or iOS mobile device, this links opens the associated ticket in the KACE GO mobile app.

$process_description

The process description. It can include important pre-requisites that the users need to complete before proceeding to create a ticket based on a process template.

$process_name

The name of the process template.

$process_status

The status of the process template such as Approval Required, Approval Timed Out, Approval Received, Approval Rejected, Process Cancelled, and Process Complete.

$process_type

The type of the process. In a default installation, only the Service Desk process type is included. You can create new process types, as required. For example, you can create a process type for accessing a specific application, or a group of applications. For more information, see Define process types.

$ticket_approver_email

The email address of the ticket approver. Having this address is especially useful for Comments email notifications.

$ticket_approver_name

The name of the ticket approver.

$ticket_approver_phone_home

Contact information for the ticket approver.

$ticket_approver_phone_mobile

Contact information for the ticket approver.

$ticket_approver_phone_pager

Contact information for the ticket approver.

$ticket_approver_phone_work

Contact information for the ticket approver.

$ticket_custom_X_label

$ticket_custom_X_value

The label and value used for a custom field, where X represents the index number of the custom field.

For example, if a queue has a ticket field labeled, CUSTOM_5, and that field is configured with the label Location Name, the system replaces $ticket_custom_5_label with the text, Location Name. The token, $ticket_custom_5_value is replaced with the ticket value that was saved for the Location Name field, such as, Topeka or Albuquerque.

By default, all ticket queues are configured with 15 custom fields, but this number can be increased as needed.

$ticket_due_date

The due date as saved on the ticket. Administrators can override automatic due dates with manual due dates if necessary.

$ticket_escalation_minutes

The time, in minutes, between periodic notifications. This time is determined by the Escalation Time configured for the ticket priority in the queue. For example, if tickets with the priority of High have an Escalation Time of 30 minutes, this email is sent every 30 minutes for High priority tickets until the ticket priority changes or until the ticket is closed. This token is typically used in the Ticket Escalated email template, to inform recipients of the frequency of email notifications.

$ticket_fields_visible

Include all the ticket fields that are visible for the user who is forwarding the ticket by email.

TIP: If you use HTML/Markdown, the $ticket_fields_visible token must be enclosed in the <pre> tag to prevent formatting, such as line breaks, from being discarded. For example:

<pre>$ticket_fields_visible</pre>

$ticket_history

The complete history of the ticket.

$ticket_history_X

A specified number of records in the ticket history. X indicates the number of records to include, beginning with the most recent.

$ticket_id

A unique identifier assigned to the ticket, also called the ticket number. Using this identifier is the primary method for users to identify tickets.

$ticket_number

A formatted version of the ticket ID. This version begins with TICK followed by a minimum of five digits. For example, a ticket with ID 4321 is displayed as TICK:04321. This format is especially useful in email Subject lines to make sure that email replies link to the correct tickets.

$ticket_owner_email

The email address of the Service Desk administrator assigned to the ticket.

$ticket_owner_name

The name of the Service Desk administrator assigned to the ticket.

$ticket_owner_phone_home

Contact information for the Service Desk administrator assigned to the ticket.

$ticket_owner_phone_mobile

Contact information for the Service Desk administrator assigned to the ticket.

$ticket_owner_phone_pager

Contact information for the Service Desk administrator assigned to the ticket.

$ticket_owner_phone_work

Contact information for the Service Desk administrator assigned to the ticket.

$ticket_priority

The priority assigned to the ticket. Default values include High, Medium, and Low.

$ticket_resolution

Information about what was done to resolve the ticket as described in the ticket’s Resolution field.

$ticket_status

The status of the ticket. Defaults include New, Opened, Closed, Need More Info, Reopened, Waiting Overdue, Waiting on Customer, and Waiting on Third Party.

$ticket_submitter_email

The email address of the submitter.

$ticket_submitter_name

The name of the submitter.

$ticket_submitter_phone_home

Contact information for the submitter.

$ticket_submitter_phone_mobile

Contact information for the submitter.

$ticket_submitter_phone_pager

Contact information for the submitter.

$ticket_submitter_phone_work

Contact information for the submitter.

$ticket_title

The title of the ticket as it appears on the Ticket Detail page.

$ticket_url

A link to the ticket in the User Console. Access to the User Console requires login credentials.

$ticket_http_url

A link to the ticket in the User Console. This format is used for backward compatibility on older systems. Access to the User Console requires login credentials.

$ticket_https_url

A secure link to the ticket in the User Console. Use this token if SSL is enabled on your appliance. This ensures that links sent through email work correctly.

$userui_url

A link to the home page of the User Console. Access to the User Console requires login credentials.

Table 8. Tokens used in error-related email templates

Token

Description

$error_text

Used to identify a problem processing the submitted tokens. This error appears when:

$quoted_mail

The content of the original email message.

$subject

The subject of the original email message.

5.
Optional: Select Use HTML/Markdown to use a simple HTML-based email instead of plain text.

For example:

Default Email Notification

Email Notification with HTML

$helpdesk_name created a ticket in response to your email to $helpdesk_email.

You can see more details and track progress on your new ticket at:

$ticket_url

<p> $helpdesk_name created a ticket in response to your email to $helpdesk_email.</p>

<br/>

<p>You can see more details and track progress on your new ticket at:

<a href="$ticket_url">Click here</a>

</p>

6.
Click Save.

For instructions on how to configure the appliance to use SMTP email, see Configuring SMTP email servers.

Related Documents