CREATECAPABILITY()`¶

About CreateCapability¶

Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

Method Signature¶

METHODS /AWS1/IF_BDI~CREATECAPABILITY
  IMPORTING
    !IV_NAME TYPE /AWS1/BDICAPABILITYNAME OPTIONAL
    !IV_TYPE TYPE /AWS1/BDICAPABILITYTYPE OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_BDICAPABILITYCONF OPTIONAL
    !IT_INSTRUCTIONSDOCUMENTS TYPE /AWS1/CL_BDIS3LOCATION=>TT_INSTRUCTIONSDOCUMENTS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDISTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BDITAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdicrecapabilityrsp
  RAISING
    /AWS1/CX_BDIACCESSDENIEDEX
    /AWS1/CX_BDICONFLICTEXCEPTION
    /AWS1/CX_BDIINTERNALSERVEREX
    /AWS1/CX_BDIRESOURCENOTFOUNDEX
    /AWS1/CX_BDISERVICEQUOTAEXCDEX
    /AWS1/CX_BDITHROTTLINGEX
    /AWS1/CX_BDIVALIDATIONEX
    /AWS1/CX_BDICLIENTEXC
    /AWS1/CX_BDISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/BDICAPABILITYNAME` `/AWS1/BDICAPABILITYNAME`¶

Specifies the name of the capability, used to identify it.

`iv_type` `TYPE /AWS1/BDICAPABILITYTYPE` `/AWS1/BDICAPABILITYTYPE`¶

Specifies the type of the capability. Currently, only edi is supported.

`io_configuration` `TYPE REF TO /AWS1/CL_BDICAPABILITYCONF` `/AWS1/CL_BDICAPABILITYCONF`¶

Specifies a structure that contains the details for a capability.

Optional arguments:¶

`it_instructionsdocuments` `TYPE /AWS1/CL_BDIS3LOCATION=>TT_INSTRUCTIONSDOCUMENTS` `TT_INSTRUCTIONSDOCUMENTS`¶

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

`iv_clienttoken` `TYPE /AWS1/BDISTRING` `/AWS1/BDISTRING`¶

Reserved for future use.

`it_tags` `TYPE /AWS1/CL_BDITAG=>TT_TAGLIST` `TT_TAGLIST`¶

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdicrecapabilityrsp` `/AWS1/CL_BDICRECAPABILITYRSP`¶

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->createcapability(
  io_configuration = new /aws1/cl_bdicapabilityconf(
    io_edi = new /aws1/cl_bdiediconfiguration(
      io_inputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |string|
        iv_key = |string|
      )
      io_outputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |string|
        iv_key = |string|
      )
      io_type = new /aws1/cl_bdieditype(
        io_x12details = new /aws1/cl_bdix12details(
          iv_transactionset = |string|
          iv_version = |string|
        )
      )
      iv_capabilitydirection = |string|
      iv_transformerid = |string|
    )
  )
  it_instructionsdocuments = VALUE /aws1/cl_bdis3location=>tt_instructionsdocuments(
    (
      new /aws1/cl_bdis3location(
        iv_bucketname = |string|
        iv_key = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_bditag=>tt_taglist(
    (
      new /aws1/cl_bditag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_name = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_capabilityid = lo_result->get_capabilityid( ).
  lv_resourcearn = lo_result->get_capabilityarn( ).
  lv_capabilityname = lo_result->get_name( ).
  lv_capabilitytype = lo_result->get_type( ).
  lo_capabilityconfiguration = lo_result->get_configuration( ).
  IF lo_capabilityconfiguration IS NOT INITIAL.
    lo_ediconfiguration = lo_capabilityconfiguration->get_edi( ).
    IF lo_ediconfiguration IS NOT INITIAL.
      lv_capabilitydirection = lo_ediconfiguration->get_capabilitydirection( ).
      lo_editype = lo_ediconfiguration->get_type( ).
      IF lo_editype IS NOT INITIAL.
        lo_x12details = lo_editype->get_x12details( ).
        IF lo_x12details IS NOT INITIAL.
          lv_x12transactionset = lo_x12details->get_transactionset( ).
          lv_x12version = lo_x12details->get_version( ).
        ENDIF.
      ENDIF.
      lo_s3location = lo_ediconfiguration->get_inputlocation( ).
      IF lo_s3location IS NOT INITIAL.
        lv_bucketname = lo_s3location->get_bucketname( ).
        lv_s3key = lo_s3location->get_key( ).
      ENDIF.
      lo_s3location = lo_ediconfiguration->get_outputlocation( ).
      IF lo_s3location IS NOT INITIAL.
        lv_bucketname = lo_s3location->get_bucketname( ).
        lv_s3key = lo_s3location->get_key( ).
      ENDIF.
      lv_transformerid = lo_ediconfiguration->get_transformerid( ).
    ENDIF.
  ENDIF.
  LOOP AT lo_result->get_instructionsdocuments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_bucketname = lo_row_1->get_bucketname( ).
      lv_s3key = lo_row_1->get_key( ).
    ENDIF.
  ENDLOOP.
  lv_createddate = lo_result->get_createdat( ).
ENDIF.

Sample CreateCapability call¶

Sample CreateCapability call

DATA(lo_result) = lo_client->createcapability(
  io_configuration = new /aws1/cl_bdicapabilityconf(
    io_edi = new /aws1/cl_bdiediconfiguration(
      io_inputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |test-bucket|
        iv_key = |input/|
      )
      io_outputlocation = new /aws1/cl_bdis3location(
        iv_bucketname = |test-bucket|
        iv_key = |output/|
      )
      io_type = new /aws1/cl_bdieditype(
        io_x12details = new /aws1/cl_bdix12details(
          iv_transactionset = |X12_110|
          iv_version = |VERSION_4010|
        )
      )
      iv_transformerid = |tr-9a893cf536df4658b|
    )
  )
  it_instructionsdocuments = VALUE /aws1/cl_bdis3location=>tt_instructionsdocuments(
    (
      new /aws1/cl_bdis3location(
        iv_bucketname = |test-bucket|
        iv_key = |instructiondoc.txt|
      )
    )
  )
  it_tags = VALUE /aws1/cl_bditag=>tt_taglist(
    (
      new /aws1/cl_bditag(
        iv_key = |capabilityKey1|
        iv_value = |capabilityValue1|
      )
    )
  )
  iv_clienttoken = |foo|
  iv_name = |b2biexample|
  iv_type = |edi|
).

/AWS1/IF_BDI=>CREATECAPABILITY()¶