Create an Application in C3 AI Studio
C3 AI applications use a modular architecture to support reuse and maintenance. Each application consists of one or more packages. These packages include Type definitions, implementation files, UI files, configurations, scripts, metadata, seed data, and tests.
Applications run in one of two environments:
- Single node environment (SNE): A limited-resource environment that is ideal for application development and testing.
- Shared environment (multi node environment, MNE): A scalable environment that is suitable for staging or for production use.
This document guides you to create a C3 AI application in your C3 AI Studio cluster. To manage an existing application, see Manage Environments and Applications in C3 AI Studio. To learn more about packages, see Package Management Overview.
Prerequisites
Before creating an application, you must have the following:
- Access to a C3 AI Studio cluster.
- A running environment in your C3 AI Studio cluster.
- A
StudioUserorStudioAdminrole. For more information about these roles, see C3 AI Studio Built-in Roles.
For guidance on creating an environment, see Create an Environment in C3 AI Studio. If your organization is not yet a C3 AI customer, contact us for more information.
Launch the create application modal
Launch the Create application modal from one of these C3 AI Studio pages:
- Home: Select + Create application.
- Env > Overview: Select + Create application.
- Apps: Select New Application in the apps list.
In the modal, confirm the Environment selection is correct. Then follow the appropriate workflow for your environment:
For guidance on environments, see Create and manage environments in C3 AI Studio.
Create a single node environment application
A single node environment (SNE) is ideal for testing your application logic and data integration. To create an application in a single node environment, you must have the StudioUser or StudioAdmin role.
After launching the Create application modal, follow these steps to create an application in your SNE:
Step 1: Define package details
- Select Create new package.
- Enter a Package name and Package version. For more information about application packages, see Package Management Overview.
- Use Dependency Packages to select package dependencies. Select + Add Package to add more dependencies if you need them.
- Select Continue.
Step 2: Configure deployment
- Enter the Application name. The application name can be up to 28 characters long, using only lowercase alphanumeric (a-z, 0-9) characters. You may reuse the package name in this field.
Your application name must be unique within your environment. Do not reuse the name of a deleted application.
- Select an Application mode: Development or Trial. This selection affects testing and automatic schema migration. In both cases, you can modify the application's metadata. Select Expand details to compare application modes:
- Development: For active local development and experimentation. Testing scripts are enabled, and automatic schema migration is disabled.
- Trial: For demonstrations or short explorations. Testing is disabled, and automatic schema migration is enabled.
- Select Continue.
Step 3: Configure compute
- Select either Default or Custom computing options.
- You need the
StudioAdminrole to customize application memory. If you need to customize the computing options, contact your C3 AI studio administrator.
- You need the
- Select Continue.
Step 4: Review and submit
Review your new application settings. Select Back or the checkmark (✓) beside step titles to edit a previous step. If you are satisfied, select Create.
Create a shared environment application
A shared environment supports production applications: you cannot modify applications in this environment. To create an application in a shared environment, you must have the StudioUser or StudioAdmin role. If your application still requires testing or modification, consider creating a single node environment application instead.
After launching the Create application modal, follow these steps to create a shared environment application:
- Select an application package
- Configure application deployment
- Configure application compute
- Review your selection
Step 1: Select an application package
Choose one of the following options in the modal:
Create new package:
- Enter the Package name and Package version.
- Use Dependency Packages to select package dependencies. Select + Add Package to add more dependencies. You can add additional dependencies after creation.
- Select Continue.
Use existing package:
- Source from Git Repository: Enter an API address and Authentication Token for downloading your application package. For information about connecting a GitHub git repository to your C3 application, see Version Control with GitHub.
- Download from Artifact Hub: Use the Package and Package version fields to find an artifact that was deployed through C3 AI Release Management. To learn more about Artifact Hub, see Register an Artifact to a Cluster
- Select Continue.
Step 2: Configure application deployment
- Enter the Application name.
Your application name must be unique within your environment. Do not reuse the name of a deleted application.
- Select an Application mode: Production or Test. This selection affects testing and automatic schema migration, as production apps cannot have their metadata modified.
- Production: A customer-facing application with automatic schema migration enabled. Test running is disabled.
- Test: A QA, CI, or staging application with test-running enabled. Automatic schema migration is disabled.
- To compare modes, select Expand details. To specify a platform version, select Advanced.
- Select Continue.
Step 3: Configure application compute
- Choose a compute setting: Small, Medium, Large, or Custom. Only users with the
StudioAdminrole can customize compute settings. Contact your studio administrator if you need this option but it is unavailable. - Select Continue.
Step 4: Review your selection
Review your entries. To edit, select Back or the checkmark (✓) beside any step title.
When you are satisfied with your entries, select Create.
Application states
A C3 AI application can have one of the following states:
- Starting
- Running
- Stopping
- Stopped
- Terminating
- Unknown
- Error
View application states in any of the following pages:
- Home: Status appears on the application card.
- Apps: Status appears in the list view.
Terminate an application
You can terminate an application from one of these C3 AI Studio pages:
Home
- Hover over the target application card.
- Select the Trash icon.
Apps
- Locate the application in the list.
- Select the ellipsis menu (...) at the end of the row.
- Select Terminate application.
Terminating an application permanently deletes it and releases its resources. For information about temporarily scaling down an environment, see Hibernate Environments and Applications.