Search documentation of StepFlow
StepFlow
▼
Project version
v1.8.1-rc8
v1.8.1-rc7
v1.8.1-rc6
v1.8.1-rc5
v1.8.1-rc4
v1.8.1-rc3
v1.8.1-rc2
v1.8.1-rc1
v1.8.1-rc0
v1.8.0
v1.8.0-rc3
v1.8.0-rc2
v1.8.0-rc1
v1.8.0-rc0
v1.7.3
v1.7.3-rc4
v1.7.3-rc3
v1.7.3-rc2
v1.7.3-rc1
v1.7.3-rc0
v1.7.2
v1.7.2-rc4
v1.7.2-rc3
v1.7.2-rc2
v1.7.2-rc1
v1.7.2-rc0
v1.7.1
v1.7.0
v1.7.0-rc1
v1.7.0-rc0
v1.6.1
v1.6.1-rc1
v1.6.1-rc0
v1.6.0
v1.6.0-rc9
v1.6.0-rc8
v1.6.0-rc7
v1.6.0-rc6
v1.6.0-rc5
v1.6.0-rc4
v1.6.0-rc3
v1.6.0-rc20
v1.6.0-rc2
v1.6.0-rc19
v1.6.0-rc18
v1.6.0-rc17
v1.6.0-rc16
v1.6.0-rc15
v1.6.0-rc14
v1.6.0-rc13
v1.6.0-rc12
v1.6.0-rc11
v1.6.0-rc10
v1.6.0-rc1
v1.5.0
v1.5.0-rc1
v1.4.2-rc2
v1.4.2-rc1
v1.4.1
v1.4.1-rc1
v1.4.0
v1.4.0-rc4
v1.4.0-rc3
v1.4.0-rc2
v1.4.0-rc1
v1.3.1
v1.3.0
v1.3.0-rc
v1.2.0
v1.1.0
v1.0.0
v1.0.0-rc9
v1.0.0-rc8
v1.0.0-rc7
v1.0.0-rc6
v1.0.0-rc5
v1.0.0-rc1
v0.2.13
v0.2.12
v0.2.11
v0.2.10
v0.2.9
v0.2.8
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.8
v0.1.7
v0.1.6
v0.1.5
v0.1.4
v0.1.3
v0.1.2
v0.1.1
v0.1.0
v0.0.24
v0.0.23
v0.0.22
v0.0.21
v0.0.20
v0.0.19
v0.0.18
v0.0.17
v0.0.16
v0.0.15
v0.0.14
v0.0.13
v0.0.12
v0.0.11
v0.0.10
v0.0.9
v0.0.8
v0.0.7
v0.0.6
v0.0.4
v0.0.3
v0.0.2
v0.0.1
Pages
Modules
API Reference
Modules
Step Flow
Usage
Workflows and Jobs State Machines
Configurations to start
StepFlow
Summary
Functions
__using__/1
controller/0
router/0
view/0
StepFlow.Amqp.CommonConsumer
Summary
Functions
create_queues/2
get_channel_check_interval/0
init_amqp_connection/4
rabbitmq_connect/5
rabbitmq_disconnect/1
StepFlow.Amqp.CommonEmitter
Summary
Functions
publish/4
publish_json/5
StepFlow.Amqp.CompletedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.ErrorConsumer
Summary
Functions
child_spec/1
consume/4
consume_error_message/5
disconnect/0
publish_parent_job_error/2
StepFlow.Amqp.Helpers
Summary
Functions
get_amqp_connection_options/0
get_amqp_connection_url/0
get_amqp_delivery_mode/0
get_amqp_message_options/1
get_amqp_server_configuration/0
StepFlow.Amqp.ProgressionConsumer
Summary
Functions
add_progression/4
child_spec/1
consume/4
disconnect/0
error_status_check/5
StepFlow.Amqp.StoppedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.Supervisor
Summary
Functions
child_spec/1
start_children/0
stop_children/0
StepFlow.Amqp.WorkerCreatedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.WorkerDiscoveryConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.WorkerInitializedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.WorkerStartedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.WorkerStatusConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.WorkerTerminatedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.Amqp.WorkerUpdatedConsumer
Summary
Functions
child_spec/1
consume/4
disconnect/0
StepFlow.ArtifactView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Artifacts
Summary
Functions
create_artifact/1
StepFlow.Authorization
Summary
Functions
call/2
check/1
check_metrics_enabled/1
init/1
StepFlow.BlackListView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.ChangesetView
Summary
Functions
__resource__/0
render/2
template_not_found/2
translate_errors/1
StepFlow.Controllers.Statistics.Durations
Summary
Functions
get_jobs_duration_statistics/1
get_workflows_duration_statistics/1
list_durations_for_jobs/1
list_durations_for_workflows/1
StepFlow.DurationStatisticsView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.DurationsView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Endpoint
Summary
Functions
broadcast/3
broadcast!/3
broadcast_from/4
broadcast_from!/4
call/2
child_spec/1
config/2
config_change/2
host/0
init/1
init/2
local_broadcast/3
local_broadcast_from/4
path/1
script_name/0
start_link/1
static_integrity/1
static_lookup/1
static_path/1
static_url/0
struct_url/0
subscribe/2
unsubscribe/1
url/0
StepFlow.ErrorHelpers
Summary
Functions
error_tag/2
translate_error/1
StepFlow.ErrorView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Gettext
Summary
Functions
dgettext/3
dgettext_noop/2
dngettext/5
dngettext_noop/3
dpgettext/4
dpgettext_noop/3
dpngettext/6
dpngettext_noop/4
gettext/2
gettext_comment/1
gettext_noop/1
handle_missing_bindings/2
handle_missing_plural_translation/7
handle_missing_translation/5
lgettext/5
lngettext/7
ngettext/4
ngettext_noop/2
pgettext/3
pgettext_noop/2
pngettext/5
pngettext_noop/3
StepFlow.JobView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Jobs
Summary
Functions
abort_jobs/3
apply_default_query_filters/2
apply_rights/2
change_job/1
copy_job/1
create_completed_job/3
create_error_job/4
create_job/1
create_paused_job/4
create_skipped_job/3
delete_job/1
filter_status/2
filter_worker_instance_id/2
filter_worker_label/2
filter_worker_version/2
get_by/1
get_by!/1
get_job/1
get_job!/1
get_job_with_status!/1
get_pending_jobs_by_type/0
get_processing_jobs_by_type/0
internal_list_jobs/1
list_jobs/1
skip_jobs/3
update_job/2
StepFlow.Jobs.Status.StateEnum
Summary
Types
t/0
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
valid_value?/1
StepFlow.LiveWorkers
Summary
Functions
change_live_worker/1
create_live_worker/1
delete_live_worker/1
get_by/1
get_by!/1
list_live_workers/1
update_live_worker/2
StepFlow.LiveWorkersView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Map
Summary
Functions
get_by_key_or_atom/3
replace_by_atom/3
replace_by_string/3
StepFlow.Metrics.JobInstrumenter
Summary
Functions
inc/3
setup/0
StepFlow.Metrics.JobsPendingCollector
Summary
Functions
collect_metrics/2
collect_mf/2
deregister_cleanup/1
StepFlow.Metrics.LiveWorkflowProcessingCollector
Summary
Functions
collect_metrics/2
collect_mf/2
deregister_cleanup/1
StepFlow.Metrics.WorkflowCollector
Summary
Functions
collect_metrics/2
collect_mf/2
deregister_cleanup/1
StepFlow.Metrics.WorkflowInstrumenter
Summary
Functions
inc/3
setup/0
StepFlow.Notification
Summary
Functions
send/2
StepFlow.NotificationEndpointView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.NotificationHooks.NotificationEndpoints
Summary
Functions
change_notification_endpoint/1
create_notification_endpoint/1
delete_notification_endpoint/1
get_notification_endpoint!/1
get_notification_endpoint_by_placeholder/1
list_notification_endpoints/1
update_notification_endpoint/2
StepFlow.NotificationHooks.NotificationHookManager
Summary
Functions
get_last_status/1
manage_notification_status/3
notification_from_job/2
notification_slack_from_job/4
notification_teams_from_job/5
notify_endpoint_with_status/7
retrieve_status/8
StepFlow.NotificationHooks.NotificationTemplates
Summary
Functions
create_notification_template/1
delete_notification_template/1
get_notification_template!/1
get_notification_template_by_name/1
list_notification_templates/1
update_notification_template/2
StepFlow.NotificationTemplateView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Progressions
Summary
Functions
create_progression/1
StepFlow.ProgressionsView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Repo
Summary
Functions
aggregate/3
aggregate/4
all/2
bypass/1
checked_out?/0
checkout/2
child_spec/1
config/0
default_options/1
delete/2
delete!/2
delete_all/2
exists?/2
explain/3
get/3
get!/3
get_by/3
get_by!/3
get_dynamic_repo/0
in_transaction?/0
init/2
insert/2
insert!/2
insert_all/3
insert_or_update/2
insert_or_update!/2
load/2
one/2
one!/2
preload/3
prepare_query/3
put_dynamic_repo/1
query/3
query!/3
reload/2
reload!/2
rollback/1
start_link/1
stop/1
stream/2
to_sql/2
transaction/2
update/2
update!/2
update_all/3
StepFlow.Repo.SupervisionTree
Summary
Functions
child_spec/1
start_link/0
StepFlow.RightDefinitionView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.RightView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Rights.Right
Summary
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
StepFlow.Rights.Right.EndpointEnum
Summary
Types
t/0
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
valid_value?/1
StepFlow.Rights.Right.RightEnum
Summary
Types
t/0
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
valid_value?/1
StepFlow.RoleView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Roles
Summary
Functions
change_role/1
create_role/1
delete_role/1
get_by/1
get_by!/1
get_role/1
get_role!/1
get_roles/2
list_roles/1
update_role/2
StepFlow.Router
Summary
Functions
api/2
call/2
init/1
StepFlow.Router.Helpers
Summary
Functions
black_list_path/2
black_list_path/3
black_list_path/4
black_list_url/2
black_list_url/3
black_list_url/4
durations_path/2
durations_path/3
durations_url/2
durations_url/3
index_path/2
index_path/3
index_path/4
index_url/2
index_url/3
index_url/4
job_path/2
job_path/3
job_path/4
job_url/2
job_url/3
job_url/4
live_workers_path/2
live_workers_path/3
live_workers_url/2
live_workers_url/3
metric_path/2
metric_path/3
metric_url/2
metric_url/3
notification_endpoint_path/2
notification_endpoint_path/3
notification_endpoint_path/4
notification_endpoint_url/2
notification_endpoint_url/3
notification_endpoint_url/4
notification_template_path/2
notification_template_path/3
notification_template_path/4
notification_template_url/2
notification_template_url/3
notification_template_url/4
path/2
render_spec_path/2
render_spec_path/3
render_spec_url/2
render_spec_url/3
right_definition_path/2
right_definition_path/3
right_definition_url/2
right_definition_url/3
role_path/2
role_path/3
role_path/4
role_url/2
role_url/3
role_url/4
static_integrity/2
static_path/2
static_url/2
statistics_path/2
statistics_path/3
statistics_url/2
statistics_url/3
url/1
worker_definition_path/2
worker_definition_path/3
worker_definition_path/4
worker_definition_url/2
worker_definition_url/3
worker_definition_url/4
workers_path/2
workers_path/3
workers_path/4
workers_url/2
workers_url/3
workers_url/4
workflow_definition_path/2
workflow_definition_path/3
workflow_definition_path/4
workflow_definition_url/2
workflow_definition_url/3
workflow_definition_url/4
workflow_path/2
workflow_path/3
workflow_path/4
workflow_status_path/2
workflow_status_path/3
workflow_status_url/2
workflow_status_url/3
workflow_url/2
workflow_url/3
workflow_url/4
workflow_workflow_events_path/3
workflow_workflow_events_path/4
workflow_workflow_events_url/3
workflow_workflow_events_url/4
StepFlow.SlackBot
Summary
Functions
child_spec/1
handle_close/3
handle_connect/2
handle_event/3
handle_info/3
StepFlow.Statistics.Helpers
Summary
Functions
limit_duration_to_milliseconds/1
StepFlow.Statistics.JobsDurations
Summary
Functions
create_job_durations/1
get_by/1
set_job_durations/1
update_job_durations/2
StepFlow.StatusView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Step
Summary
Functions
abort_step_jobs/2
pause_step/3
resume_step/1
skip_step/2
skip_step_jobs/2
start_next/1
StepFlow.Step.Helpers
Summary
Functions
add_required_paths/2
filter_empty/1
filter_empty_templated/1
filter_path_list/2
filter_untemplated/1
get_base_directory/2
get_dates/0
get_job_destination_paths/1
get_jobs_destination_paths/1
get_required_paths/2
get_step_requirements/2
get_string_or_processed_template_value/6
get_value_in_parameters/2
get_value_in_parameters_with_type/3
get_work_directory/1
template_process/5
templates_process/5
StepFlow.Step.Launch
Summary
Functions
build_requirements_and_destination_path/8
filter_and_pre_compile_parameters/5
get_required_paths/3
get_source_paths/3
launch_step/2
StepFlow.Step.LaunchJobs
Summary
Functions
generate_job_one_for_many/2
generate_job_one_for_one/2
generate_job_parameters_one_for_one/2
generate_message_one_for_many/2
generate_message_one_for_one/2
start_job/1
start_job_one_for_many/2
start_job_one_for_one/2
start_multiple_jobs_one_for_one/3
StepFlow.Step.LaunchParams
Summary
Functions
get_step_allow_failure/1
get_step_id/1
get_step_name/1
get_step_parameter/2
new/3
new/4
StepFlow.Step.LaunchWorkflows
Summary
Functions
generate_child_workflow_job/2
generate_child_workflow_params/5
start_child_workflow_one_for_many/4
start_child_workflows_one_for_one/4
StepFlow.Step.Live
Summary
Functions
create_job_live/2
generate_message/2
generate_message_live/2
stop_jobs/1
update_job_live/1
StepFlow.Updates
Summary
Functions
create_update/1
update_parameters/2
StepFlow.UpdatesView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.WebController.Fallback
StepFlow.WebController.Helpers
Summary
Functions
has_right?/3
StepFlow.WorkerDefinitionView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.WorkerDefinitions
Summary
Functions
create_worker_definition/1
exists/1
get_worker_definition!/1
list_worker_definitions/1
StepFlow.WorkerStatusView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Workers.WorkerStatus.ActivityEnum
Summary
Types
t/0
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
valid_value?/1
StepFlow.Workers.WorkerStatus.JobStatus
StepFlow.Workers.WorkerStatuses
Summary
Functions
create_worker_status/1
create_worker_status!/1
get_worker_status/1
get_worker_status!/1
get_worker_status_for_job/1
list_worker_statuses/1
update_worker_status!/2
StepFlow.WorkflowDefinitionView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.WorkflowDefinitions
Summary
Functions
delete_by_id/1
filter_by_versions/2
get_workflow_definition/1
get_workflow_definition/4
list_workflow_definitions/1
load_workflow_in_database/1
load_workflows/0
load_workflows_in_database/0
StepFlow.WorkflowDefinitions.ExternalLoader
Summary
Functions
fetch/1
StepFlow.WorkflowDefinitions.WorkflowDefinition
StepFlow.WorkflowStatusView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.WorkflowView
Summary
Functions
__resource__/0
render/2
template_not_found/2
StepFlow.Workflows
Summary
Functions
abort/1
apply_default_query_filters/2
change_workflow/1
check_rights/1
create_workflow/1
delete_workflow/1
duplicate_workflow/2
filter_status/4
get_completed_statistics/2
get_processing_workflow_live/0
get_step_definition/1
get_workflow!/1
get_workflow_for_job!/1
get_workflow_version_as_string/1
list_workflows/1
pause/3
preload_workflows/2
resume/1
update_workflow/2
StepFlow.Workflows.Status.StateEnum
Summary
Types
t/0
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
valid_value?/1
StepFlow.Workflows.StepManager
Summary
Functions
check_step_progression/1
check_step_status/1
child_spec/1
init/1
start_link/0
Settings
View Source
StepFlow.WorkflowDefinitions.WorkflowDefinition
(StepFlow v1.8.0)
The WorkflowDefinition context.
×