Skip to content

/AWS1/CL_QQC=>UPDATEMESSAGETEMPLATEMET()

About UpdateMessageTemplateMetadata

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

Method Signature

IMPORTING

Required arguments:

iv_knowledgebaseid TYPE /AWS1/QQCUUIDORARN /AWS1/QQCUUIDORARN

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

iv_messagetemplateid TYPE /AWS1/QQCUUIDORARNOREITHERWQ00 /AWS1/QQCUUIDORARNOREITHERWQ00

The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

Optional arguments:

iv_name TYPE /AWS1/QQCNAME /AWS1/QQCNAME

The name of the message template.

iv_description TYPE /AWS1/QQCDESCRIPTION /AWS1/QQCDESCRIPTION

The description of the message template.

io_groupingconfiguration TYPE REF TO /AWS1/CL_QQCGROUPINGCONF /AWS1/CL_QQCGROUPINGCONF

groupingConfiguration

RETURNING

oo_output TYPE REF TO /aws1/cl_qqcupdmsgtmplmetrsp /AWS1/CL_QQCUPDMSGTMPLMETRSP

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->/aws1/if_qqc~updatemessagetemplatemet(
  io_groupingconfiguration = new /aws1/cl_qqcgroupingconf(
    it_values = VALUE /aws1/cl_qqcgroupingvalues_w=>tt_groupingvalues(
      ( new /aws1/cl_qqcgroupingvalues_w( |string| ) )
    )
    iv_criteria = |string|
  )
  iv_description = |string|
  iv_knowledgebaseid = |string|
  iv_messagetemplateid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_messagetemplatedata = lo_result->get_messagetemplate( ).
  IF lo_messagetemplatedata IS NOT INITIAL.
    lv_arnwithqualifier = lo_messagetemplatedata->get_messagetemplatearn( ).
    lv_uuid = lo_messagetemplatedata->get_messagetemplateid( ).
    lv_arn = lo_messagetemplatedata->get_knowledgebasearn( ).
    lv_uuid = lo_messagetemplatedata->get_knowledgebaseid( ).
    lv_name = lo_messagetemplatedata->get_name( ).
    lv_channelsubtype = lo_messagetemplatedata->get_channelsubtype( ).
    lv_timestamp = lo_messagetemplatedata->get_createdtime( ).
    lv_timestamp = lo_messagetemplatedata->get_lastmodifiedtime( ).
    lv_genericarn = lo_messagetemplatedata->get_lastmodifiedby( ).
    lo_messagetemplatecontentp = lo_messagetemplatedata->get_content( ).
    IF lo_messagetemplatecontentp IS NOT INITIAL.
      lo_emailmessagetemplatecon = lo_messagetemplatecontentp->get_email( ).
      IF lo_emailmessagetemplatecon IS NOT INITIAL.
        lv_nonemptyunlimitedstring = lo_emailmessagetemplatecon->get_subject( ).
        lo_emailmessagetemplatecon_1 = lo_emailmessagetemplatecon->get_body( ).
        IF lo_emailmessagetemplatecon_1 IS NOT INITIAL.
          lo_messagetemplatebodycont = lo_emailmessagetemplatecon_1->get_plaintext( ).
          IF lo_messagetemplatebodycont IS NOT INITIAL.
            lv_nonemptyunlimitedstring = lo_messagetemplatebodycont->get_content( ).
          ENDIF.
          lo_messagetemplatebodycont = lo_emailmessagetemplatecon_1->get_html( ).
          IF lo_messagetemplatebodycont IS NOT INITIAL.
            lv_nonemptyunlimitedstring = lo_messagetemplatebodycont->get_content( ).
          ENDIF.
        ENDIF.
        LOOP AT lo_emailmessagetemplatecon->get_headers( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_emailheaderkey = lo_row_1->get_name( ).
            lv_emailheadervalue = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_smsmessagetemplateconte = lo_messagetemplatecontentp->get_sms( ).
      IF lo_smsmessagetemplateconte IS NOT INITIAL.
        lo_smsmessagetemplateconte_1 = lo_smsmessagetemplateconte->get_body( ).
        IF lo_smsmessagetemplateconte_1 IS NOT INITIAL.
          lo_messagetemplatebodycont = lo_smsmessagetemplateconte_1->get_plaintext( ).
          IF lo_messagetemplatebodycont IS NOT INITIAL.
            lv_nonemptyunlimitedstring = lo_messagetemplatebodycont->get_content( ).
          ENDIF.
        ENDIF.
      ENDIF.
    ENDIF.
    lv_description = lo_messagetemplatedata->get_description( ).
    lv_languagecode = lo_messagetemplatedata->get_language( ).
    lo_groupingconfiguration = lo_messagetemplatedata->get_groupingconfiguration( ).
    IF lo_groupingconfiguration IS NOT INITIAL.
      lv_groupingcriteria = lo_groupingconfiguration->get_criteria( ).
      LOOP AT lo_groupingconfiguration->get_values( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_groupingvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_messagetemplateattribut = lo_messagetemplatedata->get_defaultattributes( ).
    IF lo_messagetemplateattribut IS NOT INITIAL.
      lo_systemattributes = lo_messagetemplateattribut->get_systemattributes( ).
      IF lo_systemattributes IS NOT INITIAL.
        lv_messagetemplateattribut_1 = lo_systemattributes->get_name( ).
        lo_systemendpointattribute = lo_systemattributes->get_customerendpoint( ).
        IF lo_systemendpointattribute IS NOT INITIAL.
          lv_messagetemplateattribut_1 = lo_systemendpointattribute->get_address( ).
        ENDIF.
        lo_systemendpointattribute = lo_systemattributes->get_systemendpoint( ).
        IF lo_systemendpointattribute IS NOT INITIAL.
          lv_messagetemplateattribut_1 = lo_systemendpointattribute->get_address( ).
        ENDIF.
      ENDIF.
      lo_agentattributes = lo_messagetemplateattribut->get_agentattributes( ).
      IF lo_agentattributes IS NOT INITIAL.
        lv_messagetemplateattribut_1 = lo_agentattributes->get_firstname( ).
        lv_messagetemplateattribut_1 = lo_agentattributes->get_lastname( ).
      ENDIF.
      lo_customerprofileattribut = lo_messagetemplateattribut->get_customerprofileattrs( ).
      IF lo_customerprofileattribut IS NOT INITIAL.
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_profileid( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_profilearn( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_firstname( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_middlename( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_lastname( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_accountnumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_emailaddress( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_phonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_additionalinformation( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_partytype( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_businessname( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_birthdate( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_gender( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mobilephonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_homephonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_businessphonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_businessemailaddress( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_city( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_county( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_country( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_postalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_province( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_state( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingcity( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingcounty( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingcountry( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingpostalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingprovince( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingstate( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingcity( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingcounty( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingcountry( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingpostalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingprovince( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingstate( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingcity( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingcounty( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingcountry( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingpostalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingprovince( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingstate( ).
        LOOP AT lo_customerprofileattribut->get_custom( ) into ls_row_4.
          lv_key = ls_row_4-key.
          lo_value = ls_row_4-value.
          IF lo_value IS NOT INITIAL.
            lv_messagetemplateattribut_1 = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      LOOP AT lo_messagetemplateattribut->get_customattributes( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_messagetemplateattribut_1 = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    LOOP AT lo_messagetemplatedata->get_attributetypes( ) into lo_row_5.
      lo_row_6 = lo_row_5.
      IF lo_row_6 IS NOT INITIAL.
        lv_messagetemplateattribut_2 = lo_row_6->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_messagetemplatecontents = lo_messagetemplatedata->get_messagetmplcontentsha256( ).
    LOOP AT lo_messagetemplatedata->get_tags( ) into ls_row_7.
      lv_key_1 = ls_row_7-key.
      lo_value_1 = ls_row_7-value.
      IF lo_value_1 IS NOT INITIAL.
        lv_tagvalue = lo_value_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.