STARTCALCULATIONEXECUTION()`¶

About StartCalculationExecution¶

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

Method Signature¶

METHODS /AWS1/IF_ATH~STARTCALCULATIONEXECUTION
  IMPORTING
    !IV_SESSIONID TYPE /AWS1/ATHSESSIONID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/ATHDESCRIPTIONSTRING OPTIONAL
    !IO_CALCULATIONCONFIGURATION TYPE REF TO /AWS1/CL_ATHCALCULATIONCONF OPTIONAL
    !IV_CODEBLOCK TYPE /AWS1/ATHCODEBLOCK OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/ATHIDEMPOTENCYTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athstrtcalculatione01
  RAISING
    /AWS1/CX_ATHINTERNALSERVEREX
    /AWS1/CX_ATHINVALIDREQUESTEX
    /AWS1/CX_ATHRESOURCENOTFOUNDEX
    /AWS1/CX_ATHCLIENTEXC
    /AWS1/CX_ATHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_sessionid` `TYPE /AWS1/ATHSESSIONID` `/AWS1/ATHSESSIONID`¶

The session ID.

Optional arguments:¶

`iv_description` `TYPE /AWS1/ATHDESCRIPTIONSTRING` `/AWS1/ATHDESCRIPTIONSTRING`¶

A description of the calculation.

`io_calculationconfiguration` `TYPE REF TO /AWS1/CL_ATHCALCULATIONCONF` `/AWS1/CL_ATHCALCULATIONCONF`¶

Contains configuration information for the calculation.

`iv_codeblock` `TYPE /AWS1/ATHCODEBLOCK` `/AWS1/ATHCODEBLOCK`¶

A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

`iv_clientrequesttoken` `TYPE /AWS1/ATHIDEMPOTENCYTOKEN` `/AWS1/ATHIDEMPOTENCYTOKEN`¶

A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_athstrtcalculatione01` `/AWS1/CL_ATHSTRTCALCULATIONE01`¶

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->startcalculationexecution(
  io_calculationconfiguration = new /aws1/cl_athcalculationconf( |string| )
  iv_clientrequesttoken = |string|
  iv_codeblock = |string|
  iv_description = |string|
  iv_sessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_calculationexecutionid = lo_result->get_calculationexecutionid( ).
  lv_calculationexecutionsta = lo_result->get_state( ).
ENDIF.

/AWS1/IF_ATH=>STARTCALCULATIONEXECUTION()¶