Console Documentation Forum Support
Camunda 8 - Working with the Zeebe API (CLI Client)

Camunda 8 - Working with the Zeebe API (CLI Client)

This course will provide you with a brief introduction to working with the Zeebe API using the Zeebe CLI (zbctl)

rate limit

Code not recognized.

About this course

Overview

This course will provide you with a brief introduction to working with the Zeebe API using the Zeebe CLI (zbctl).

You will use zbctl to perform an end-to-end test against a process definition. This will allow you to gain an understanding of the actions required to connect to the Zeebe engine and test your process applications.

What Will I Learn?

At the end of this course you will be able to:

  • Access a Camunda Environment
    • Access Console
    • Access Operate
  • Deploy a Camunda Application
    • Deploy a Process Definition using the Zeebe CLI
  • Test a Process Definition
    • Start a Process Instance using the Zeebe CLI
    • Activate a Job using the Zeebe CLI
    • Complete a Job using the Zeebe CLI
    • Fail a Job using the Zeebe CLI
    • Create a Job Worker using the Zeebe CLI
    • Send a Message Event using the Zeebe CLI
  • Monitor a Process Definition
    • View a Process Instance using Operate
    • Retry an Incident using Operate
    • Cancel a Process Instance using the Zeebe CLI
    • Delete a Process Instance using Operate

Target Audience

This course is targeted at the following role:

  • Administrator
  • Developer

Time Required: 1 Hour

Difficulty: Intermediate

Applicability: This course was developed against Camunda 8.3.3 and was last modified on 23rd January 2024.

Prerequisite Knowledge

This course presumes that the student has the following prerequisite knowledge:

  • Familiar with BPMN
  • Familiar with Camunda
  • Familiar with Job Workers

You can obtain knowledge of the above through the following Camunda Academy course:

Prerequisite Resources

This course presumes that the student has access to the following:

Camunda Forums

Curriculum1 Hour

  • Introduction
  • What Will I Learn? 1 min
  • Scenario
  • Business Requirement 1 min
  • Outline Solution 1 min
  • Installing the Zeebe CLI Client (zbctl)
  • Installation 5 min
  • Managing Process Definitions
  • Deploy Process 5 min
  • Managing Process Instances
  • Starting and Cancelling 5 min
  • Managing Jobs
  • Overview 2 min
  • Activate Job 2 min
  • Complete Job 2 min
  • Fail Job 5 min
  • Managing Workers
  • Create Worker 5 min
  • Managing Messages
  • Publish Message 5 min
  • Validation
  • Cleanup Environment 2 min
  • Test Process 5 min
  • Summary
  • Review 3 min
  • Resources 1 min
  • Assessment & Survey
  • Course Assessment 3 min
  • Course Survey 1 min

About this course

Overview

This course will provide you with a brief introduction to working with the Zeebe API using the Zeebe CLI (zbctl).

You will use zbctl to perform an end-to-end test against a process definition. This will allow you to gain an understanding of the actions required to connect to the Zeebe engine and test your process applications.

What Will I Learn?

At the end of this course you will be able to:

  • Access a Camunda Environment
    • Access Console
    • Access Operate
  • Deploy a Camunda Application
    • Deploy a Process Definition using the Zeebe CLI
  • Test a Process Definition
    • Start a Process Instance using the Zeebe CLI
    • Activate a Job using the Zeebe CLI
    • Complete a Job using the Zeebe CLI
    • Fail a Job using the Zeebe CLI
    • Create a Job Worker using the Zeebe CLI
    • Send a Message Event using the Zeebe CLI
  • Monitor a Process Definition
    • View a Process Instance using Operate
    • Retry an Incident using Operate
    • Cancel a Process Instance using the Zeebe CLI
    • Delete a Process Instance using Operate

Target Audience

This course is targeted at the following role:

  • Administrator
  • Developer

Time Required: 1 Hour

Difficulty: Intermediate

Applicability: This course was developed against Camunda 8.3.3 and was last modified on 23rd January 2024.

Prerequisite Knowledge

This course presumes that the student has the following prerequisite knowledge:

  • Familiar with BPMN
  • Familiar with Camunda
  • Familiar with Job Workers

You can obtain knowledge of the above through the following Camunda Academy course:

Prerequisite Resources

This course presumes that the student has access to the following:

Camunda Forums

Curriculum1 Hour

  • Introduction
  • What Will I Learn? 1 min
  • Scenario
  • Business Requirement 1 min
  • Outline Solution 1 min
  • Installing the Zeebe CLI Client (zbctl)
  • Installation 5 min
  • Managing Process Definitions
  • Deploy Process 5 min
  • Managing Process Instances
  • Starting and Cancelling 5 min
  • Managing Jobs
  • Overview 2 min
  • Activate Job 2 min
  • Complete Job 2 min
  • Fail Job 5 min
  • Managing Workers
  • Create Worker 5 min
  • Managing Messages
  • Publish Message 5 min
  • Validation
  • Cleanup Environment 2 min
  • Test Process 5 min
  • Summary
  • Review 3 min
  • Resources 1 min
  • Assessment & Survey
  • Course Assessment 3 min
  • Course Survey 1 min