Getting Started with Unqork

This guide introduces new Creators to the fundamentals of building in Unqork. You'll manually create a workspace, application, and module, configuring components, connecting logic, and previewing your work along the way. Understanding this process gives you the context to build more effectively alongside the Build Agent.

While the Build Agent can generate entire modules from scratch, knowing how the pieces fit together lets you guide it more precisely, review what it builds, and make targeted changes when needed. The manual steps in this guide are the foundation for working confidently with AI-assisted development.

Prerequisites

Before you begin, ensure you have:

• Access to an Unqork environment.
• An account with Creator permissions.
• A supported web browser (Chrome, Edge, Firefox, or Safari).

Unqork Terminology

• Workspace: A container that organizes applications, modules, and shared resources. Workspaces help teams separate projects and manage access.
• Application: A collection of related modules. Applications represent complete solutions for end-user interaction.
• Module: A screen or workflow made up of components. Modules can be front-end interfaces, API endpoints, or backend logic.
• Component: An individual element in a module, like a text field, button, data connector, or piece of logic. Each component has a Property ID and configurable settings.
• Property ID: A unique identifier for each component in a module. Used to reference components in logic, formulas, and data connections. Property IDs must be unique in a module and written in camelCase. See Property ID Naming Conventions for standards and constraints.
• Express View: The Creator's tool for previewing and testing a module. Access it through View in App in the header to see the module as end-users experience it.
• Build Agent: The built-in AI assistant that can build and modify modules using natural language instructions.

Values are formatted as follows: inline code — a value to enter exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state

Step 1: Create a Workspace

Workspaces organize your applications and modules. You can use an existing workspace or create a new one:

1. From the main navigation, navigate to the Workspaces Home Page.
2. If you are working in the Training Environment, a workspace has been created for you. Search for your workspace by entering your name in the search bar, then click it to open the workspace page and skip to Step 2.
3. Click New Workspace.
4. Enter a name that is unique in your environment. Use a descriptive name with your initials and today's date to keep it identifiable (for example: Getting Started - CC - 20260602).
5. Click Create Workspace.

You should now see your workspace in the list. Click your workspace to open the workspace page.

Step 2: Create an Application

Applications are containers for modules, which are the screens and logic that make up your application.

1. From your workspace page, click New Application.
2. Enter a name that is unique in your environment. Use a descriptive name with your initials and today's date (for example: Getting Started App - CC - 20260602).
3. Verify the application path is unique. The path is auto-generated from the name but must be unique in the environment.
4. Set the Application Type to Module. Module-based applications let you build user-facing screens, while Workflow applications are for backend automation.
5. Add a description (optional): My first Unqork application.
6. Click Create Application.

The application page displays, where all the application's modules are managed.

An entrypoint module is automatically created with the application, serving as the starting point for end-users accessing it.

Step 3: Build a Module

Modules are the building blocks of your application. Each module represents a screen or workflow for end-user interaction.

Open the Entrypoint Module

1. From the application page, locate the entrypoint module in the modules list.
2. Click the module to open the Module Builder.

The Module Builder opens. It displays the following:

• Left panel: Agent Chat and Explorer tab.
• Canvas: The build area.
• Right panel: Component settings and module details.

Switch to Config View

By default, the module opens in UI View. In the header, click Config View in the View Toggler. The canvas switches to Config View, which lets you add and configure components.

Add Components to the Canvas

Build a simple contact form by adding components:

1. In the component tray, search for the Text Field component or find it under Primary Fields.
2. From the component tray, drag the Text Field component onto the canvas.

The component displays on the canvas. The right panel displays its settings.

Configure the Text Field Components

With the Text Field selected:

1. In the Property ID field, enter firstName.
2. In the Label Text field, enter First Name.
3. In the Validation section, set Required to ON.

Repeat the process to add more fields:

Save

In the header, click Save. A confirmation message displays in the header.

Step 4: Preview Your Module

Test your module using Express View, the preview environment that displays how end-users experience your module.

Option 1: Preview in a New Tab

In the header, click View in App. A new tab opens with your module in Express View. Fill out the form fields you just created. Required fields display validation when empty.

To continue editing, return to the Module Builder tab.

Option 2: Preview in UI View

1. In the header, switch to UI View using the View Toggler.
2. Click the Select button to deactivate it.
3. Interact with the components on the canvas.

Fill out the form fields you just created. Required fields display validation when empty.

Success! The module is built and previewed.

Step 5: Build with the Build Agent (Optional)

The Build Agent can build and modify modules using natural language. The Agent Chat is available in the left panel by default. Try building a component with AI:

1. In the Agent Chat, enter this prompt: Add a dropdown for country selection with options for United States, Canada, and United Kingdom.
2. Click Send or press Enter.

The agent creates a plan showing what it will build. Review the plan, then complete the following steps:

1. At the top right of the canvas, click Build Plan.
2. In the Agent Chat, select Allow to proceed. The agent adds the Dropdown component to your canvas and saves the changes automatically.
3. Switch back to the Module Builder tab to see the module in UI View.
4. On the canvas, click the new Dropdown component to open the component settings.
5. Click Select and interact with the Dropdown component to see the country options.

The Build Agent can also:

• Generate entire forms from descriptions.
• Connect components with logic.
• Create data transformations.
• Suggest accessibility improvements.

For more information, see Getting Started with the Build Agent.

Troubleshooting

Cannot Create a Workspace

If you are in the Training Environment, you cannot create new workspaces. A workspace has already been created for you with your name. Use the search bar to find your workspace.

If you are not in the Training Environment and New Workspace returns an error, check your Creator permissions. You need Creator access to create workspaces. Contact your Unqork administrator to verify your role. See Creator (User) Administration for details on user roles.

Module Changes Do Not Save

Ensure you've clicked Save in the header after making changes. If the save fails, check that:

• Your network connection is stable.
• You have edit permissions for the module.
• The module is not locked by another Creator.

Express View Displays an Error

If Express View displays an error:

• Ensure you have saved the module.
• Check that all required fields have valid Property IDs.
• Ensure there are no duplicate Property IDs in the module.
• Review any logic configurations for issues.

For more help, see Troubleshooting Basics and Strategies.

Next Steps

Now that you've built your first module, explore these topics next:

Learn About the Module Builder

• Module Builder Overview
• Component Reference
• Component General Settings

Connect Data and Logic

• Data Workflow Component
• Decisions Component
• Working with Data

Build Workflows

• Workflow Builder
• Service Types

Organize and Deploy

• Application Lifecycle
• Application Promotions

Collaborate and Manage Access

• Understanding Designer RBAC
• Workspace-Level RBAC