Windows Electric Flow agent syntax for ectool getPipelineRuntimes --filters
<p>How do I specify a filter for an element of a pipeline runtime such as <currentStage>Dev</currentStage> and/or <progressPercentage>4</progressPercentage> using ectool on Windows. My command line look something like this:</p><p>ectool getPipelineRuntimes --projectName Windows --filters ???</p><p>Getting all the runtimes yields something like this:</p><p><response requestId="1" nodeId="192.168.001.001"> <flowRuntime> <flowRuntimeId>37fc3a1c-b7d9-11ea-b996-00405694ee28</flowRuntimeId> <flowRuntimeName>Microsoft Office 365</flowRuntimeName> <allowCurrentUserToApprove>1</allowCurrentUserToApprove> <completed>0</completed> <createTime>2020-06-26T18:16:55.627Z</createTime> <currentStage>Dev</currentStage> <elapsedTime>933758123</elapsedTime> <finish>2020-06-26T18:40:42.250Z</finish> <flowId>21abe5de-732a-11ba-9fa2-00405694ee28</flowId> <flowName>21aaad5c-732a-11ba-9fa2-00405694ee28_pipelineflow</flowName> <hasManualApproval>1</hasManualApproval> <lastModifiedBy>admin</lastModifiedBy> <launchedByUser>admin</launchedByUser> <modifyTime>2020-06-26T18:40:44.178Z</modifyTime> <outcome>success</outcome> <owner>admin</owner> <pipelineId>21aaad5c-732a-11ba-9fa2-00405694ee28</pipelineId> <pipelineName>Windows</pipelineName> <progressPercentage>4</progressPercentage> <projectName>Windows</projectName> <propertySheetId>37bc3a1e-b7d9-11ba-b496-00405694ee28</propertySheetId> <restartCount>1</restartCount> <restartable>0</restartable> <runAsUser>admin</runAsUser> <stageCount>4</stageCount> <stagesToRun>["Dev","Clone","Finalize Change","Prod Impl"]</stagesToRun> <start>2020-06-26T18:16:55.627Z</start> <startingStage>Dev</startingStage> <waitingForDependency>0</waitingForDependency> <waitingForManualRetry>0</waitingForManualRetry> <waitingForPrecondition>0</waitingForPrecondition> <waitingManualRetryCount>0</waitingManualRetryCount> </flowRuntime> . . . </response></p>
I think what you need is related to the CloudBees CD (Flow) properties system (look up "properties" in the documentation). You don't need to use an API to retrieve a property value (you can, but it's much easier not to). To get the specific value you're looking for use the substitution:
$[/myStageRuntime/stageName]
@gregm - I am not working with a specific pipeline run. I am using ectool in the Windows agent to pull info on all runs for a pipeline that meet certain criteria. Right now all I am able to do is pull the xml for all runs within a specific project and pipeline into a variable within Powershell. Then I have to do a Where-Object on the Windows server running the Powershell script to find those that meet the criteria, i.e. currentStage -eq 'Dev'. It's fine right now as we are just beginning to use pipelines to track Windows application packaging, testing and installations, but when we have thousands of runs returning from the database it will take a lot of processing in Powershell. It would be better if I could pass the filter to the EFlow core server and have it filtered there instead of on the Windows server that is running the Powershell script. That way only the active runs I am looking for are returned in the xml from EFlow to the Poweshell script.
I'm checking with engineering on this. In the meantime, this example may help
https://github.com/electric-cloud-community/DSL-Samples/blob/master/findObjectsSample.dsl
Perhaps you can use the findObjects API, for example ectool findObjects flowRuntime --filters "[{propertyName => 'projectName', operator => 'equals', operand1 => 'Default'},{propertyName=>'stageName', operator => 'equals', operand1 => 'Stage 1'}]" [1]:
https://docs.beescloud.com/docs/cloudbees-cd/latest/flow-api/apimisc#_getobjects
@gregm - Thanks. That's just what I needed. It shows me how to configure one or more filters.
