ServiceDeskDefinition

id="decimal"

A unique identifier.

Name

string

The name of the service desk definition.

Description

string

A brief description of the service desk definition.

RequireTime

boolean

If true, entering hours worked is required.

DisplayMachineInfo

boolean

If true, machine lookup field is displayed.

RequireMachineInfo

boolean

If true, machine lookup association is required.

DisplayOrgInfo

boolean

If true, organization lookup field is displayed.

RequireOrgInfo

boolean

If true, organization lookup association is required.

DisplayCI

boolean

obsolete

RequireCI

boolean

obsolete

AllAdmins

boolean

obsolete

AutoStartClock

boolean

If true, a clock is automatically started when the user starts to edit the ticket.

AutoSaveClock

boolean

If true, when the ticket is saved, the difference between the current time and the start time is entered as the Hours Worked.

AutoInsertNote

boolean

If true, notes are automatically added to each ticket for the changes made to the ticket.

AutoInsertNoteHidden

boolean

If true, automatically generated notes are made hidden.

NeedStatusNote

boolean

obsolete

SDPrefix

string

The prefix code added to the beginning of the ticket ID.

DefaultStatus

decimal

Default status value.

DefaultStage

decimal

Default stage value.

DefaultPriority

decimal

Default priority value.

DefaultSeverity

decimal

Default severity value.

DefaultResolution

decimal

Default resolution value.

DefaultCategory

decimal

Default category value.

DefaultSubCategory

decimal

obsolete

DefaultServiceDesk

boolean

If true, this is the default service desk, the first one selected when creating new tickets.

TemplateName

string

The template file used to initially create the service desk. Not used otherwise.

TemplateType

int

The type of service desk – 1=ticket, 3=knowledge base

SequenceName

string

For internal development use only.

EditingTemplate

string

The name of the form used to edit tickets for the service desk.

EmailReader

string

The email reader associated with the service desk.

Administrator

string

The user that is the “desk administrator” of the service desk. The desk administrator is notified of certain errors within the service desk.

DefaultPolicy

string

The default policy assigned to the desk.

Status

Returns a list of child elements of each Status value in the service desk.

Priority

Returns a list of child elements of each Priority value in the service desk.

Severity

Returns a list of child elements of each Severity value in the service desk.

Resolution

Returns a list of child elements of each Resolution value in the service desk.

Categories

Returns a list of child elements of each Category value in the service desk. Each Category can include child SubCategory elements if they exist.

Stages

Returns a list of child elements of each Stage value in the service desk. Each Stage is identified by a Begin, Middle, or End stagetype attribute. Each stage has the following child elements:

• Item - The name of the stage.
• Initialization - The Stage Entry procedure linked to the stage.
• Escalation - The Escalation procedure linked to the stage. Time and Units are specified as attributes.
• Goal - The Goal linked to the stage. The Goal procedure linked to the stage. Time and Units are specified as attributes.
• NextStage - The Stage Exit procedure linked to the stage.

Participants

decimal

obsolete

CurrentContact

Contact information about the user logged on during this transaction. If the user is associated with a staff record, then the CurrentContact information is culled from the staff record. If the currently logged on user is a machine user using Portal Access, then CurrentContact information is culled from the Home > Change Profile tab of Portal Access.

• ContactName
• PhoneNumber
• Organization
• EmailAddress

SubmitterTypes

string

Type of person submitting the ticket:

• UNKNOWN
• PARTICIPANT - A participant is a VSA user.
• USER - Someone not known to VSA.

CustomFields

Returns zero or more Field elements, each with the following hierarchy:

• Caption - Screen caption.
• Title - Report title.
• Fieldname - Name of the field.
• FieldFormat - Data type.
• DefaultValue - Default value, if a List data type.
• Values - collection element, if a List data type.
  • Item - List item value.

AccessRights

Returns a hierarchy of child elements:

• ViewHiddenNotes - true or false
• ChangeHiddenNotes - true or false
• Field Rights>Field Right - collection elements
  • FieldName - Name of the ticket field
  • AccessType - Required, Edit, View Only, Hidden

NoteTemplates

Returns a list of note templates, each representing standard text that can be added to ticket notes.

ChangeProcedure

string

The Change Ticket procedure associated with the service desk.

GoalProcedure

decimal

The Goal procedure associated with the service desk.

Method

string

The operation that requested this response.

TransactionID

decimal

The unique message ID for this message.

ErrorMessage

string

If blank, no error was returned.

ErrorLocation

string

If blank, no error was returned.