Class TicketCategoryEntity

This entity describes the meta data for a ticket category, and provides special operations on it.

Carrier object for TicketCategoryEntity. Services for the TicketCategoryEntity Carrier is available from the List Agent.

Inheritance
object
TicketCategoryEntity
Implements
Namespace: SuperOfficeCRMServices
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class TicketCategoryEntity : Carrier, IExtraFieldCarrier
Examples

Get TicketCategoryEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ListAgent();
   var ticketCategoryEntity = agent.GetTicketCategoryEntity( 123 );
}

Constructors

TicketCategoryEntity()

Default constructor

Declaration
public TicketCategoryEntity()

Properties

AssignmentLag

Number of minutes we shall override the assignment if a customer sends consecutive messages to this category

Declaration
[DataMember]
public virtual int AssignmentLag { get; set; }
Property Value
Type Description
int

CategoryMaster

The user associated with this category.

Declaration
[DataMember]
public virtual int CategoryMaster { get; set; }
Property Value
Type Description
int

ClosingStatus

Determines the default status used in the GUI when creating a ticket

Declaration
[DataMember]
public virtual TicketCategoryClosingStatus ClosingStatus { get; set; }
Property Value
Type Description
SuperOffice.Data.TicketCategoryClosingStatus

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
[DataMember]
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
SuperOffice.CRM.Services.StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example: 

'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example: 

'SuperOffice:1' = '[I:123]'

DefaultMessageStatus

Default status for new messages, if 0 then there is a fallback to a user-dependent value

Declaration
[DataMember]
public virtual TicketStatusEntity DefaultMessageStatus { get; set; }
Property Value
Type Description
TicketStatusEntity

DefaultTicketStatus

Default status for new tickets, if 0 then there is a fallback to a user-dependent value

Declaration
[DataMember]
public virtual TicketStatusEntity DefaultTicketStatus { get; set; }
Property Value
Type Description
TicketStatusEntity

DelegateMethod

An integer indicating the delegation method for this category.

Declaration
[DataMember]
public virtual TicketCategoryDelegateMethod DelegateMethod { get; set; }
Property Value
Type Description
SuperOffice.Data.TicketCategoryDelegateMethod

EffectiveReplyTemplateId

Id of reply template to merge into messages, whose ticket belongs to this category. Also takes into account 'Apply to subcategories' on parent categories. This is a calculated, readonly field.

Declaration
[DataMember]
public virtual int EffectiveReplyTemplateId { get; set; }
Property Value
Type Description
int

ExternalName

The external name for this category, used for the customer frontend.

Declaration
[DataMember]
public virtual string ExternalName { get; set; }
Property Value
Type Description
string

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
[DataMember]
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
SuperOffice.CRM.Services.StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).

Flags

A bitmask representing flags for this category.

Declaration
[DataMember]
public virtual TicketCategoryFlags Flags { get; set; }
Property Value
Type Description
SuperOffice.Data.TicketCategoryFlags

Fullname

The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

Declaration
[DataMember]
public virtual string Fullname { get; set; }
Property Value
Type Description
string

MsgClosingStatus

Determines the default status used in the GUI when adding a request to a ticket

Declaration
[DataMember]
public virtual TicketCategoryClosingStatus MsgClosingStatus { get; set; }
Property Value
Type Description
SuperOffice.Data.TicketCategoryClosingStatus

Name

The (short) name of this category. E.g. 'support'.

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string

NotificationEmail

Comma separated list of addresses to notify when requests are redelegated to (unassigned) in this category.

Declaration
[DataMember]
public virtual string NotificationEmail { get; set; }
Property Value
Type Description
string

ParentId

The parent category for this category. -1 if this is a toplevel category.

Declaration
[DataMember]
public virtual int ParentId { get; set; }
Property Value
Type Description
int

ReplyTemplate

Reply template to merge with messages posted in this category

Declaration
[DataMember]
public virtual int ReplyTemplate { get; set; }
Property Value
Type Description
int

TicketCategoryId

The id of the ticket category. (primary key)

Declaration
[DataMember]
public virtual int TicketCategoryId { get; set; }
Property Value
Type Description
int

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.

Implements

See Also