ASM Legacy Product Documentation

Add Note Transactions

Add Note transactions are used to add notes to calls, requests and tasks.

Limited Support/End of Life Capabilities

The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact Alemba Support

AddNote Transaction

The AddNote transaction can be used to add a note to an existing call, request or task. In this transaction, the entity type to which to add the note is specified as an enumerated value.

Input Parameters: AddNoteRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Call / Request / Task number to which the note is added.

eEntityType

Enumerated

Yes

This is mandatory in ASM, despite the third party documentation suggesting that it can be optional in some cases.

-

Entity to which to add a note. Values:

  • Call

  • Request

  • Task

bIsHTML

Boolean

No

False

Format in which Note Text will be added. Values:

  • True = Note Text will be added in HTML format.

  • False = Note Text will be added in Plain Text format.

sNoteText

String

No

“”

Note contents to be added to the call / request / task.

bEmail

Boolean

No

False

Send an email to the currently assigned analyst/group regarding this note. Values:

  • True = Send email to the currently assigned analyst/group

  • False = No email will be sent to the assigned analyst/group regarding this note.

bEmailForum

Boolean

No

False

Only applies to notes added to Calls.

Send an email to forum members on the call about this note. Values:

  • True = Send email to forum members regarding this note

  • False = No email will be sent to forum analysts regarding this note.

bInternal

Boolean

No

False

Send an internal message to the currently assigned analyst/group regarding this note. Values:

  • True = Send internal message to the currently assigned analyst/group

  • False = No internal message will be sent regarding this note.

bPager

Boolean

No

False

Send a pager message to the currently assigned analyst/group regarding this note. Values:

  • True = Send pager message to the currently assigned analyst/group

  • False = No pager message will be sent regarding this note.

yPortal

Yes/No

No

No

Publish this note on Self Service Portal? Values:

  • Yes = Note will be available to view on the Portal

  • No = Note will not be available to view on the Portal.

lSecurityProfile

Lookup Field

No

0

Security Profile to apply to the note

sReason

String

No

“”

Audit reason.

If Change Reasons are mandatory, this field is mandatory.

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: AddNoteResponse

Argument

Type

Description

nEntityRef

Integer

Call / Request / Task number to which the note was added

sMessage

String

Error/Warning Message returned from the API Transaction

Ret

APIReturn

Error/Warning Message returned from the API Transaction