Skip to content

Commit b03fcab

Browse files
committed
AI documenation
1 parent d9d82c2 commit b03fcab

13 files changed

Lines changed: 44 additions & 15 deletions

wiki-content/Operation.md

Lines changed: 44 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ From the dashboard, you can:
3333

3434
## Creating a Job
3535

36+
![new-job-dialog](images/new-job-dialog.png)
37+
3638
1. Click **Create Job** on the home page.
3739
2. Fill in the required fields:
3840
- **Job Name** — A descriptive name for the job
39-
- **Organization** — The organization this job belongs to
40-
- **Environment** — The execution environment (e.g., Development, Production)
41+
- **Job Groups (optional)** — The organization this job belongs to
4142
3. Click **Save** to create the job.
4243

4344
The new job is created in a disabled state. You need to upload or write code, configure a schedule, and enable the job before it will execute.
@@ -50,14 +51,18 @@ The Job Details dialog is the central management interface for each job. It is o
5051

5152
### Details Tab
5253

53-
- **Job Name** — View or edit the job name
54+
![new-job-dialog](images/job-details-dialog.png)
55+
56+
- **Base Job Name** — View or edit the job name
5457
- **Enabled** toggle — Enable or disable the job
5558
- **Environment** — Set the execution environment
5659
- **Queue** — Assign the job to a specific queue (e.g., `default`)
5760
- **Run Job Now** button — Queue the job for immediate execution
5861

5962
### Schedules Tab
6063

64+
![schedule-dialog.png](images/schedule-dialog.png)
65+
6166
Configure one or more schedules for the job:
6267

6368
- **Schedule Name** — A label for this schedule
@@ -68,32 +73,40 @@ Configure one or more schedules for the job:
6873

6974
### Parameters Tab
7075

76+
![parameters-dialog](images/parameters-dialog.png)
77+
7178
Attach key-value data to the job:
7279

7380
- **Field Description** — A label describing the parameter
7481
- **Value** — Supports string, integer, or date values
7582

7683
Parameters are accessible to job code through the execution context.
7784

78-
### Code Tab
85+
### Logs Tab
7986

80-
Write or upload job code. See the [Online](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Online) guide for detailed editor usage.
87+
![logs-dialog](images/logs-dialog.png)
88+
89+
View execution history and log entries:
90+
91+
- Select a **Job Instance** from the dropdown to filter logs
92+
- Each log entry shows: Action, Details, Level, and Timestamp
93+
- Timestamps are adjusted by the configured timezone offset
8194

8295
### Webhook Tab
8396

97+
![webhook-dialog](images/webhook-dialog.png)
98+
8499
Enable a webhook endpoint for the job:
85100

86101
- Toggle the **Webhook Enabled** switch
87102
- A unique GUID is generated and displayed as the webhook URL
88103
- External systems can trigger the job via `GET` or `POST` to `/webhook/{GUID}`
89104

90-
### Logs Tab
105+
### Code Tab
91106

92-
View execution history and log entries:
107+
![code-dialog](images/code-dialog.png)
93108

94-
- Select a **Job Instance** from the dropdown to filter logs
95-
- Each log entry shows: Action, Details, Level, and Timestamp
96-
- Timestamps are adjusted by the configured timezone offset
109+
Write or upload job code. See the [Online](https://github.com/Blazor-Data-Orchestrator/BlazorDataOrchestrator/wiki/Online) guide for detailed editor usage.
97110

98111
---
99112

@@ -113,10 +126,10 @@ There are three ways to trigger job execution:
113126

114127
### Viewing Logs
115128

116-
1. Open the **Job Details** dialog for the job.
117-
2. Navigate to the **Logs** tab.
118-
3. Select the job instance to inspect from the dropdown.
119-
4. Log entries are displayed in a table with columns for Action, Details, Level, and Timestamp.
129+
![main-logs](images/main-logs.png)
130+
131+
1. Navigate to the **Logs** tab.
132+
2. Log entries are displayed in a table with columns for Action, Details, Level, and Timestamp.
120133

121134
### Understanding Job Status
122135

@@ -135,21 +148,37 @@ Navigate to the **Administration** page via the navigation link on the home page
135148

136149
### Job Groups Tab
137150

151+
![jog-groups](images/jog-groups.png)
152+
138153
- Create and manage organizational groups for categorizing jobs.
139154
- Groups have a name and an active/inactive status.
140155
- Assign jobs to groups for easier filtering and management.
141156

142157
### Job Queues Tab
143158

159+
![job-queues](images/job-queues.png)
160+
144161
- Create and manage queue configurations.
145162
- Each queue has a name (e.g., `default`, `jobs-large-container`, `onprem-queue`).
146163
- Assign queues to jobs to route their execution to specific agent pools.
147164
- Deploy agents configured with matching `QueueName` settings to process queue-specific workloads.
148165

149-
### Settings Tab
166+
### Timezone Settings Tab
167+
168+
![timezone-settings](images/timezone-settings.png)
150169

151170
- **Timezone Offset** — Configure the timezone offset (in hours) for log display. This offset is applied to all timestamps shown in the UI.
152171

172+
### AI Settings Tab
173+
174+
![ai-settings](images/ai-settings.png)
175+
176+
| Status | Meaning |
177+
|--------|---------|
178+
| **AI Service Type** | Choose the AI provider |
179+
| **API Key** | Enter the API key supplied by the AI provider |
180+
| **Model** | Choose the model to use |
181+
153182
---
154183

155184
## Agent Behavior
29.3 KB
Loading
30 KB
Loading
33.8 KB
Loading

wiki-content/images/job-queues.png

21.4 KB
Loading

wiki-content/images/jog-groups.png

19 KB
Loading
115 KB
Loading

wiki-content/images/main-logs.png

45 KB
Loading
20.7 KB
Loading
36 KB
Loading

0 commit comments

Comments
 (0)