README + add tests cases
This commit is contained in:
80
README.md
80
README.md
@@ -0,0 +1,80 @@
|
||||
# Knowledge One View CLI Skill
|
||||
|
||||
This Codex skill lets Codex fetch and analyze Oracle Analytics LAD Knowledge One View data through direct Oracle DV backend APIs, without manual browser scraping.
|
||||
|
||||
Use it for sales, presales, pipeline, opportunity, workload, revenue-line, service-request, and team-result questions. Codex can also turn the data into follow-up work: targeted email drafts, spreadsheets, presentations, WON mapping, resource summaries, and manager-ready outputs.
|
||||
|
||||
## What Codex Can Do With This Skill
|
||||
|
||||
With this skill installed, Codex can help you:
|
||||
|
||||
- Fetch opportunity, pipeline, workload, revenue-line, SR, and resource-involvement data.
|
||||
- Filter by close date, month, fiscal quarter, week, custom window, seller, manager, resource, or team.
|
||||
- Map WON activity for a team, seller, manager, resource, or fiscal week.
|
||||
- Generate spreadsheets, presentation-ready summaries, and targeted email drafts from the results.
|
||||
- Return answers with scope, source, defaults, filters, row counts, warnings, and assumptions.
|
||||
|
||||
In practice, you can ask Codex questions like:
|
||||
|
||||
```text
|
||||
Show Brazil opportunities closing in FY26-Q4 for seller <seller.email@oracle.com>.
|
||||
```
|
||||
|
||||
```text
|
||||
List workloads closing next week that have allocated resources under manager <manager.email@oracle.com>.
|
||||
```
|
||||
|
||||
```text
|
||||
Get SRs for resource <resource.email@oracle.com> and explain the scope used.
|
||||
```
|
||||
|
||||
```text
|
||||
Map WON workloads for team <team-or-manager-placeholder> in week <FY26-Q4-09> and generate a spreadsheet.
|
||||
```
|
||||
|
||||
```text
|
||||
Draft email follow-ups for resources in <resource-list-placeholder> based on the WON validation results.
|
||||
```
|
||||
|
||||
Codex will choose the shortest safe path, normally by running `scripts/fetch-sales-intelligence.mjs` with an intent, view, query, or SQL mode.
|
||||
|
||||
## How It Works
|
||||
|
||||
Install the skill, then ask Codex for Knowledge One View data or an output based on it. If authentication is needed, Codex opens Chrome so you can complete the Oracle login flow.
|
||||
|
||||
Chrome is mandatory for authentication, especially for SSO or MFA. After the session is valid, Codex continues browserless: it calls the Oracle DV backend APIs directly, receives the backend data, applies the requested filters or intent, and returns the answer or creates the requested output. Chrome is reopened only when the saved session expires or needs to be refreshed.
|
||||
|
||||
## Installation From Git
|
||||
|
||||
Clone the skill:
|
||||
|
||||
```bash
|
||||
cd ~/.codex/skills
|
||||
git clone https://git.tech-lad.com.br/marceloarbore/knowledge-one-view-cli.git
|
||||
```
|
||||
|
||||
Create a branch before editing:
|
||||
|
||||
```bash
|
||||
cd ~/.codex/skills/knowledge-one-view-cli
|
||||
git checkout -b feature/my-change
|
||||
```
|
||||
|
||||
If it already exists, update it first:
|
||||
|
||||
```bash
|
||||
cd ~/.codex/skills/knowledge-one-view-cli
|
||||
git pull origin main
|
||||
git checkout -b feature/my-change
|
||||
```
|
||||
|
||||
After installing or updating the skill, restart Codex or reload the session so the skill list is refreshed.
|
||||
|
||||
Live data access requires permission to access the Sales Intelligence Knowledge One View workbook at `salesintelligence-dv.oracle.com`.
|
||||
|
||||
## Notes For Contributors
|
||||
|
||||
- Keep stable Codex instructions in `SKILL.md`.
|
||||
- Put detailed CLI behavior and field mappings in `references/`.
|
||||
- Add tests when changing intents, query behavior, SQL builders, scope disclosure, or output contracts.
|
||||
- Keep generated outputs, temporary files, and local workspace artifacts outside the skill repository whenever possible.
|
||||
|
||||
Reference in New Issue
Block a user