Getting Started

Connect your ERP.net instance and start exploring

Operator works best when connected to your ERP.net instance. While you can explore documentation and entity schemas without a connection, querying data, managing records, and most powerful features require an active instance connection.

Prerequisites

Before users can start using Operator, two things need to be configured at the instance level:

1. Enable Domain API

Your ERP.net instance must have its Domain API properly configured and activated. The Domain API is the OData v4–based REST interface that Operator uses to query and manage data. If it's not enabled, Operator won't be able to communicate with your instance.

Contact your ERP.net administrator or hosting provider if you're unsure whether Domain API is active on your instance.

2. Install Operator from the Marketplace

An administrator must install the Operator app on the ERP.net instance through the ERP.net Marketplace:

👉 Install Operator from the Marketplace

Once installed, individual users can connect to the instance from within Operator.

Connecting Your Instance

After the prerequisites above are in place, you'll need your instance name—the subdomain from your ERP.net URL.

Finding Your Instance Name

Your instance name is the first part of your ERP.net URL. For example:

https://demodb.my.erp.net

In this example, demodb is the instance name you'll enter when connecting.

Step-by-Step Connection

1. Open the Instance Selector — Click on the instance button in the header (or "Connect Instance" if no instance is connected).

2. Add a New Instance — Click "Add Instance" to open the connection dialog.

3. Enter Your Instance Name — Type your instance name (e.g., demodb). The display name will auto-generate, but you can customize it.

4. Choose Connection Type — Select whether you're connecting as an Internal User (team member) or Client (external customer). This determines which capabilities are available.

5. Authenticate — Click "Add Instance" to be redirected to ERP.net's login page. Sign in with your ERP.net credentials to authorize the connection.

6. Start Using Operator — Once connected, you'll be returned to Operator with full access to your instance data.

Connection Types

You can maintain both connection types for the same instance if you need to switch between internal and client perspectives.

What You Can Do Without an Instance

Even without connecting an instance, you can:

• Search Documentation — Explore ERP.net features, workflows, and guides
• Explore Entity Schema — Understand the data model, entities, and relationships
• Browse Marketplace — Discover apps and integrations
• Search Knowledge Base — Find answers to common questions

Example Prompts

Here are some examples to get you started. Try typing these (or similar questions) in the chat:

Documentation & Learning

• "How do sales orders work in ERP.net?"
• "How do I configure multi-currency?"

Schema Exploration

• "What fields does the Customer entity have?"
• "Show me the SalesOrder entity structure"

Data Queries (requires instance)

• "Show me all pending sales orders"
• "Find customers from Germany"

Update Data (requires instance)

• "Create a new customer named Acme Corp"
• "Update product SKU-123 price to $99.99"

Client Advisor (client mode)

• "Search for wireless headphones"
• "Show my recent orders"

Enterprise Context

If your ERP.net instance has multiple enterprise companies, you can select which one to work with. Click on the company name in the header to switch between enterprise companies and locations.

The enterprise context affects all data queries and record operations, ensuring you're always working with the right company's data.

Next Steps

• Explore Capabilities to understand what Operator can do
• Set up Agents for scheduled or triggered workflows
• Review URL Parameters for embedding and deep linking