Skip to content

/AWS1/IF_DFM=>SCHEDULERUN()

About ScheduleRun

Schedules a run.

Method Signature

METHODS /AWS1/IF_DFM~SCHEDULERUN
  IMPORTING
    !IV_PROJECTARN TYPE /AWS1/DFMAMAZONRESOURCENAME OPTIONAL
    !IV_APPARN TYPE /AWS1/DFMAMAZONRESOURCENAME OPTIONAL
    !IV_DEVICEPOOLARN TYPE /AWS1/DFMAMAZONRESOURCENAME OPTIONAL
    !IO_DEVICESELECTIONCONF TYPE REF TO /AWS1/CL_DFMDEVSELECTIONCONF OPTIONAL
    !IV_NAME TYPE /AWS1/DFMNAME OPTIONAL
    !IO_TEST TYPE REF TO /AWS1/CL_DFMSCHEDULERUNTEST OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_DFMSCHEDULERUNCONF OPTIONAL
    !IO_EXECUTIONCONFIGURATION TYPE REF TO /AWS1/CL_DFMEXECUTIONCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dfmschedulerunresult
  RAISING
    /AWS1/CX_DFMARGUMENTEXCEPTION
    /AWS1/CX_DFMIDEMPOTENCYEX
    /AWS1/CX_DFMLIMITEXCEEDEDEX
    /AWS1/CX_DFMNOTFOUNDEXCEPTION
    /AWS1/CX_DFMSERVICEACCOUNTEX
    /AWS1/CX_DFMCLIENTEXC
    /AWS1/CX_DFMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_projectarn TYPE /AWS1/DFMAMAZONRESOURCENAME /AWS1/DFMAMAZONRESOURCENAME

The ARN of the project for the run to be scheduled.

io_test TYPE REF TO /AWS1/CL_DFMSCHEDULERUNTEST /AWS1/CL_DFMSCHEDULERUNTEST

Information about the test for the run to be scheduled.

Optional arguments:

iv_apparn TYPE /AWS1/DFMAMAZONRESOURCENAME /AWS1/DFMAMAZONRESOURCENAME

The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.

iv_devicepoolarn TYPE /AWS1/DFMAMAZONRESOURCENAME /AWS1/DFMAMAZONRESOURCENAME

The ARN of the device pool for the run to be scheduled.

io_deviceselectionconf TYPE REF TO /AWS1/CL_DFMDEVSELECTIONCONF /AWS1/CL_DFMDEVSELECTIONCONF

The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

iv_name TYPE /AWS1/DFMNAME /AWS1/DFMNAME

The name for the run to be scheduled.

io_configuration TYPE REF TO /AWS1/CL_DFMSCHEDULERUNCONF /AWS1/CL_DFMSCHEDULERUNCONF

Information about the settings for the run to be scheduled.

io_executionconfiguration TYPE REF TO /AWS1/CL_DFMEXECUTIONCONF /AWS1/CL_DFMEXECUTIONCONF

Specifies configuration information about a test run, such as the execution timeout (in minutes).

RETURNING

oo_output TYPE REF TO /aws1/cl_dfmschedulerunresult /AWS1/CL_DFMSCHEDULERUNRESULT

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->schedulerun(
  io_configuration = new /aws1/cl_dfmschedulerunconf(
    io_customerartifactpaths = new /aws1/cl_dfmcusartifactpaths(
      it_androidpaths = VALUE /aws1/cl_dfmandroidpaths_w=>tt_androidpaths(
        ( new /aws1/cl_dfmandroidpaths_w( |string| ) )
      )
      it_devicehostpaths = VALUE /aws1/cl_dfmdevicehostpaths_w=>tt_devicehostpaths(
        ( new /aws1/cl_dfmdevicehostpaths_w( |string| ) )
      )
      it_iospaths = VALUE /aws1/cl_dfmiospaths_w=>tt_iospaths(
        ( new /aws1/cl_dfmiospaths_w( |string| ) )
      )
    )
    io_deviceproxy = new /aws1/cl_dfmdeviceproxy(
      iv_host = |string|
      iv_port = 123
    )
    io_location = new /aws1/cl_dfmlocation(
      iv_latitude = '0.1'
      iv_longitude = '0.1'
    )
    io_radios = new /aws1/cl_dfmradios(
      iv_bluetooth = ABAP_TRUE
      iv_gps = ABAP_TRUE
      iv_nfc = ABAP_TRUE
      iv_wifi = ABAP_TRUE
    )
    it_auxiliaryapps = VALUE /aws1/cl_dfmamazonresrcnames_w=>tt_amazonresourcenames(
      ( new /aws1/cl_dfmamazonresrcnames_w( |string| ) )
    )
    it_vpceconfigurationarns = VALUE /aws1/cl_dfmamazonresrcnames_w=>tt_amazonresourcenames(
      ( new /aws1/cl_dfmamazonresrcnames_w( |string| ) )
    )
    iv_billingmethod = |string|
    iv_extradatapackagearn = |string|
    iv_locale = |string|
    iv_networkprofilearn = |string|
  )
  io_deviceselectionconf = new /aws1/cl_dfmdevselectionconf(
    it_filters = VALUE /aws1/cl_dfmdevicefilter=>tt_devicefilters(
      (
        new /aws1/cl_dfmdevicefilter(
          it_values = VALUE /aws1/cl_dfmdevfiltervalues_w=>tt_devicefiltervalues(
            ( new /aws1/cl_dfmdevfiltervalues_w( |string| ) )
          )
          iv_attribute = |string|
          iv_operator = |string|
        )
      )
    )
    iv_maxdevices = 123
  )
  io_executionconfiguration = new /aws1/cl_dfmexecutionconf(
    iv_accountscleanup = ABAP_TRUE
    iv_apppackagescleanup = ABAP_TRUE
    iv_jobtimeoutminutes = 123
    iv_skipappresign = ABAP_TRUE
    iv_videocapture = ABAP_TRUE
  )
  io_test = new /aws1/cl_dfmscheduleruntest(
    it_parameters = VALUE /aws1/cl_dfmtestparameters_w=>tt_testparameters(
      (
        VALUE /aws1/cl_dfmtestparameters_w=>ts_testparameters_maprow(
          value = new /aws1/cl_dfmtestparameters_w( |string| )
          key = |string|
        )
      )
    )
    iv_filter = |string|
    iv_testpackagearn = |string|
    iv_testspecarn = |string|
    iv_type = |string|
  )
  iv_apparn = |string|
  iv_devicepoolarn = |string|
  iv_name = |string|
  iv_projectarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_run = lo_result->get_run( ).
  IF lo_run IS NOT INITIAL.
    lv_amazonresourcename = lo_run->get_arn( ).
    lv_name = lo_run->get_name( ).
    lv_testtype = lo_run->get_type( ).
    lv_deviceplatform = lo_run->get_platform( ).
    lv_datetime = lo_run->get_created( ).
    lv_executionstatus = lo_run->get_status( ).
    lv_executionresult = lo_run->get_result( ).
    lv_datetime = lo_run->get_started( ).
    lv_datetime = lo_run->get_stopped( ).
    lo_counters = lo_run->get_counters( ).
    IF lo_counters IS NOT INITIAL.
      lv_integer = lo_counters->get_total( ).
      lv_integer = lo_counters->get_passed( ).
      lv_integer = lo_counters->get_failed( ).
      lv_integer = lo_counters->get_warned( ).
      lv_integer = lo_counters->get_errored( ).
      lv_integer = lo_counters->get_stopped( ).
      lv_integer = lo_counters->get_skipped( ).
    ENDIF.
    lv_message = lo_run->get_message( ).
    lv_integer = lo_run->get_totaljobs( ).
    lv_integer = lo_run->get_completedjobs( ).
    lv_billingmethod = lo_run->get_billingmethod( ).
    lo_deviceminutes = lo_run->get_deviceminutes( ).
    IF lo_deviceminutes IS NOT INITIAL.
      lv_double = lo_deviceminutes->get_total( ).
      lv_double = lo_deviceminutes->get_metered( ).
      lv_double = lo_deviceminutes->get_unmetered( ).
    ENDIF.
    lo_networkprofile = lo_run->get_networkprofile( ).
    IF lo_networkprofile IS NOT INITIAL.
      lv_amazonresourcename = lo_networkprofile->get_arn( ).
      lv_name = lo_networkprofile->get_name( ).
      lv_message = lo_networkprofile->get_description( ).
      lv_networkprofiletype = lo_networkprofile->get_type( ).
      lv_long = lo_networkprofile->get_uplinkbandwidthbits( ).
      lv_long = lo_networkprofile->get_downlinkbandwidthbits( ).
      lv_long = lo_networkprofile->get_uplinkdelayms( ).
      lv_long = lo_networkprofile->get_downlinkdelayms( ).
      lv_long = lo_networkprofile->get_uplinkjitterms( ).
      lv_long = lo_networkprofile->get_downlinkjitterms( ).
      lv_percentinteger = lo_networkprofile->get_uplinklosspercent( ).
      lv_percentinteger = lo_networkprofile->get_downlinklosspercent( ).
    ENDIF.
    lo_deviceproxy = lo_run->get_deviceproxy( ).
    IF lo_deviceproxy IS NOT INITIAL.
      lv_deviceproxyhost = lo_deviceproxy->get_host( ).
      lv_deviceproxyport = lo_deviceproxy->get_port( ).
    ENDIF.
    lv_string = lo_run->get_parsingresulturl( ).
    lv_executionresultcode = lo_run->get_resultcode( ).
    lv_integer = lo_run->get_seed( ).
    lv_amazonresourcename = lo_run->get_appupload( ).
    lv_integer = lo_run->get_eventcount( ).
    lv_jobtimeoutminutes = lo_run->get_jobtimeoutminutes( ).
    lv_amazonresourcename = lo_run->get_devicepoolarn( ).
    lv_string = lo_run->get_locale( ).
    lo_radios = lo_run->get_radios( ).
    IF lo_radios IS NOT INITIAL.
      lv_boolean = lo_radios->get_wifi( ).
      lv_boolean = lo_radios->get_bluetooth( ).
      lv_boolean = lo_radios->get_nfc( ).
      lv_boolean = lo_radios->get_gps( ).
    ENDIF.
    lo_location = lo_run->get_location( ).
    IF lo_location IS NOT INITIAL.
      lv_double = lo_location->get_latitude( ).
      lv_double = lo_location->get_longitude( ).
    ENDIF.
    lo_customerartifactpaths = lo_run->get_customerartifactpaths( ).
    IF lo_customerartifactpaths IS NOT INITIAL.
      LOOP AT lo_customerartifactpaths->get_iospaths( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_string = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_customerartifactpaths->get_androidpaths( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_customerartifactpaths->get_devicehostpaths( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lv_string = lo_run->get_weburl( ).
    lv_skipappresign = lo_run->get_skipappresign( ).
    lv_amazonresourcename = lo_run->get_testspecarn( ).
    lo_deviceselectionresult = lo_run->get_deviceselectionresult( ).
    IF lo_deviceselectionresult IS NOT INITIAL.
      LOOP AT lo_deviceselectionresult->get_filters( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_devicefilterattribute = lo_row_7->get_attribute( ).
          lv_ruleoperator = lo_row_7->get_operator( ).
          LOOP AT lo_row_7->get_values( ) into lo_row_8.
            lo_row_9 = lo_row_8.
            IF lo_row_9 IS NOT INITIAL.
              lv_string = lo_row_9->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lv_integer = lo_deviceselectionresult->get_matcheddevicescount( ).
      lv_integer = lo_deviceselectionresult->get_maxdevices( ).
    ENDIF.
    lo_vpcconfig = lo_run->get_vpcconfig( ).
    IF lo_vpcconfig IS NOT INITIAL.
      LOOP AT lo_vpcconfig->get_securitygroupids( ) into lo_row_10.
        lo_row_11 = lo_row_10.
        IF lo_row_11 IS NOT INITIAL.
          lv_securitygroupid = lo_row_11->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_vpcconfig->get_subnetids( ) into lo_row_12.
        lo_row_13 = lo_row_12.
        IF lo_row_13 IS NOT INITIAL.
          lv_subnetid = lo_row_13->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_nonemptystring = lo_vpcconfig->get_vpcid( ).
    ENDIF.
  ENDIF.
ENDIF.

To schedule a test run

The following example schedules a test run named MyRun.

DATA(lo_result) = lo_client->schedulerun(
  io_test = new /aws1/cl_dfmscheduleruntest(
    iv_testpackagearn = |arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456|
    iv_type = |APPIUM_JAVA_JUNIT|
  )
  iv_devicepoolarn = |arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456|
  iv_name = |MyRun|
  iv_projectarn = |arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456|
).