This is an automated email from the ASF dual-hosted git repository. heneveld pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/brooklyn-docs.git
The following commit(s) were added to refs/heads/master by this push: new 383bdfd1 add docs for invoke-effector on entity with arg=value 383bdfd1 is described below commit 383bdfd1a375d87d7e05516b4ee86a0ea6f8c69a Author: Alex Heneveld <a...@cloudsoft.io> AuthorDate: Mon Feb 26 14:36:43 2024 +0000 add docs for invoke-effector on entity with arg=value --- guide/blueprints/workflow/steps/steps.yaml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/guide/blueprints/workflow/steps/steps.yaml b/guide/blueprints/workflow/steps/steps.yaml index c636b05a..9cb3aae6 100644 --- a/guide/blueprints/workflow/steps/steps.yaml +++ b/guide/blueprints/workflow/steps/steps.yaml @@ -404,11 +404,14 @@ steps: - name: invoke-effector summary: Invokes an effector - shorthand: '`invoke-effector EFFECTOR`' + shorthand: '`invoke-effector EFFECTOR [ "on" ENTITY ] [ "with" ARGS ]`' input: | * `effector`: the name of the effector to invoke - * `entity`: optional entity or entity ID where the effector should be invoked - * `args`: map of argument names to values to pass to the effector + * `entity`: optional entity or entity ID where the effector should be invoked, + if not the entity where the workflow is running + * `args`: map of argument names to values to pass to the effector; + if supplied as shorthand, it expects the form `arg1=v1, arg2=v2`; + complex arguments are recommended to be passed using longhand syntax output: the returned object from the invoked effector - name: set-config