c_SSPCommonService

Members

<static, readonly> UserTypeEnum :UserType

Description

Enumeration for user types

Properties

Name	Type	Default
`any`	UserType	any
`agent`	UserType	agent
`customer`	UserType	customer

<static, readonly> IncidentContactTypeEnum :IncidentContactType

Description

Enumeration for Incident contact types

Properties

Name	Type	Default	Description
`self_service`	IncidentContactType	self-service

<static, readonly> CaseContactTypeEnum :CaseContactType

Description

Enumeration for case contact types

Properties

Name	Type	Default	Description
`web`	CaseContactType	web

<static, readonly> IncidentDestinationFieldEnum :IncidentDestinationFieldType

Description

Enumeration for Incident destination fields allowed for settings values from user input

Properties

Name	Type	Default
`description`	IncidentDestinationFieldType	description
`shortdescription`	IncidentDestinationFieldType	shortdescription
`service`	IncidentDestinationFieldType	service
`ci`	IncidentDestinationFieldType	ci
`affecteduser`	IncidentDestinationFieldType	affecteduser
`location`	IncidentDestinationFieldType	location
`watchlist`	IncidentDestinationFieldType	watchlist

<static, readonly> LanguageEnum :LanguageType

Description

Enumeration for language codes

Properties

Name	Type	Default
`en`	LanguageType	en
`nl`	LanguageType	nl
`english`	LanguageType	en
`dutch`	LanguageType	nl

<static, readonly> QuestionTypeEnum :QuestionType

Description

Enumeration for question types supported on forms

Properties

Name	Type	Default
`text`	QuestionType	text
`textarea`	QuestionType	textarea
`combo`	QuestionType	combo
`list`	QuestionType	list
`service`	QuestionType	service
`ci`	QuestionType	ci
`lookup`	QuestionType	lookup
`watchlist`	QuestionType	watchlist

Methods

<static> stripHtml( source ) → {string}

Description

Strip html tags from a content field

Parameters

Name	Type	Description
`source`	string

Returns

<static> getExcerpt( content, maxSize ) → {string}

Description

Get a shorter version of an HTML encoded text

Parameters

Name	Type	Description
`content`	string	original content
`maxSize`	number	Maximum size of the excerpt

Returns

<static> parseJSON( jsonString ) → {Object}

Description

Parses a JSON Object using the JSON.parse() function but catches any exception if they occur.

Parameters

Name	Type	Description
`jsonString`	string

Returns

<static> getFormValues( form ) → {Object}

Description

Parse a form definition and retrieve an object with all values

Parameters

Name	Type	Description
`form`	FormDefinition

Returns

<static> _arrayFind( source, property, target ) → {Object}

Description

Find a property in an array of objects

Parameters

Name	Type	Description
`source`	Array.<Object>
`property`	string
`target`	string

Returns

<static> compareStrings( source, target ) → {boolean}

Description

Compare target against source and return true on a positive comparison (eg words in target are found in source)

Parameters

Name	Type	Description
`source`	string
`target`	string

Returns

<static> formatDate( inputDate ) → {string}

Description

Format a date into the default YYYY-MM-DD hh:mm:ss format The string is parse assumming basic assumptions of the provided dates as retrieved by SN and is certainly not foolproof if that changes The function is not change the locality of the time value

Parameters

Name	Type	Description
`inputDate`	string	Date expected as 01-Jul-2024 or 2024-Jul-01 and a few other variations

Returns

<static> convertuserToSystemDateTime( dateString ) → {string|undefined}

Description

Convert a date string (YYYY-MM-DD hh:mm:ss) into a datetime string in database format converting from user timezone to system timezone (GMT)

Parameters

Name	Type	Description
`dateString`	string

Returns

<static> convertDate( dateValue ) → {string}

Description

Convert date/time object from internal timezone (UTC) into a user local version (current user) returns a format "yyyy-MM-dd hh:mm:ss" in the local user timezone

Parameters

Name	Type	Description
`dateValue`	string	Input value in GMT as stored in SN tables

Returns

<static> getMessage( key [, args ] ) → {string}

Description

Get message wrapper that allows empty messages

Parameters

Name	Type	Attributes	Description
`key`	string
`args`	Array.<string>	<optional>

Returns

<static> compareByDisplayValue( itemA, itemB ) → {number}

Description

Compare two objects by its displayValue property

Parameters

Name	Type	Description
`itemA`	Object
`itemB`	Object

Returns

<static> compareByKeyValue( itemA, itemB ) → {number}

Description

Compare two objects by its displayValue property

Parameters

Name	Type	Description
`itemA`	Object
`itemB`	Object

c_SSPCommonService