Console

You use the Ververica Cloud Console to create, run, and debug your streaming applications.

This topic introduces the Console’s main features, including the main toolbar and the individual Console pages (such as the SQL Editor), which are grouped according to usage (Development and Operations).

Console toolbar

Use the Console toolbar to access some common operations. These are always available, independent of which Console page you are currently viewing:

• Ververica logo (left of the toolbar): Return to main Dashboard view.
• Toggle navigation panel: Toggle between icons and full names.
• Notification Management: Review all notifications related to deployments.
• Network Detection: Check if the running environment is connected.
  note

  You can use an IP address or a domain name to check whether the Flink deployment is connected to the upstream and downstream systems. See the FAQ section.

• Theme: Change the look and feel of the Console interface.
  note

  This only controls the look and feel of the console interface. To change the overall look and feel of Ververica Cloud user interface, use the Manage Profile option in the Account menu.

• Help: Access Ververica Cloud documentation.
• Account menu: See Account menu.

Navigation panel

The Navigation panel on the left is always visible. You can quickly navigate to the different Console pages (such as SQL Editor, Security) by selecting one of the items in the panel.

Overview page

This provides details about the current workspace, as well as access to useful shortcuts for creating example deployments and SQL applications from templates.

You can use shortcuts to access frequently-used pages:

• Open SQL Editor: Open the SQL Editor module.
• Create JAR Deployment: Go directly to the page where you can create a JAR deployment.
• Create Python Deployment: Go directly to the page where you can create a Python deployment.
• Manage Deployments: View a list of the currently defined deployments.

At the bottom of the page are links to the Quick Start section in the Ververica Cloud documentation. Think of these as starting points and use the example deployment scenarios to automatically load pre-written SQL code into the code editor.

SQL Editor

The SQL editor provides an integrated development environment (IDE) that allows you to perform all your development tasks within Ververica Cloud, including:

• Validate code syntax and semantics
• Debug your code with different output visualizations transformations
• Control versions to protect your work while also collaborating and sharing with others
• View history of changes
• Co-edit code by sharing using the lock/unlock file mechanism
• Use ready-made reference code solutions for common use cases
• Use code templating to re-use solutions and code libraries.

Asset List pane

Click the tabs to display the following assets:

• Drafts: Lists all the SQL drafts you have created. Double-click on an item to load it into the SQL editor window.
• Catalogs: Lists any custom catalogs you have defined. See MySQL catalog for more information.
• UDFs: Lists any user-defined functions (UDFs) that you have registered. See Manage User-Defined Functions (UDFs) for more information.

Use the toolbar to search for, locate, and delete SQL drafts.

SQL Editor toolbar

Use this to create and manage SQL drafts (if you have no existing drafts, only the New button will be available):

• New: Create a new SQL draft.
• Save As: Save the current SQL draft with a different name.
• Save: Save current changes.
• More: Use this to access further draft-related commands (Undo, Find, Format, Create Temporary Table).
• Validate: Validate the code for an SQL draft.
• Debug: Debug your SQL draft.
• Deploy: Deploy an SQL draft once it’s been validated.
• Deployment: View the Deployments page for this draft.

SQL Editor working area

Use this to edit your SQL code (double-click an SQL draft in the Asset list to open it).

The tabs provide different views and overview information about the current SQL draft:

• Configurations: View the Engine version for the current SQL draft and any Additional Dependencies.
• Structure: Display views on the draft structure (flow diagram, and tree diagram).
• Versions: List all published versions of the current SQL draft. (Each time you click Deploy for an SQL draft, Ververica Cloud creates a new version.) Use the Actions menu options to work with versions. See Manage published job versions for more information.

Use the Results, Errors, and Analysis tabs to diagnose and optimize your SQL applications.

SQL Editor Info bar

This bar at the bottom of the SQL Editor module shows the Last Synchronised time. Click the settings button (the gear icon on the right) to display the Settings dialog, which allows you to change how text is displayed in the SQL Editor window.

Connectors page

Apache Flink provides a variety of built-in connectors and data formats to facilitate the integration of Flink with different data sources and sinks (also called destinations). You can also create custom connectors and formats.

• Connectors: Lists the available built-in and custom connectors
• Formats: Lists the available built-in and custom data formats available in Ververica Cloud

See the following for more information:

• See Connectors and formatsfor more information.

Catalogs page

Use this to view, manage, and create catalogs stored in the current Ververica Cloud workspace.

• Catalogs tree view: Navigate through your saved catalogs.

note

This is the same as displaying the Catalogs asset list in the SQL Editor.

• Catalog List pane: View, create, and delete catalogs.

See the following for more information:

• MySQL catalog

Deployments page

Use this to view all the deployments (Flink applications) in your current workspace.

You can:

• Create a new deployment.
• Start, Cancel, or Delete an existing deployment.
• Click on a deployment name to view further options and information.

For more information about deployments, see Manage deployments.

Artifacts page

Ververica Cloud provides simple file storage per workspace, enabling you to upload and reference files in Deployments. You manage these using the Artifacts page.

See Artifacts for more information.

Session Clusters page

Use this to create, edit, delete, and view Session clusters. Session clusters are suitable for development and test purposes in non-production environments.

See Session Clusters for more information.

Security page

Use this to configure various security settings for managed Flink deployments:

• Secret Values: Once created, you can reference variables in SQL scripts, in deployment parameters, or the Configuration options for a Flink deployment.

See Security for more information.

Configurations page

Use this to view and modify deployment defaults, making job development more efficient.

For more information, see Optimize deployment default settings.