Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Syncfusion Syncfusion Code Studio Documentation
# Syncfusion Code Studio Documentation

This repository contains the official documentation for Syncfusion Code Studio, a next-generation AI-powered Integrated Development Environment (IDE) designed to enhance developer productivity.

Expand Down
102 changes: 65 additions & 37 deletions code-studio-toc.html
Original file line number Diff line number Diff line change
@@ -1,51 +1,79 @@
<?xml version="1.0" encoding="utf-8"?>
<ul class="treeview">
<li>
<a href="/code-studio/welcome-to-code-studio">Welcome to Syncfusion Code Studio</a>
<li>
<a href="/code-studio/welcome-to-code-studio">Welcome to Syncfusion Code Studio</a>
</li>
<li>Installation
<li>Getting Started
<ul>

<li>
<a href="/code-studio/get-started/windows">Windows</a>
</li>
<li>
<a href="/code-studio/get-started/mac">Mac</a>
<a href="/code-studio/get-started/product-tour">Product Tour</a>
</li>
<li>
<a href="/code-studio/get-started/signin">Onboarding</a>
<a href="/code-studio/enterprise-server/getting-started">Onboarding</a>
</li>
<li>Installation
<ul>
<li>
<a href="/code-studio/get-started/windows">Windows</a>
</li>
<li>
<a href="/code-studio/get-started/mac">Mac</a>
</li>

</ul>

</li>
<li>Enterprise Servers
<ul>
<li>
<a href="/code-studio/enterprise-server/getting-started">Getting Started</a>
</ul>

</li>

<li>
<a href="/code-studio/enterprise-server/dashboard">Dashboard</a>
<a href="/code-studio/get-started/firstproject">Your First Project</a>
</li>
<li>BYOK
<ul>
<li>
<a href="/code-studio/enterprise-server/providersandmodels">Configure LLM Providers and Models</a>
<a href="/code-studio/get-started/firstAgentrun">First Agent Run</a>
</li>
<li>
<a href="/code-studio/enterprise-server/fallback">Fallback policy configuration</a>
<a href="/code-studio/get-started/usingContextProviders">Using Context Providers in a Scenario </a>
</li>
</ul>
</li>
<li>
<a href="/code-studio/enterprise-server/userandteams">Manage Users and Teams</a>

</ul>
</li>
<li>Enterprise Servers
<ul>
<li>Enterprise Administration
<ul>
<li>
<a href="/code-studio/enterprise-server/dashboard">Dashboard</a>
</li>
<li>
<a href="/code-studio/enterprise-server/userandteams">Manage Users and Teams</a>
</li>
<li>
<a href="/code-studio/enterprise-server/createbudget">Create Budget </a>
</li>
<li>
<a href="/code-studio/enterprise-server/settings">Settings </a>
</li>

</ul>
</li>
<li>
<a href="/code-studio/enterprise-server/createbudget">Create Budget </a>

<li>Configure models and providers
<ul>
<li>BYOK
<ul>
<li>
<a href="/code-studio/enterprise-server/providersandmodels">Configure LLM Providers and Models</a>
</li>
<li>
<a href="/code-studio/enterprise-server/fallback">Fallback policy configuration</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="/code-studio/enterprise-server/settings">Settings </a>
</li>



</ul>
</li>
<li>Features
Expand All @@ -61,7 +89,7 @@
</li>
<li>
<a href="/code-studio/features/agent">Agent</a>
</li>
</li>
<li>
<a href="/code-studio/features/checkpoints">Checkpoints</a>
</li>
Expand All @@ -83,10 +111,10 @@
<!-- <li>
<a href="/code-studio/features/enhanceprompt">Enhance Prompt</a>
</li> -->
<li>
<li>
<a href="/code-studio/features/summarize">Summarization</a>
</li>


<li>Context providers
<ul>
Expand Down Expand Up @@ -165,9 +193,9 @@
</li>
<li> <a href="/code-studio/ui-builder">UI Builder</a> </li>
<li>
<a href="/code-studio/reference/configure-the-code-studio">Configure the Syncfusion Code Studio</a>
<a href="/code-studio/reference/configure-the-code-studio">Customization</a>
<ul>
<li>MCP
<li>MCP
<ul>
<li><a href="/code-studio/reference/configure-properties/mcp/marketplace">Marketplace</a></li>
<li><a href="/code-studio/reference/configure-properties/mcp/configure-mcp-server">Configuring MCP Servers via YAML</a></li>
Expand All @@ -180,7 +208,7 @@
<li><a href="/code-studio/reference/configure-properties/docs">Docs</a></li>
<li><a href="/code-studio/reference/configure-properties/usersettings">User Settings</a></li>
<li><a href="/code-studio/reference/configure-properties/toolssupport">Tools</a></li>
<li><a href="/code-studio/reference/configure-properties/how-to-add-local-and-BYOK-model">How to add local models and BYOK models</a></li>
<li><a href="/code-studio/reference/configure-properties/how-to-add-local-and-BYOK-model">How to Add Local Models</a></li>
<li><a href="/code-studio/reference/configure-properties/sfcodeignore">.Sfcodeignore</a></li>
</ul>
</li>
Expand All @@ -201,7 +229,7 @@
<li>
<a href="/code-studio/release-notes/v0.1.0">v0.1.0</a>
</li>

</ul>
</li>
<li>Troubleshoot
Expand All @@ -215,7 +243,7 @@
<li>
<a href="/code-studio/troubleshoot/resolve-mcp-server-eaccess-issue">How to Resolve EACCESS error</a>
</li>
<li>
<li>
<a href="/code-studio/troubleshoot/resolve-failed-to-parse-assistant">How to Resolve Failed to Parse Assistant error</a>
</li>
</ul>
Expand Down
174 changes: 143 additions & 31 deletions code-studio/enterprise-server/createbudget.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,169 @@ platform: syncfusion-code-studio
keywords: budget, usage, billing, alerts, teams, users, admin, syncfusion, code-studio, enterprise server, getting started
---

# Create Budget
## Budget

The Budget feature in Code Studio enables administrators to allocate and monitor AI usage budgets for teams and individual users. This helps organizations manage costs effectively and optimize AI resource utilization.
The **Budget** feature in Code Studio enables administrators to allocate and monitor AI usage budgets for teams and individual users. This helps organizations manage costs effectively and optimize AI resource utilization.

> **Note**: Only admins and Team Leads can edit and assign budget for all.
---

### When to Use

- Allocate AI usage budgets to teams or individual users.
- Control spending on Premium and BYOK models.
- Prevent overspending with auto-renewal and usage alerts.
- Track and optimize credit consumption across your organization.

---

### Feature Overview

<table>
<thead>
<tr>
<th>Feature</th>
<th>Purpose</th>
<th>Key Actions</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Team Budget Setup</strong></td>
<td>Allocate budget for a team</td>
<td>Select Team → Set Maximum Budget → Choose Period (Monthly/Quarterly/Half-Yearly/Annually) → Enable Auto-Renewal (optional)</td>
</tr>
<tr>
<td><strong>User Budget</strong></td>
<td>Assign budget to individual users</td>
<td>Select Team → Choose User → Set Budget Limit → Define Period → Monitor Usage</td>
</tr>
<tr>
<td><strong>Usage Alerts</strong></td>
<td>Notify when usage exceeds threshold</td>
<td>Set Threshold (%) → Add Email Subject Prefix → Specify Recipients → Click Update</td>
</tr>
</tbody>
</table>

> **Note:** Only Admins and Team Leads can edit and assign budgets.

<img src="./enterprise-images/budgetnew.png" alt="budget" />

### Prerequisites

- Administrator or Team Lead role.
- Active teams and users in Code Studio.
- Billing card on file (credits are deducted from usage).
- Understanding of credit conversion: **1 USD = 150 credits**



### Steps

## 1. Team Budget Setup
#### Step 1: Team Budget Setup

**Steps:**
1. Open the **Budget** window.
2. Select the desired **Team**.
3. Set the **Maximum Budget** for the team.

- Open the **Budget** window.
- Select the desired **Team**.
- Set the **Maximum Budget** for the team.
- Choose the **Budget Period**:
- Monthly
- Quarterly
- Half-Yearly
- Annually
- (Optional) Enable **Auto-Renewal** by checking the box. This will automatically reset the budget at the end of each period.
We have calculated the total budget in credits, based on the combined costs of the Premium Model and the BYOK (Bring Your Own Key) Model. The conversion rate used is 1 USD = 150 credits.

<img src="./enterprise-images/teambudget.png" alt="budget" />

## 2. Individual User Budget Allocation
**Budget Summary Example:**

**Steps:**
- **Total Budget Allocated**: 4,500 credits

- Within the selected team, give the user’s name to edit budget limit.
- For each user:
- Set the **Maximum Budget**.
- Define the **Budget Period**.
- Monitor usage and adjust as needed.
**1. BYOK Model**
- Dollar Amount: \$23
- Conversion Rate: 1 USD = 150 credits
- Total BYOK Cost: 23 × 150 = **3,450 credits**

<img src="./enterprise-images/memberbudget.png" alt="budget" />
**2. Premium Model**
- Dollar Amount: \$7
- Total Premium Cost: **1,050 credits**

**Combined Total Cost**:
**3,450 (BYOK) + 1,050 (Premium) = 4,500 credits**

4. Choose the **Budget Period**:
- Monthly
- Quarterly
- Half-Yearly
- Annually

## 3. Usage Alerts
5. *(Optional)* Enable **Auto-Renewal** to reset the budget at the end of each period.

Administrators can set up alerts to notify when budget usage exceeds a defined threshold.

**Steps:**

- Open the **Edit usage Alert**.
- Set the **Usage Threshold** (e.g., 50%).
- Enter the **Email Subject Prefix** (required).
- Specify the **Recipients** for the alert (e.g., team leads or finance managers). An alert email will be sent to the recipient.
- Click **Update** to activate the alert.
#### Step 2: Individual User Budget Allocation

1. Within the selected team, choose the user to edit their budget.
2. Set the **Maximum Budget**.
3. Define the **Budget Period**.
4. Monitor usage and adjust as needed.
<img src="./enterprise-images/memberbudget.png" alt="budget" />

#### Step 3: Usage Alerts

Admins can set up alerts to notify when budget usage exceeds a defined threshold.

1. Open **Edit Usage Alert**.
2. Set the **Usage Threshold** (e.g., 50%).
3. Enter the **Email Subject Prefix**.
4. Specify the **Recipients** (e.g., team leads or managers).
5. Click **Update** to activate the alert.
<img src="./enterprise-images/alert.png" alt="budget" />

🔔 Alerts help proactively manage budget overruns and ensure timely action.
> 🔔 **Alerts help proactively manage budget overruns and ensure timely action.**



### Validation

- **Team Budget**: Appears in Budget Overview with correct total, period, and auto-renew status.
- **User Budget**: Displays under team with per-user cap and usage bar.
- **Credit Math**:
- \$1 = 150 credits
- 4,500 credits = ~$30 total spend allowed
- **Auto-Renew**: Budget resets at the end of the selected period (e.g., monthly).



### Troubleshooting

- **Budget not saving**
→ Entered non-numeric value or missing period
→ *Fix*: Use numbers only; select a period

- **Team not in dropdown**
→ Team not created or you lack access
→ *Fix*: Create team in **Users & Teams**; check your role

- **Usage not deducting from budget**
→ BYOK model not tracked or credits disabled
→ *Fix*: Ensure BYOK key is active; check **Billing** tab

- **No alert email received**
→ Threshold too high or recipients misspelled
→ *Fix*: Lower to 50% for testing; verify email addresses

- **Auto-renewal not resetting**
→ Feature disabled or period misaligned
→ *Fix*: Re-enable toggle; wait until exact period boundary (e.g., midnight UTC)

- **User exceeds budget but still works**
→ Soft limit (warning only) or alert misconfigured
→ *Fix*: Budgets are flexible — use alerts + manual enforcement

- **Can’t find Budget tab**
→ You’re not an Admin or Team Lead
→ *Fix*: Ask Admin to assign the correct role








Loading