@salesforce/afv-skills 1.7.4 → 1.8.0

package/skills/getting-datacloud-schema/SKILL.md

@@ -0,0 +1,380 @@
+---
+name: getting-datacloud-schema
+description: "Retrieve Data Lake Object (DLO) and Data Model Object (DMO) schema information from Salesforce Data Cloud using REST APIs. Use this skill when you need to inspect DLO or DMO field definitions, data types, or metadata. Takes org alias and optional DLO/DMO name as parameters."
+metadata:
+  version: "1.0"
+---
+
+# getting-datacloud-schema Skill
+
+
+## Overview
+
+This skill retrieves Data Lake Object (DLO) and Data Model Object (DMO) schema information from Salesforce Data Cloud using the SSOT REST API. It can list all DLOs or DMOs in an org, or retrieve detailed schema for a specific DLO or DMO.
+
+## When to Use
+
+- User wants to see all DLOs or DMOs in a Data Cloud org
+- User needs field schema for a specific DLO or DMO
+- User is exploring Data Cloud data structures
+- User needs to understand DLO or DMO field types and metadata
+
+## Prerequisites
+
+- SF CLI installed and authenticated to target org
+- Org has Data Cloud enabled
+- User has appropriate Data Cloud permissions
+
+## Skill Execution
+
+### Parameters
+
+1. **org_alias** (required): The SF CLI org alias (e.g., 'afvibe', 'myorg')
+2. **dlo_name** (optional): Specific DLO developer name (e.g., 'Employee__dll')
+3. **dmo_name** (optional): Specific DMO developer name (e.g., 'Individual__dlm')
+
+### Step 1: Discover Connected Org
+
+First, run `sf org list` to find out which org is connected and extract the alias to use for all subsequent calls:
+
+```bash
+sf org list
+```
+
+Example output:
+```
+┌────┬───────┬──────────────────────────┬────────────────────┬───────────┐
+│    │ Alias │ Username                 │ Org Id             │ Status    │
+├────┼───────┼──────────────────────────┼────────────────────┼───────────┤
+│ 🍁 │ myorg │ chandresh@afvidedemo.org │ 00DKZ00000b80NT2AY │ Connected │
+└────┴───────┴──────────────────────────┴────────────────────┴───────────┘
+```
+
+Extract the **Alias** value (e.g., `myorg`) from the output and use it as the `<org_alias>` for all subsequent calls. Use `--all` to see expired and deleted scratch orgs as well.
+
+### Step 2: Validate SF CLI Authentication
+
+Before making API calls, verify the org is connected:
+
+```bash
+sf org display --target-org <org_alias> --json
+```
+
+If not connected, inform user to run:
+```bash
+sf org login web --alias <org_alias>
+```
+
+### Step 3a: Execute DLO Schema Script
+
+The Python scripts are bundled with this skill. They live in the `scripts/` subdirectory of the same directory that contains this SKILL.md file. Use the absolute path to that directory — do NOT use `./scripts/` as that resolves relative to the current working directory, not the skill directory.
+
+**To list all DLOs:**
+```bash
+python3 <skill_dir>/scripts/get_dlo_schema.py <org_alias>
+```
+
+**To get specific DLO schema:**
+```bash
+python3 <skill_dir>/scripts/get_dlo_schema.py <org_alias> <dlo_name>
+```
+
+### Step 3b: Execute DMO Schema Script
+
+**To list all DMOs:**
+```bash
+python3 <skill_dir>/scripts/get_dmo_schema.py <org_alias>
+```
+
+**To get specific DMO schema:**
+```bash
+python3 <skill_dir>/scripts/get_dmo_schema.py <org_alias> <dmo_name>
+```
+
+### Step 4: Present Results
+
+Parse and present the results in a user-friendly format:
+
+**For DLO List:**
+- Show DLO name, label, category, and ID
+- Indicate total count
+- Highlight DLOs with data (totalRecords > 0)
+
+**For DLO Schema:**
+- Show basic info (name, label, category, status)
+- List all fields with:
+  - Field name
+  - Data type
+  - Primary key indicator
+  - Nullable status
+- Highlight custom fields (exclude system fields like DataSource__c, cdp_sys_*)
+- Show record count if available
+
+**For DMO List:**
+- Show DMO name, label, category, and ID
+- Indicate total count
+
+**For DMO Schema:**
+- Show basic info (name, label, category, description)
+- List all fields with:
+  - Field name
+  - Data type
+  - Primary key indicator
+  - Nullable status
+- Show dataspace information if available
+
+### Step 5: Offer Next Steps
+
+After displaying results, suggest relevant follow-up actions:
+- Query data from the DLO
+- Create calculated insights
+- Build segments
+- Set up data streams
+- Create DMO mappings
+
+## API Endpoints Used
+
+### List All DLOs
+```
+GET /services/data/v64.0/ssot/data-lake-objects
+```
+
+Response structure:
+```json
+{
+  "dataLakeObjects": [
+    {
+      "name": "Employee__dll",
+      "label": "Employee",
+      "category": "Profile",
+      "id": "1dlXXXXXXXXXXXXXXX",
+      "status": "ACTIVE",
+      "totalRecords": 12,
+      "fields": [...]
+    }
+  ],
+  "totalSize": 5
+}
+```
+
+### Get DLO Schema
+```
+GET /services/data/v64.0/ssot/data-lake-objects/{dlo_name}
+```
+
+Response structure (same as individual object in list response, but wrapped in paginated format).
+
+### List All DMOs
+```
+GET /services/data/v64.0/ssot/data-model-objects
+```
+
+Response structure:
+```json
+{
+  "dataModelObjects": [
+    {
+      "name": "Individual__dlm",
+      "label": "Individual",
+      "category": "Profile",
+      "id": "0dmXXXXXXXXXXXXXXX",
+      "fields": [...]
+    }
+  ],
+  "totalSize": 10
+}
+```
+
+### Get DMO Schema
+```
+GET /services/data/v64.0/ssot/data-model-objects/{dmo_name}
+```
+
+Response structure (same as individual object in list response, but wrapped in paginated format).
+
+## Error Handling
+
+**Common Issues:**
+
+1. **Org not connected**
+   - Message: "Org not connected"
+   - Solution: Ask user to authenticate via SF CLI
+
+2. **DLO not found**
+   - Message: "DLO 'XYZ__dll' not found"
+   - Solution: List all DLOs first to verify name
+
+5. **DMO not found**
+   - Message: "DMO 'XYZ__dlm' not found"
+   - Solution: List all DMOs first to verify name
+
+3. **Permission issues**
+   - Message: HTTP 403 errors
+   - Solution: Verify user has Data Cloud permissions
+
+4. **API version mismatch**
+   - Current: v64.0
+   - Solution: Script can be updated for newer API versions
+
+## Example Usage
+
+**Example 1: List all DLOs**
+```
+User: "Show me all DLOs in afvibe org"
+
+Response:
+1. Run sf org list to discover connected org alias
+2. Authenticate to afvibe
+3. Run: python3 <skill_dir>/scripts/get_dlo_schema.py afvibe
+4. Display formatted list of DLOs
+```
+
+**Example 2: Get specific DLO schema**
+```
+User: "Get the schema for Employee__dll in afvibe"
+
+Response:
+1. Run sf org list to discover connected org alias
+2. Authenticate to afvibe
+3. Run: python3 <skill_dir>/scripts/get_dlo_schema.py afvibe Employee__dll
+4. Display field schema with types and metadata
+```
+
+**Example 3: Explore DLOs then get schema**
+```
+User: "What DLOs exist in myorg and show me the schema for the Employee one"
+
+Response:
+1. Run sf org list to discover connected org alias
+2. List all DLOs in myorg
+3. Identify Employee__dll
+4. Get detailed schema for Employee__dll
+5. Present both results
+```
+
+**Example 4: List all DMOs**
+```
+User: "Show me all DMOs in afvibe org"
+
+Response:
+1. Run sf org list to discover connected org alias
+2. Authenticate to afvibe
+3. Run: python3 <skill_dir>/scripts/get_dmo_schema.py afvibe
+4. Display formatted list of DMOs
+```
+
+**Example 5: Get specific DMO schema**
+```
+User: "Get the schema for Individual__dlm in afvibe"
+
+Response:
+1. Run sf org list to discover connected org alias
+2. Authenticate to afvibe
+3. Run: python3 <skill_dir>/scripts/get_dmo_schema.py afvibe Individual__dlm
+4. Display field schema with types and metadata
+```
+
+**Example 6: Explore DMOs then get schema**
+```
+User: "What DMOs exist in myorg and show me the schema for the Individual one"
+
+Response:
+1. Run sf org list to discover connected org alias
+2. List all DMOs in myorg
+3. Identify Individual__dlm
+4. Get detailed schema for Individual__dlm
+5. Present both results
+```
+
+## Output Format
+
+### DLO List Output
+```
+Found 5 DLOs in org 'afvibe':
+
+1. DataCustomCodeLogs__dll
+   Label: DataCustomCodeLogs
+   Category: Engagement
+   Records: 233
+
+2. Employee__dll
+   Label: Employee
+   Category: Profile
+   Records: 12
+
+[...]
+```
+
+### DLO Schema Output
+```
+DLO: Employee__dll
+Label: Employee
+Category: Profile
+Status: ACTIVE
+Records: 12
+
+Custom Fields:
+  • id__c (Text) - Primary Key
+  • name__c (Text)
+  • position__c (Text)
+  • manager_id__c (Number)
+
+System Fields:
+  • DataSource__c (Text)
+  • InternalOrganization__c (Text)
+  • cdp_sys_SourceVersion__c (Text)
+
+Next steps:
+- Query data: SELECT * FROM Employee__dll LIMIT 10
+- Create segment based on position field
+- Set up data stream for real-time updates
+```
+
+### DMO List Output
+```
+Found 10 DMOs in org 'afvibe':
+
+1. Individual__dlm
+   Label: Individual
+   Category: Profile
+
+2. ContactPointEmail__dlm
+   Label: Contact Point Email
+   Category: Profile
+
+[...]
+```
+
+### DMO Schema Output
+```
+DMO: Individual__dlm
+Label: Individual
+Category: Profile
+Description: Represents an individual person
+
+Fields:
+  • Id__c (Text) - Primary Key
+  • FirstName__c (Text)
+  • LastName__c (Text)
+  • BirthDate__c (DateTime)
+
+Next steps:
+- Query data: SELECT * FROM Individual__dlm LIMIT 10
+- View DLO mappings to this DMO
+- Create calculated insights
+```
+
+## Notes
+
+- DLO names always end with `__dll` suffix
+- DMO names always end with `__dlm` suffix
+- Field names always end with `__c` suffix
+- System fields (DataSource__c, KQ_*, cdp_sys_*) are automatically added
+- Primary key fields are required for DLO and DMO queries
+- API supports pagination (limit/offset) for large result sets
+
+## Related Skills
+
+- **datakit_workflow**: For DMO mapping operations
+- **datakit_validation**: For validating datakit configurations
+- Use this skill before creating DMO mappings to understand source DLO structure

package/skills/getting-datacloud-schema/references/README.md

@@ -0,0 +1,191 @@
+# getting-datacloud-schema Skill
+
+## Overview
+
+A skill that retrieves Data Lake Object (DLO) and Data Model Object (DMO) schema information from Salesforce Data Cloud using REST APIs.
+
+## Usage
+
+**List all DLOs:**
+```
+"Show me all DLOs in afvibe org"
+"List Data Lake Objects in myorg"
+```
+
+**Get specific DLO schema:**
+```
+"Get the schema for Employee__dll in afvibe"
+"What fields does the Employee__dll DLO have in myorg?"
+```
+
+**List all DMOs:**
+```
+"Show me all DMOs in afvibe org"
+"List Data Model Objects in myorg"
+```
+
+**Get specific DMO schema:**
+```
+"Get the schema for Individual__dlm in afvibe"
+"What fields does the Individual__dlm DMO have in myorg?"
+```
+
+### Direct Script Usage
+
+You can also run the scripts directly:
+
+```bash
+# List all DLOs
+python3 scripts/get_dlo_schema.py <org_alias>
+
+# Get specific DLO schema
+python3 scripts/get_dlo_schema.py <org_alias> <dlo_name>
+
+# List all DMOs
+python3 scripts/get_dmo_schema.py <org_alias>
+
+# Get specific DMO schema
+python3 scripts/get_dmo_schema.py <org_alias> <dmo_name>
+```
+
+**Examples:**
+```bash
+# List all DLOs in afvibe org
+python3 scripts/get_dlo_schema.py afvibe
+
+# Get Employee__dll schema from afvibe
+python3 scripts/get_dlo_schema.py afvibe Employee__dll
+
+# List all DMOs in afvibe org
+python3 scripts/get_dmo_schema.py afvibe
+
+# Get Individual__dlm schema from afvibe
+python3 scripts/get_dmo_schema.py afvibe Individual__dlm
+```
+
+## Prerequisites
+
+1. **SF CLI Installed**
+   ```bash
+   sf --version
+   ```
+
+2. **Authenticated to Target Org**
+   ```bash
+   sf org login web --alias <org_alias>
+   ```
+
+3. **Python 3 and Dependencies**
+   ```bash
+   pip install requests pyyaml
+   ```
+
+4. **Data Cloud Enabled**
+   - Org must have Data Cloud provisioned
+   - User must have Data Cloud permissions
+
+## What It Does
+
+### List All DLOs
+- Calls: `GET /services/data/v64.0/ssot/data-lake-objects`
+- Returns: All DLOs with name, label, category, ID, record count
+- Shows paginated results
+
+### Get DLO Schema
+- Calls: `GET /services/data/v64.0/ssot/data-lake-objects/{dlo_name}`
+- Returns: Detailed field schema including field names, data types, primary key indicators, nullable status
+
+### List All DMOs
+- Calls: `GET /services/data/v64.0/ssot/data-model-objects`
+- Returns: All DMOs with name, label, category, ID
+- Shows paginated results
+
+### Get DMO Schema
+- Calls: `GET /services/data/v64.0/ssot/data-model-objects/{dmo_name}`
+- Returns: Detailed field schema including field names, data types, primary key indicators, nullable status
+
+## API Endpoints
+
+| Endpoint | Method | Purpose |
+|----------|--------|---------|
+| `/services/data/v64.0/ssot/data-lake-objects` | GET | List all DLOs |
+| `/services/data/v64.0/ssot/data-lake-objects/{name}` | GET | Get DLO schema |
+| `/services/data/v64.0/ssot/data-model-objects` | GET | List all DMOs |
+| `/services/data/v64.0/ssot/data-model-objects/{name}` | GET | Get DMO schema |
+
+## Output Format
+
+### DLO List
+```
+Found 5 DLOs in org 'afvibe':
+
+1. DataCustomCodeLogs__dll
+   Label: DataCustomCodeLogs
+   Category: Engagement
+   Records: 233
+
+2. Employee__dll
+   Label: Employee
+   Category: Profile
+   Records: 12
+```
+
+### DLO Schema
+```
+DLO: Employee__dll
+Label: Employee
+Category: Profile
+Status: ACTIVE
+Records: 12
+
+Fields (9 total):
+  - id__c (Text) - Primary Key
+  - name__c (Text)
+  - position__c (Text)
+  - manager_id__c (Number)
+  - DataSource__c (Text)
+  [...]
+```
+
+### DMO List
+```
+Found 10 DMOs in org 'afvibe':
+
+1. Individual__dlm
+   Label: Individual
+   Category: Profile
+
+2. ContactPointEmail__dlm
+   Label: Contact Point Email
+   Category: Profile
+```
+
+### DMO Schema
+```
+DMO: Individual__dlm
+Label: Individual
+Category: Profile
+
+Fields (8 total):
+  - Id__c (Text) - Primary Key
+  - FirstName__c (Text)
+  - LastName__c (Text)
+  - BirthDate__c (DateTime)
+  [...]
+```
+
+## Troubleshooting
+
+| Issue | Fix |
+|-------|-----|
+| Org not connected | `sf org login web --alias <org_alias>` |
+| Module not found: requests | `pip install requests pyyaml` |
+| DLO not found | Verify name ends with `__dll`, list all DLOs first |
+| DMO not found | Verify name ends with `__dlm`, list all DMOs first |
+| Permission denied | Verify user has Data Cloud permissions |
+
+## Related Skills
+
+- **datakit workflow**: For DMO mapping operations
+- **datakit validation**: For validating datakit configurations
+- Use this skill before creating DMO mappings to understand source DLO structure