Skip to content

Latest commit

 

History

History
101 lines (88 loc) · 3.29 KB

ExpectStatus.md

File metadata and controls

101 lines (88 loc) · 3.29 KB
Raw

Expect status (Optimizely DXP)

Task that check the status for an environment. if environment is not in the expected status the task will fail.

Note: v2 task supports windows/ubuntu/MacOS agents. v1 task only support windows.

<= Back

Parameters

Group: Settings

DXP target environment ClientKey

[string] - required
The DXP API ClientKey for the current environment.
Example: mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9
Default value: $(ClientKey)

DXP target environment ClientSecret

[string] - required
The DXP API ClientSecret for the current environment.
Example: mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9
Default value: $(ClientSecret)

Project Id

[string] - required
The DXP project id.
Example: 1921827e-2eca-2fb3-8015-a89f016bacc5
Default value: $(DXP.ProjectId)

Target environment

[pickList] - required
Specify which environment that you want to check Integration/Preproduction/Production.
Example: Integration
Default value: $(TargetEnvironment)
Options:

  • Integration
  • Preproduction
  • Production
  • ADE1
  • ADE2
  • ADE3

Expected status

[pickList] - required
Specify the status that you expect the environment to have.
Example: AwaitingVerification
Default value: AwaitingVerification
Options:

  • AwaitingVerification
  • InProgress
  • Resetting
  • Reset
  • Succeeded

Group: Timeout

Script timeout (in seconds)

[int] - required
Specify the number of seconds when the task should timeout.
Example: 600
Default value: 1800 (30 minutes)

Group: Benchmark

Run benchmark

[boolean] - required
If you want to send information about your execution, to get benchmark data back.
If you are interested of more benchmark data you can contact Epinova.
By using this function you agree with sending over the following information: Task, TaskVersion, Environment, TargetEnvironment, DxpProjectId, OrganisationId, OrganisationName, ProjectId, ProjectName, Branch, AgentOS, EpiCloudVersion, PowerShellVersion, PowerShellEdition, Elapsed, Result, CmsFileSize, CmsPackageName, CommerceFileSize, CommercePackageName.
Example: true
Default value: false

Group: ErrorHandlingOptions

Run Verbose

[boolean] - required
If you want to run in verbose mode and see all information.
Example: true
Default value: false

ErrorActionPreference

[pickList] - required
How the task should handle errors.
Example: 600
Default value: stop
Options:

  • Stop: Terminate the action with error.
  • Continue: Display any error message and attempt to continue execution of subsequence commands.
  • SilentlyContinue: Don't display an error message continue to execute subsequent commands.

YAML

Example:

- task: DxpExpectStatus@2
    inputs:
    ClientKey: '$(ClientKey)'
    ClientSecret: '$(ClientSecret)'
    ProjectId: '$(DXP.ProjectId)'
    TargetEnvironment: 'Integration'
    ExpectedStatus: 'AwaitingVerification'
    Timeout: 1800
    RunVerbose: false
    RunBenchmark: true

<= Back