Skip to content

/AWS1/IF_CUS=>CREATECALCULATEDATTRDEFN()

About CreateCalculatedAttributeDefinition

Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.

Method Signature

METHODS /AWS1/IF_CUS~CREATECALCULATEDATTRDEFN
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IV_CALCULATEDATTRIBUTENAME TYPE /AWS1/CUSTYPENAME OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/CUSDISPLAYNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/CUSSENSITIVETEXT OPTIONAL
    !IO_ATTRIBUTEDETAILS TYPE REF TO /AWS1/CL_CUSATTRIBUTEDETAILS OPTIONAL
    !IO_CONDITIONS TYPE REF TO /AWS1/CL_CUSCONDITIONS OPTIONAL
    !IO_FILTER TYPE REF TO /AWS1/CL_CUSFILTER OPTIONAL
    !IV_STATISTIC TYPE /AWS1/CUSSTATISTIC OPTIONAL
    !IV_USEHISTORICALDATA TYPE /AWS1/CUSOPTIONALBOOLEAN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CUSTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cuscrecalculatedatt01
  RAISING
    /AWS1/CX_CUSACCESSDENIEDEX
    /AWS1/CX_CUSBADREQUESTEX
    /AWS1/CX_CUSINTERNALSERVEREX
    /AWS1/CX_CUSRESOURCENOTFOUNDEX
    /AWS1/CX_CUSTHROTTLINGEX
    /AWS1/CX_CUSCLIENTEXC
    /AWS1/CX_CUSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the domain.

iv_calculatedattributename TYPE /AWS1/CUSTYPENAME /AWS1/CUSTYPENAME

The unique name of the calculated attribute.

io_attributedetails TYPE REF TO /AWS1/CL_CUSATTRIBUTEDETAILS /AWS1/CL_CUSATTRIBUTEDETAILS

Mathematical expression and a list of attribute items specified in that expression.

iv_statistic TYPE /AWS1/CUSSTATISTIC /AWS1/CUSSTATISTIC

The aggregation operation to perform for the calculated attribute.

Optional arguments:

iv_displayname TYPE /AWS1/CUSDISPLAYNAME /AWS1/CUSDISPLAYNAME

The display name of the calculated attribute.

iv_description TYPE /AWS1/CUSSENSITIVETEXT /AWS1/CUSSENSITIVETEXT

The description of the calculated attribute.

io_conditions TYPE REF TO /AWS1/CL_CUSCONDITIONS /AWS1/CL_CUSCONDITIONS

The conditions including range, object count, and threshold for the calculated attribute.

io_filter TYPE REF TO /AWS1/CL_CUSFILTER /AWS1/CL_CUSFILTER

Defines how to filter incoming objects to include part of the Calculated Attribute.

iv_usehistoricaldata TYPE /AWS1/CUSOPTIONALBOOLEAN /AWS1/CUSOPTIONALBOOLEAN

Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

it_tags TYPE /AWS1/CL_CUSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags used to organize, track, or control access for this resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_cuscrecalculatedatt01 /AWS1/CL_CUSCRECALCULATEDATT01

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->createcalculatedattrdefn(
  io_attributedetails = new /aws1/cl_cusattributedetails(
    it_attributes = VALUE /aws1/cl_cusattributeitem=>tt_attributelist(
      ( new /aws1/cl_cusattributeitem( |string| ) )
    )
    iv_expression = |string|
  )
  io_conditions = new /aws1/cl_cusconditions(
    io_range = new /aws1/cl_cusrange(
      io_valuerange = new /aws1/cl_cusvaluerange(
        iv_end = 123
        iv_start = 123
      )
      iv_timestampformat = |string|
      iv_timestampsource = |string|
      iv_unit = |string|
      iv_value = 123
    )
    io_threshold = new /aws1/cl_custhreshold(
      iv_operator = |string|
      iv_value = |string|
    )
    iv_objectcount = 123
  )
  io_filter = new /aws1/cl_cusfilter(
    it_groups = VALUE /aws1/cl_cusfiltergroup=>tt_grouplist(
      (
        new /aws1/cl_cusfiltergroup(
          it_dimensions = VALUE /aws1/cl_cusfilterdimension=>tt_filterdimensionlist(
            (
              new /aws1/cl_cusfilterdimension(
                it_attributes = VALUE /aws1/cl_cusfiltattrdimension=>tt_attributemap(
                  (
                    VALUE /aws1/cl_cusfiltattrdimension=>ts_attributemap_maprow(
                      key = |string|
                      value = new /aws1/cl_cusfiltattrdimension(
                        it_values = VALUE /aws1/cl_cusvaluelist_w=>tt_valuelist(
                          ( new /aws1/cl_cusvaluelist_w( |string| ) )
                        )
                        iv_dimensiontype = |string|
                      )
                    )
                  )
                )
              )
            )
          )
          iv_type = |string|
        )
      )
    )
    iv_include = |string|
  )
  it_tags = VALUE /aws1/cl_custagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_custagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_custagmap_w( |string| )
      )
    )
  )
  iv_calculatedattributename = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_domainname = |string|
  iv_statistic = |string|
  iv_usehistoricaldata = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_typename = lo_result->get_calculatedattributename( ).
  lv_displayname = lo_result->get_displayname( ).
  lv_sensitivetext = lo_result->get_description( ).
  lo_attributedetails = lo_result->get_attributedetails( ).
  IF lo_attributedetails IS NOT INITIAL.
    LOOP AT lo_attributedetails->get_attributes( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_attributename = lo_row_1->get_name( ).
      ENDIF.
    ENDLOOP.
    lv_string1to255 = lo_attributedetails->get_expression( ).
  ENDIF.
  lo_conditions = lo_result->get_conditions( ).
  IF lo_conditions IS NOT INITIAL.
    lo_range = lo_conditions->get_range( ).
    IF lo_range IS NOT INITIAL.
      lv_value = lo_range->get_value( ).
      lv_unit = lo_range->get_unit( ).
      lo_valuerange = lo_range->get_valuerange( ).
      IF lo_valuerange IS NOT INITIAL.
        lv_valuerangestart = lo_valuerange->get_start( ).
        lv_valuerangeend = lo_valuerange->get_end( ).
      ENDIF.
      lv_string1to255 = lo_range->get_timestampsource( ).
      lv_string1to255 = lo_range->get_timestampformat( ).
    ENDIF.
    lv_objectcount = lo_conditions->get_objectcount( ).
    lo_threshold = lo_conditions->get_threshold( ).
    IF lo_threshold IS NOT INITIAL.
      lv_string1to255 = lo_threshold->get_value( ).
      lv_operator = lo_threshold->get_operator( ).
    ENDIF.
  ENDIF.
  lo_filter = lo_result->get_filter( ).
  IF lo_filter IS NOT INITIAL.
    lv_include = lo_filter->get_include( ).
    LOOP AT lo_filter->get_groups( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_type = lo_row_3->get_type( ).
        LOOP AT lo_row_3->get_dimensions( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            LOOP AT lo_row_5->get_attributes( ) into ls_row_6.
              lv_key = ls_row_6-key.
              lo_value_1 = ls_row_6-value.
              IF lo_value_1 IS NOT INITIAL.
                lv_filterdimensiontype = lo_value_1->get_dimensiontype( ).
                LOOP AT lo_value_1->get_values( ) into lo_row_7.
                  lo_row_8 = lo_row_7.
                  IF lo_row_8 IS NOT INITIAL.
                    lv_string1to255 = lo_row_8->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_statistic = lo_result->get_statistic( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_lastupdatedat( ).
  lv_optionalboolean = lo_result->get_usehistoricaldata( ).
  lv_readinessstatus = lo_result->get_status( ).
  lo_readiness = lo_result->get_readiness( ).
  IF lo_readiness IS NOT INITIAL.
    lv_percentageinteger = lo_readiness->get_progresspercentage( ).
    lv_text = lo_readiness->get_message( ).
  ENDIF.
  LOOP AT lo_result->get_tags( ) into ls_row_9.
    lv_key_1 = ls_row_9-key.
    lo_value_2 = ls_row_9-value.
    IF lo_value_2 IS NOT INITIAL.
      lv_tagvalue = lo_value_2->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.