/AWS1/CL_APCEXPERIMENTDEFN¶
Describes an experiment definition, including the target audience, feature flag, treatments, and current status.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_applicationid TYPE /AWS1/APCID /AWS1/APCID¶
The application ID.
iv_id TYPE /AWS1/APCID /AWS1/APCID¶
The experiment definition ID.
iv_name TYPE /AWS1/APCNAME /AWS1/APCNAME¶
The name of the experiment definition.
iv_hypothesis TYPE /AWS1/APCDESCRIPTION /AWS1/APCDESCRIPTION¶
The hypothesis that the experiment is designed to validate.
iv_status TYPE /AWS1/APCEXPERIMENTDEFNSTATUS /AWS1/APCEXPERIMENTDEFNSTATUS¶
The current status of the experiment definition. Valid values:
ACTIVE,IDLE,ARCHIVED.
iv_configurationprofileid TYPE /AWS1/APCID /AWS1/APCID¶
The configuration profile ID associated with the experiment.
iv_environmentid TYPE /AWS1/APCID /AWS1/APCID¶
The environment ID where the experiment runs.
iv_flagkey TYPE /AWS1/APCFLAGKEY /AWS1/APCFLAGKEY¶
The key of the feature flag used by the experiment.
iv_audiencerule TYPE /AWS1/APCRULE /AWS1/APCRULE¶
The rule that defines which users are eligible to be assigned to treatments.
iv_audiencedescription TYPE /AWS1/APCDESCRIPTION /AWS1/APCDESCRIPTION¶
A description of the intended audience for the experiment.
iv_launchcriteria TYPE /AWS1/APCDESCRIPTION /AWS1/APCDESCRIPTION¶
The conditions under which the winning treatment should be launched.
it_treatments TYPE /AWS1/CL_APCTREATMENT=>TT_TREATMENTLIST TT_TREATMENTLIST¶
The list of treatments defined for the experiment.
io_control TYPE REF TO /AWS1/CL_APCTREATMENT /AWS1/CL_APCTREATMENT¶
The control treatment used as the baseline for comparison.
iv_createdat TYPE /AWS1/APCISO8601DATETIME /AWS1/APCISO8601DATETIME¶
The date and time the experiment definition was created, in ISO 8601 format.
iv_updatedat TYPE /AWS1/APCISO8601DATETIME /AWS1/APCISO8601DATETIME¶
The date and time the experiment definition was last updated, in ISO 8601 format.
iv_kmskeyidentifier TYPE /AWS1/APCKMSKEYIDENTIFIER /AWS1/APCKMSKEYIDENTIFIER¶
The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.
Queryable Attributes¶
ApplicationId¶
The application ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
Id¶
The experiment definition ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Name¶
The name of the experiment definition.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Hypothesis¶
The hypothesis that the experiment is designed to validate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HYPOTHESIS() |
Getter for HYPOTHESIS, with configurable default |
ASK_HYPOTHESIS() |
Getter for HYPOTHESIS w/ exceptions if field has no value |
HAS_HYPOTHESIS() |
Determine if HYPOTHESIS has a value |
Status¶
The current status of the experiment definition. Valid values:
ACTIVE,IDLE,ARCHIVED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
ConfigurationProfileId¶
The configuration profile ID associated with the experiment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATIONPROFILEID() |
Getter for CONFIGURATIONPROFILEID, with configurable default |
ASK_CONFIGURATIONPROFILEID() |
Getter for CONFIGURATIONPROFILEID w/ exceptions if field has |
HAS_CONFIGURATIONPROFILEID() |
Determine if CONFIGURATIONPROFILEID has a value |
EnvironmentId¶
The environment ID where the experiment runs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTID() |
Getter for ENVIRONMENTID, with configurable default |
ASK_ENVIRONMENTID() |
Getter for ENVIRONMENTID w/ exceptions if field has no value |
HAS_ENVIRONMENTID() |
Determine if ENVIRONMENTID has a value |
FlagKey¶
The key of the feature flag used by the experiment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FLAGKEY() |
Getter for FLAGKEY, with configurable default |
ASK_FLAGKEY() |
Getter for FLAGKEY w/ exceptions if field has no value |
HAS_FLAGKEY() |
Determine if FLAGKEY has a value |
AudienceRule¶
The rule that defines which users are eligible to be assigned to treatments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIENCERULE() |
Getter for AUDIENCERULE, with configurable default |
ASK_AUDIENCERULE() |
Getter for AUDIENCERULE w/ exceptions if field has no value |
HAS_AUDIENCERULE() |
Determine if AUDIENCERULE has a value |
AudienceDescription¶
A description of the intended audience for the experiment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIENCEDESCRIPTION() |
Getter for AUDIENCEDESCRIPTION, with configurable default |
ASK_AUDIENCEDESCRIPTION() |
Getter for AUDIENCEDESCRIPTION w/ exceptions if field has no |
HAS_AUDIENCEDESCRIPTION() |
Determine if AUDIENCEDESCRIPTION has a value |
LaunchCriteria¶
The conditions under which the winning treatment should be launched.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LAUNCHCRITERIA() |
Getter for LAUNCHCRITERIA, with configurable default |
ASK_LAUNCHCRITERIA() |
Getter for LAUNCHCRITERIA w/ exceptions if field has no valu |
HAS_LAUNCHCRITERIA() |
Determine if LAUNCHCRITERIA has a value |
Treatments¶
The list of treatments defined for the experiment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TREATMENTS() |
Getter for TREATMENTS, with configurable default |
ASK_TREATMENTS() |
Getter for TREATMENTS w/ exceptions if field has no value |
HAS_TREATMENTS() |
Determine if TREATMENTS has a value |
Control¶
The control treatment used as the baseline for comparison.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTROL() |
Getter for CONTROL |
CreatedAt¶
The date and time the experiment definition was created, in ISO 8601 format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
UpdatedAt¶
The date and time the experiment definition was last updated, in ISO 8601 format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
KmsKeyIdentifier¶
The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYIDENTIFIER() |
Getter for KMSKEYIDENTIFIER, with configurable default |
ASK_KMSKEYIDENTIFIER() |
Getter for KMSKEYIDENTIFIER w/ exceptions if field has no va |
HAS_KMSKEYIDENTIFIER() |
Determine if KMSKEYIDENTIFIER has a value |