Workflow
    • PDF

    Workflow

    • PDF

    Article Summary

    Available in VPC

    Explains how to create workflow, the workflow editor screen configuration, and the Workflow menu screen configuration.
    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, the workflow from the current release (November 2023) is configured to 1 trigger for 1 job. Check the future release for multiple trigger and job configuration, and event node configuration.

    Workflow screen

    The workflow screen is laid out as follows:
    dataflow-workflow-vpc_screen_en

    FieldDescription
    ① Menu nameName of the menu currently being viewed
    ② Basic featuresFeatures displayed when initially entering the Workflow menu
    • [Create workflow] button: click and create table
    • [Learn more about products] button: click and move to the Data Flow page
    • [Refresh] button: click and refresh the page
    ③ Post-creation featuresFeatures provided after creating a workflow
    ④ Workflow listCreated workflow list. Click the [Details] button for each workflow to move to workflow editor screen
    ⑤ Search barSearch the created workflow according to the workflow name

    Check workflow information

    The following describes how to view the details of a created workflow:

    1. Click the environment you are using in the Region menu and Platform menu of NAVER Cloud Platform console.
    2. Click the Services > Big Data & Analytics > Data Flow menus in order.
    3. Click the Workflow menu.
    4. When the workflow list appears, check the summarized information.
      • Workflow name: unique name entered by the user when creating workflow.
      • Latest executed date and time: latest workflow execution date and time. The latest date and time of on-demand execution or reservation execution due to trigger.
      • Execute option: execute status of workflow
      • Reservation: execution reserved status due to trigger
      • None: execution not reserved due to trigger. When None has been selected from the Property information > Execute option trigger option.
      • Update date and time: latest workflow update date and time. The latest date and time of editing workflow configuration.
      • [Details] button: view workflow detailed information
    5. To view the detailed information of workflow configuration, click the [Details] button.

    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.

    The following describes how to create a workflow:

    1. Click the environment you are using in the Region menu and Platform menu of NAVER Cloud Platform console.
    2. Click the Services > Big Data & Analytics > Data Flow menus in order.
    3. Click the Workflow menu.
    4. Click the [Create Workflow] button.
    5. When the workflow editor screen appears click the [Workflow configuration] tab and add the trigger node and job node to configure a workflow.
    6. Click the [Trigger] button on the workflow editor screen and select Create new or Add existing trigger from the menu.
      • Create new: add a new trigger and enter the property information
      • Add existing trigger: select a created trigger from the list and apply
    7. When selecting Create new from 6, click the trigger box on the left and enter the Property information of the trigger node on the right.
      • Name: enter the trigger name
      • Execute option: select from execute cycle, execute on specific date, or none
      • When selecting Execute cycle execution option, select the Execution cycle from daily, weekly, or monthly
      • When selecting execute cycle execution option, enter the execute time for the workflow to execute <example> 12:00
      • When selecting execution option > execute cycle Weekly, Execution week: select execution week for the workflow to execute Allow multi-selection
      • When selecting execution option > execute cycle Monthly, enter the Execution date between 1 to 31 When entering multiple date, separate with commas (,) Selecting Last day of every month is allowed.
      • When selecting Execute on specific date execution option, for Execution date click the i-dataflow_calendar icon to select the date of execution for workflow
      • When selecting None execution option, additional input field is not required
    8. When selecting Add existing trigger from 6, click the trigger box on the left and select a specific trigger from the list that appeared on the right.
    9. Click the [Job] button on the workflow editor screen.
    10. After selecting the added job box on the left, enter the Property information and Execute option of the job on the right.
      • Property information: selecting a job to be added to the workflow from the existing job list. Jobs currently in progress do not appear on the list.
      • Execute option: view execution option settings when creating a job. Editing the execution option is allowed.
        • Execute container: set how many containers to use for distributed jobs
        • Number of retry: set how many retries to proceed when job fails
        • 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.
        • Execute log: path for the history of the job execution to be saved. Automatically specifies sub path of the automatically created Object Storage bucket when job is created.
        • Role name: not used in the current released version (as of November 2023)
    11. Click the [Complete] button.
      • 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 detailed information, see Resource Manager concept.
    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 screen configuration

    The workflow editor page is laid out as follows:
    dataflow-workflow-vpc_editor_en

    FieldDescription
    Basic informationEnter workflow name
    ② Function tabSelect a function to use
    ③ Show node fieldAdd trigger node, job node Express the relationship between each node as a diagram
    ④ Setting fieldEnter detailed information and property settings of each node
    ⑤ Toggle buttonDepending on the edit status, toggle between [temporary storage] button and [execute] button
    • [temporary storage] button: temporarily saves the workflow being edited
    • [execute] button: execute the edit completed workflow with on-demand

    After adding the workflow configuration components (trigger or job) from the show node field (field number 3) of the workflow editor [job configuration] tab, enter the detailed settings and property of workflow configuration components from the settings field (field number 4) of the workflow editor [job 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 execution list

    The following describes how to view the job execution history:

    1. Click the environment you are using in the Region menu and Platform menu of NAVER Cloud Platform console.
    2. Click the Services > Big Data & Analytics > Data Flow menus in order.
    3. Click the Workflow menu.
    4. Click the [Details] button for the specific workflow from the workflow list when it appears.
    5. When the workflow editor screen appears, click the [Execution list] tab.
      • You can check the workflow execution list of the past month. The workflow execution history is kept for 90 days.
      • The items you can view in the execution list are as follows:
        • 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.
        • Execute status: job execution result configured in the workflow. Success, fail, executing, or standby can be viewed.
        • Execute log: click the [details] button to move to the location of the workflow execution history file.
        • Container: number of set container from the job execution option configured in the workflow
        • Trigger: trigger information configured in the workflow
        • Execution start date and time: the starting date and time of the executed workflow. The executed date and time if executed due to trigger.
        • Execution end date and time: the ending date and time of the executed workflow. The end date and time if executed due to trigger.
        • Execute preparation time: time prepared to execute a workflow
        • Execute time: the time used for workflow job execution
        • Number of retry: the number of retry of workflow job execution
    Note

    Jobs with workflow configuration can be searched from the execution list of the workflow screen, and the execution list of the job screen as well.

    Delete workflow

    The following describes how to delete a workflow.

    1. Click the environment you are using in the Region menu and Platform menu of NAVER Cloud Platform console.
    2. Click the Services > Big Data & Analytics > Data Flow menus in order.
    3. Click the Workflow menu.
    4. Select the specific workflow from the workflow list and click the [Delete] button.
      • The workflow is deleted from the workflow list.

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.