Skip to content

/AWS1/IF_SMC=>STARTENGAGEMENT()

About StartEngagement

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Method Signature

METHODS /AWS1/IF_SMC~STARTENGAGEMENT
  IMPORTING
    !IV_CONTACTID TYPE /AWS1/SMCSSMCONTACTSARN OPTIONAL
    !IV_SENDER TYPE /AWS1/SMCSENDER OPTIONAL
    !IV_SUBJECT TYPE /AWS1/SMCSUBJECT OPTIONAL
    !IV_CONTENT TYPE /AWS1/SMCCONTENT OPTIONAL
    !IV_PUBLICSUBJECT TYPE /AWS1/SMCPUBLICSUBJECT OPTIONAL
    !IV_PUBLICCONTENT TYPE /AWS1/SMCPUBLICCONTENT OPTIONAL
    !IV_INCIDENTID TYPE /AWS1/SMCINCIDENTID OPTIONAL
    !IV_IDEMPOTENCYTOKEN TYPE /AWS1/SMCIDEMPOTENCYTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_smcstrtengagementrslt
  RAISING
    /AWS1/CX_SMCACCESSDENIEDEX
    /AWS1/CX_SMCDATAENCEXCEPTION
    /AWS1/CX_SMCINTERNALSERVEREX
    /AWS1/CX_SMCRESOURCENOTFOUNDEX
    /AWS1/CX_SMCTHROTTLINGEX
    /AWS1/CX_SMCVALIDATIONEX
    /AWS1/CX_SMCCLIENTEXC
    /AWS1/CX_SMCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_contactid TYPE /AWS1/SMCSSMCONTACTSARN /AWS1/SMCSSMCONTACTSARN

The Amazon Resource Name (ARN) of the contact being engaged.

iv_sender TYPE /AWS1/SMCSENDER /AWS1/SMCSENDER

The user that started the engagement.

iv_subject TYPE /AWS1/SMCSUBJECT /AWS1/SMCSUBJECT

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

iv_content TYPE /AWS1/SMCCONTENT /AWS1/SMCCONTENT

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

Optional arguments:

iv_publicsubject TYPE /AWS1/SMCPUBLICSUBJECT /AWS1/SMCPUBLICSUBJECT

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

iv_publiccontent TYPE /AWS1/SMCPUBLICCONTENT /AWS1/SMCPUBLICCONTENT

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

iv_incidentid TYPE /AWS1/SMCINCIDENTID /AWS1/SMCINCIDENTID

The ARN of the incident that the engagement is part of.

iv_idempotencytoken TYPE /AWS1/SMCIDEMPOTENCYTOKEN /AWS1/SMCIDEMPOTENCYTOKEN

A token ensuring that the operation is called only once with the specified details.

RETURNING

oo_output TYPE REF TO /aws1/cl_smcstrtengagementrslt /AWS1/CL_SMCSTRTENGAGEMENTRSLT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startengagement(
  iv_contactid = |string|
  iv_content = |string|
  iv_idempotencytoken = |string|
  iv_incidentid = |string|
  iv_publiccontent = |string|
  iv_publicsubject = |string|
  iv_sender = |string|
  iv_subject = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_ssmcontactsarn = lo_result->get_engagementarn( ).
ENDIF.