Workflow

Prev Next

Available in VPC

Explains the Workflow menu interface, workflow editor interface, and how to create a workflow.
Workflow is a serial process that configures the data pipeline such as reserving a schedule of a job that has a specified job order.
Workflow editor provides the GUI interface that allows workflow configuration without writing a code.

Note

The workflow is designed to combine and configure vast triggers and jobs. However, in the current release (November 2023), you can only configure one trigger and one job per workflow. Check the future release for multiple trigger and job configuration, and event node configuration.

Workflow interface

The workflow interface includes the following components:
dataflow-workflow-vpc_screen_ko

Component Description
① Menu name Current menu name.
② Basic features Features shown when you first open the Workflow menu.
  • [Create workflow]: Click to Create workflow.
  • [Learn more]: Go to the Data Flow overview page.
  • [Refresh]: Reload the current page.
③ Post-creation features Features provided after creating a workflow.
  • [Delete]: Delete the selected workflow.
④ Workflow list Created Workflow list. Click [Details] on each workflow to move to Workflow editor interface
⑤ Search bar Search the created workflow by the workflow name.

Check workflow information

To view the details of a created workflow:

  1. In the VPC environment of the NAVER Cloud Platform console, navigate to i_menu > Services > Big Data & Analytics > Data Flow.
  2. Click Workflow.
  3. When the workflow list appears, check the summarized information.
    • Workflow name: The unique name you entered when creating the workflow.
    • Last run time: Time of the most recent workflow run. The latest date and time of on-demand run or reservation run due to trigger.
    • Execution option: Current workflow status.
    • Reservation: Execution has been scheduled by a trigger.
    • None: Execution has not been scheduled by a trigger. When None is selected in Trigger properties > Execution option.
    • Update date and time: Time of the most recent update. The latest date and time of editing workflow configuration.
    • [Details]: View workflow details.
  4. To view the detailed information of workflow configuration, click [Details].

Create workflow

Workflow can be configured by combining the trigger node and the job node. Trigger node is a node that specifies job schedule, and the job node is a node that specifies which job to execute.
You can select a trigger node from the created trigger or create a new trigger. You can select a job node from the created job, but jobs that are currently in progress cannot be included in the workflow.

Note

If there are no jobs created, you have to create a job first. For more information on job creation, see Create job.

While a job is running, the same job cannot be executed. So be careful with the trigger setting.

How to create a workflow:

  1. In the VPC environment of the NAVER Cloud Platform console, navigate to i_menu > Services > Big Data & Analytics > Data Flow.
  2. Click Workflow.
  3. Click [Create Workflow].
  4. When the workflow editor interface appears, click the [Workflow configuration] tab and add the trigger node and job node to configure a workflow.
  5. Click [Trigger] on the workflow editor interface and select **Create new ** or Add existing trigger from the menu.
    • Create new: Add a new trigger and enter the property data.
    • Add existing trigger: Select a created trigger from the list and apply.
  6. When selecting Create new from 6, click the trigger box on the left and fill in the Properties information of the trigger node on the right.
    • Name: Enter a trigger name.
    • Execution option: Select from execute cycle, execute on specific date, or none.
    • When selecting Execute cycle execution option, Execution cycle: Select from daily, weekly, or monthly.
    • When selecting Execute cycle execution option, Execution time: Enter the time to execute the workflow. Example: 12:00
    • When selecting Execution option > Execute cycle > Weekly, Execution day: Select the day to execute the workflow. Allow multi-selection.
    • When selecting Execution option > Execute cycle > Monthly, Execution date: Enter a date between 1 to 31. When entering multiple dates, separate them with commas (,). Selecting Last day of every month is allowed.
    • When selecting Execute on specific date execution option, Execution date: Click the i-dataflow_calendar icon to select the date of execution for workflow.
    • When selecting None execution option: No additional input field.
  7. When selecting Add existing trigger from 6, click the trigger box on the left and select a specific trigger from the list that appears on the right.
  8. Click [Job] on the workflow editor interface.
  9. After clicking the added job box on the left, fill in the Properties information and Execution option of the job on the right.
    • Properties information: Select a job to be added to the workflow from the existing job list. Jobs currently in progress do not appear on the list.
    • Execution option: View execution option settings when creating a job. Editing the execution option is allowed.
      • Run container: Set how many containers to use for distributed jobs.
      • Number of retries: Set the maximum number of retries upon job failure.
      • Timeout: Set the waiting time of the job result when the job is executed once.
      • Script path: Path for the job command script to be saved. When a job is created, the sub path of the automatically created Object Storage bucket is specified.
      • Run log: Path where the job run history is saved. Automatically specifies the sub path of the automatically created Object Storage bucket when a job is created.
      • Role name: Not used in the current released version (as of November 2023).
  10. Click [Complete].
    • The workflow creation is complete and is displayed on the workflow list.
    • When a workflow is created, the execute is reserved due to a trigger.
    • The created workflow is registered as NAVER Cloud Platform resource. For more information, see Resource Manager concepts.
Note

During the job execution option the Role name is a value that needs to be entered when using the Cloud DB for source node or target node. From the point when Data Flow and Cloud DB is integrated in the future, it becomes a valid field so it is not currently set (as of November 2023).

Workflow editor interface

The workflow editor interface includes the following components:
dataflow-workflow-vpc_editor_ko

Component Description
Basic information Enter a workflow name.
② Feature tab Select a feature to use.
③ Node canvas Add trigger node and job node. Express the relationship between each node as a diagram.
④ Settings panel Enter detailed information and property settings of each node.
⑤ Toggle button Toggles between [Save draft] and [Run] based on edit status.
  • [Save draft]: Saves the workflow as a draft.
  • [Run]: Runs a completed workflow on-demand.

After adding workflow component nodes (trigger/job) in the node display area (area ③) of the workflow editor's [Workflow configuration] tab, enter the properties and detailed settings for the workflow components in the settings area (area ④) of the workflow editor's [Workflow configuration] tab. The [Complete] button becomes enabled when each of the trigger node and job node is added. Jobs that are currently in progress cannot be included in the workflow.

Note

The workflow from the current release (November 2023) is configured to 1 trigger for 1 job. In the future release, multiple trigger and job configuration, and event node configuration will be added.

View workflow run list

To view the job run history:

  1. In the VPC environment of the NAVER Cloud Platform console, navigate to i_menu > Services > Big Data & Analytics > Data Flow.
  2. Click Workflow.
  3. Click [Details] for the specific workflow from the workflow list when it appears.
  4. When the workflow editor interface appears, click the [Run list] tab.
    • You can check the workflow run list of the past month. The workflow run history is kept for 90 days.
    • You can view the following items in the run list:
      • Job name (ID): Job information configured in the workflow. Job ID is the unique name of the job entered by the user when the job was created.
      • Run status: Job run result configured in the workflow. Displays one of the following values: Succeeded, Failed, Running, or Pending.
      • Run log: Click [Details] to move to the location of the workflow run history file.
      • Container: Number of containers set in the job run option configured in the workflow.
      • Trigger: Trigger information configured in the workflow.
      • Run start date and time: The starting date and time of the workflow. Executed date and time if executed due to trigger.
      • Run end date and time: The ending date and time of the workflow. The end date and time if executed due to trigger.
      • Run preparation time: Time prepared to run the workflow.
      • Run time: Total time taken for the workflow run.
      • Number of retries: Number of workflow run retries made.
Note

Jobs with workflow configuration can be searched from the run list of the workflow interface, and the run list of the Job interface as well.

Delete workflow

To delete a workflow:

  1. In the VPC environment of the NAVER Cloud Platform console, navigate to i_menu > Services > Big Data & Analytics > Data Flow.
  2. Click Workflow.
  3. Select the specific workflow from the workflow list and click [Delete].
    • The workflow is deleted from the workflow list.