Wait for the Workflow output data Id being able to be identified, then if that is the case, get and return the output data information.

Loop waiting for a workflow invocation to reach a terminal state. It refresh invocation information, with a 'delay' between 2 requests. Stop as soon as 'terminal_state' is TRUE or at the end of 'duration_max'. In case of 'scheduled' terminal state, it is possible to access to invocation outputs information. In any other state (other terminal state than 'scheduled' or non terminal state), invocation outputs information are not accessible.

waitWorkflowOutputDataIdent(
  env,
  invocation_id,
  delay,
  duration_max,
  with_more_invocation_report = FALSE,
  v
)

Arguments

env

Siwaa environment

invocation_id

Invocation Id.

delay

Delay (invocation survey). Unit : second.

duration_max

Duration max (invocation survey) Unit : second.

with_more_invocation_report

Boolean to ask or not for more invocation reports.

v

Boolean to choose 'verbose' or 'silent' mode.

Value

output_data_info Output data information, containing output_data_info$history_id, output_data_info$creating_job...

output_data_identified Boolean to know if output_data_info valid

terminal_state Boolean,

invocation_scheduled Boolean,

invocation_info Workflow invocation information

summary_invocation_reports Some invocation reports summary, always returned (invocation_summary_info, invocation_step_jobs_summary_info).

output_data_reports Output data reports, always returned (dataset_provenance). Value NULL if not output_data_identified.

invocation_reports Some invocation reports, returned in case of with_more_invocation_report (invocation_steps_info, invocation_report).

message

Details

It is possible to set the survey step between 2 requests ('delay') and the survey total duration ('duration_max').

Possible returned situations at the end of survey :

• 'terminal_state' TRUE, 'invocation_scheduled' TRUE : Invocation in 'scheduled' terminal state, 'output_data_identified' TRUE.

• 'terminal_state' TRUE, 'invocation_scheduled' FALSE : Invocation in a terminal state other than 'scheduled' (will never be scheduled), 'output_data_identified' FALSE.

• 'terminal_state' FALSE, 'invocation_scheduled' FALSE : Invocation not yet in a terminal state, 'output_data_identified' FALSE. In that case 'waitWorkflowOutputDataIdent' can be called again to continue survey.

To previously launch the workflow invocation : the 'launchWorkflow' method can be used.