@salesforce/afv-skills 1.6.5 → 1.6.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/skills/building-ui-bundle-app/SKILL.md +1 -1
- package/skills/building-ui-bundle-frontend/SKILL.md +3 -1
- package/skills/deploying-ui-bundle/SKILL.md +1 -1
- package/skills/generating-experience-lwr-site/SKILL.md +11 -1
- package/skills/generating-experience-lwr-site/docs/update-site-urls.md +100 -0
- package/skills/generating-ui-bundle-features/SKILL.md +1 -1
- package/skills/generating-ui-bundle-metadata/SKILL.md +9 -2
- package/skills/generating-ui-bundle-site/SKILL.md +14 -2
- package/skills/generating-ui-bundle-site/docs/configure-metadata-digital-experience.md +4 -2
- package/skills/generating-ui-bundle-site/docs/update-site-urls.md +100 -0
- package/skills/implementing-ui-bundle-agentforce-conversation-client/SKILL.md +216 -37
- package/skills/implementing-ui-bundle-agentforce-conversation-client/references/style-tokens.md +168 -21
- package/skills/implementing-ui-bundle-file-upload/SKILL.md +1 -1
- package/skills/searching-media/SKILL.md +1 -1
- package/skills/using-ui-bundle-salesforce-data/SKILL.md +338 -92
- package/skills/using-ui-bundle-salesforce-data/references/mutation-query-generation.md +0 -140
- package/skills/using-ui-bundle-salesforce-data/references/query-testing.md +0 -78
- package/skills/using-ui-bundle-salesforce-data/references/read-query-generation.md +0 -307
- package/skills/using-ui-bundle-salesforce-data/references/schema-introspection.md +0 -53
- package/skills/using-ui-bundle-salesforce-data/references/ui-bundle-integration.md +0 -221
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/afv-skills",
|
|
3
|
-
"version": "1.6.
|
|
3
|
+
"version": "1.6.7",
|
|
4
4
|
"description": "Salesforce skills for Agentforce Vibes",
|
|
5
5
|
"license": "CC-BY-NC-4.0",
|
|
6
6
|
"files": [
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
"registry": "https://registry.npmjs.org"
|
|
12
12
|
},
|
|
13
13
|
"devDependencies": {
|
|
14
|
-
"@salesforce/ui-bundle-template-app-react-sample-b2e": "^1.
|
|
15
|
-
"@salesforce/ui-bundle-template-app-react-sample-b2x": "^1.
|
|
14
|
+
"@salesforce/ui-bundle-template-app-react-sample-b2e": "^1.120.2",
|
|
15
|
+
"@salesforce/ui-bundle-template-app-react-sample-b2x": "^1.120.2",
|
|
16
16
|
"@salesforce/webapp-template-app-react-sample-b2e-experimental": "^1.117.1",
|
|
17
17
|
"@salesforce/webapp-template-app-react-sample-b2x-experimental": "^1.117.1",
|
|
18
18
|
"@types/js-yaml": "^4.0.9",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: building-ui-bundle-app
|
|
3
|
-
description: "
|
|
3
|
+
description: "MUST activate when the project contains a uiBundles/*/src/ directory or sfdx-project.json and the prompt says create, build, construct, or generate a new app, site, or page from scratch — even if the prompt also describes visual styling. MUST also activate when the task spans more than one ui-bundle skill. Use this skill when building a complete app end-to-end. This is the orchestrator that coordinates scaffolding, features, data access, frontend UI, integrations, and deployment in the correct dependency order. Without it, phases execute out of order and the app breaks. Do NOT use for Lightning Experience apps with custom objects (use generating-lightning-app). Do NOT use for single-concern edits to an existing page (use building-ui-bundle-frontend)."
|
|
4
4
|
metadata:
|
|
5
5
|
version: "1.0"
|
|
6
6
|
related-skills: generating-ui-bundle-metadata, generating-ui-bundle-features, using-ui-bundle-salesforce-data, building-ui-bundle-frontend, implementing-ui-bundle-agentforce-conversation-client, implementing-ui-bundle-file-upload, deploying-ui-bundle, generating-experience-react-site
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: building-ui-bundle-frontend
|
|
3
|
-
description: "
|
|
3
|
+
description: "MUST activate before editing ANY file under uiBundles/*/src/ for visual or UI changes to an EXISTING app — pages, components, sections, layout, styling, colors, fonts, navigation, animations, or any look-and-feel change. Use this skill when modifying pages, components, layout, styling, or navigation in an existing UI bundle app. Activate when the project contains appLayout.tsx, routes.tsx, src/pages/, src/components/, or global.css. This skill contains critical project-specific conventions (appLayout.tsx shell, shadcn/ui components, Tailwind CSS, Salesforce base-path routing, module restrictions) that override general knowledge. Without this skill, generated code will use wrong imports, break routing, or ignore project structure. Do NOT use when creating a new app from scratch (use building-ui-bundle-app instead)."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# UI Bundle UI
|
|
@@ -94,6 +94,8 @@ Choose a clear conceptual direction and execute it with precision. Bold maximali
|
|
|
94
94
|
- **Spatial Composition:** Unexpected layouts — asymmetry, overlap, diagonal flow, grid-breaking elements. Generous negative space OR controlled density.
|
|
95
95
|
- **Backgrounds & Depth:** Create atmosphere rather than defaulting to solid colors. Gradient meshes, noise textures, geometric patterns, layered transparencies, dramatic shadows, decorative borders, grain overlays.
|
|
96
96
|
|
|
97
|
+
- **Mobile Responsiveness:** All generated UI MUST be mobile-responsive. Use Tailwind responsive prefixes (`sm:`, `md:`, `lg:`) to adapt layouts across breakpoints. Stack columns on small screens, use flexible grids, and ensure touch targets are at least 44px. Test that navigation, typography, and spacing work on mobile viewports.
|
|
98
|
+
|
|
97
99
|
Match implementation complexity to the aesthetic vision. Maximalist designs need elaborate animations and effects. Minimalist designs need restraint, precision, and careful spacing/typography. No two designs should look the same — vary themes, fonts, and aesthetics across generations.
|
|
98
100
|
|
|
99
101
|
---
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: deploying-ui-bundle
|
|
3
|
-
description: "
|
|
3
|
+
description: "MUST activate when the project contains a uiBundles/*/src/ directory or sfdx-project.json and the task involves deploying, pushing to an org, or post-deploy setup. Use this skill when deploying a UI bundle app to a Salesforce org. Covers the full deployment sequence: org authentication, pre-deploy build, metadata deployment, permission set assignment, data import, GraphQL schema fetch, and codegen. Activate when files like *.uibundle-meta.xml or sfdx-project.json exist and the user mentions deploying, pushing, org setup, or post-deploy tasks."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Deploying a UI Bundle
|
|
@@ -102,6 +102,7 @@ Before doing anything, you **MUST ALWAYS** load them first if they match user in
|
|
|
102
102
|
- [handle-component-and-region-ids.md](docs/handle-component-and-region-ids.md) - **UUID generation (CRITICAL)** for component and region ids used in views and themeLayout.
|
|
103
103
|
- [handle-ui-components.md](docs/handle-ui-components.md) - Component discovery, schemas, insertion, configuration
|
|
104
104
|
- [configure-guest-sharing-rules.md](docs/configure-guest-sharing-rules.md) - **Guest sharing rules** (`sharingGuestRules`) for public sites — use for any request involving "guest sharing rule", "Site Guest User", or sharing object records with unauthenticated visitors
|
|
105
|
+
- [update-site-urls.md](docs/update-site-urls.md) - **Updating site URLs** - URL architecture, workflow for updating `urlPathPrefix` in DigitalExperienceConfig, Network, and CustomSite
|
|
105
106
|
|
|
106
107
|
## Common Workflows
|
|
107
108
|
|
|
@@ -211,6 +212,15 @@ The site developer name can be found in the CustomSite filename (e.g., `sites/My
|
|
|
211
212
|
|
|
212
213
|
If the site is not found, an error message will be returned indicating that the site may not be deployed. Ensure the site has been successfully deployed before calling this action.
|
|
213
214
|
|
|
215
|
+
### Updating Experience Site URLs
|
|
216
|
+
|
|
217
|
+
**Use when** user wants to update or change site URLs (urlPathPrefix).
|
|
218
|
+
|
|
219
|
+
**Steps** (Follow the steps sequentially. Do not skip any step before proceeding):
|
|
220
|
+
|
|
221
|
+
- [ ] MUST read [update-site-urls.md](docs/update-site-urls.md) to understand the three-component architecture and URL update workflow
|
|
222
|
+
- [ ] Follow the step-by-step workflow in the doc to update URLs consistently across all three components (DigitalExperienceConfig, Network, CustomSite)
|
|
223
|
+
|
|
214
224
|
### Validation & Deployment
|
|
215
225
|
|
|
216
226
|
Use `sf` CLI to validate and deploy. Access help docs by attaching `--help`, e.g.:
|
|
@@ -230,4 +240,4 @@ sf project deploy validate --metadata DigitalExperienceBundle DigitalExperience
|
|
|
230
240
|
|
|
231
241
|
```bash
|
|
232
242
|
sf project deploy start --metadata DigitalExperienceBundle DigitalExperience DigitalExperienceConfig Network CustomSite --target-org ${usernameOrAlias}
|
|
233
|
-
```
|
|
243
|
+
```
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Updating Experience Site URLs
|
|
2
|
+
|
|
3
|
+
Experience sites have a three-component architecture with two distinct URL patterns. Understanding this structure is critical when updating site URLs.
|
|
4
|
+
|
|
5
|
+
## Architecture Overview
|
|
6
|
+
|
|
7
|
+
Every Salesforce Experience Site consists of three components:
|
|
8
|
+
|
|
9
|
+
1. **Network** (metadata: `Network`) - Network configuration
|
|
10
|
+
2. **ChatterNetwork Site** (metadata: `CustomSite`) - Authentication endpoints and core site services
|
|
11
|
+
3. **ChatterNetworkPicasso Site** (metadata: `DigitalExperienceConfig` + `DigitalExperienceBundle`) - Customer-facing pages and content
|
|
12
|
+
|
|
13
|
+
## URL Pattern
|
|
14
|
+
|
|
15
|
+
These three components use **two different URLs**:
|
|
16
|
+
|
|
17
|
+
- **Primary URL** (ChatterNetworkPicasso): Used for customer-facing pages
|
|
18
|
+
- Defined in: `DigitalExperienceConfig` → `<urlPathPrefix>`
|
|
19
|
+
- Example: `mysite`
|
|
20
|
+
|
|
21
|
+
- **Secondary URL** (Network + CustomSite): Used for authentication endpoints and other services
|
|
22
|
+
- Defined in: `Network` → `<urlPathPrefix>` AND `CustomSite` → `<urlPathPrefix>`
|
|
23
|
+
- Example: `mysitevforcesite`
|
|
24
|
+
- **Must be synchronized** - both files must have identical values
|
|
25
|
+
|
|
26
|
+
By default, Salesforce differentiates these URLs by appending `vforcesite` suffix to the Network/CustomSite URL.
|
|
27
|
+
|
|
28
|
+
## URL Update Workflow
|
|
29
|
+
|
|
30
|
+
When updating site URLs, follow this workflow:
|
|
31
|
+
|
|
32
|
+
### Step 1: Discover All URL References
|
|
33
|
+
|
|
34
|
+
Search for all occurrences of `urlPathPrefix` across the project metadata files.
|
|
35
|
+
|
|
36
|
+
**For agents**: Use the `search_files` tool with these parameters:
|
|
37
|
+
- path: `force-app/main/default`
|
|
38
|
+
- regex: `urlPathPrefix`
|
|
39
|
+
- file_pattern: `*.xml`
|
|
40
|
+
|
|
41
|
+
**For humans**: Use your IDE's search functionality or command line tools:
|
|
42
|
+
```bash
|
|
43
|
+
# Using grep
|
|
44
|
+
grep -r "urlPathPrefix" force-app/main/default --include="*.xml"
|
|
45
|
+
|
|
46
|
+
# Using VS Code: Ctrl+Shift+F (Windows/Linux) or Cmd+Shift+F (Mac)
|
|
47
|
+
# Search for: urlPathPrefix
|
|
48
|
+
# Files to include: *.xml
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Step 2: Identify URL Groups
|
|
52
|
+
|
|
53
|
+
Determine which files belong to which URL group:
|
|
54
|
+
|
|
55
|
+
- **Primary URL Group**: `DigitalExperienceConfig`
|
|
56
|
+
- **Secondary URL Group**: `Network` AND `CustomSite`
|
|
57
|
+
|
|
58
|
+
### Step 3: Update URLs Consistently
|
|
59
|
+
|
|
60
|
+
Update the `<urlPathPrefix>` value in each file:
|
|
61
|
+
|
|
62
|
+
- **DigitalExperienceConfig**: Update to new primary URL
|
|
63
|
+
- **Network**: Update to new secondary URL (typically primary URL + `vforcesite`)
|
|
64
|
+
- **CustomSite**: Update to **same value as Network** (must be synchronized)
|
|
65
|
+
|
|
66
|
+
### Step 4: Validate Naming Convention
|
|
67
|
+
|
|
68
|
+
Ensure URL values follow best practices:
|
|
69
|
+
- Use lowercase letters only
|
|
70
|
+
- Avoid special characters except hyphens where appropriate
|
|
71
|
+
- Keep URLs concise and meaningful
|
|
72
|
+
|
|
73
|
+
### Step 5: Verify Consistency
|
|
74
|
+
|
|
75
|
+
Before deploying, confirm:
|
|
76
|
+
- [ ] Primary URL in `DigitalExperienceConfig` is set correctly
|
|
77
|
+
- [ ] Secondary URL in `Network` matches `CustomSite` exactly
|
|
78
|
+
- [ ] URLs are properly differentiated (typically via suffix)
|
|
79
|
+
- [ ] All URL values follow naming conventions
|
|
80
|
+
|
|
81
|
+
## Example URL Configuration
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
ChatterNetworkPicasso Site (Primary):
|
|
85
|
+
DigitalExperienceConfig: <urlPathPrefix>bestsupport</urlPathPrefix>
|
|
86
|
+
|
|
87
|
+
Network + ChatterNetwork Site (Secondary):
|
|
88
|
+
Network: <urlPathPrefix>bestsupportvforcesite</urlPathPrefix>
|
|
89
|
+
CustomSite: <urlPathPrefix>bestsupportvforcesite</urlPathPrefix>
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Common Pitfalls to Avoid
|
|
93
|
+
|
|
94
|
+
❌ **Don't** update only one or two files - all three must be updated
|
|
95
|
+
❌ **Don't** use different values in Network and CustomSite
|
|
96
|
+
❌ **Don't** use the same URL for both Primary and Secondary groups
|
|
97
|
+
❌ **Don't** skip the discovery step with `search_files`
|
|
98
|
+
✅ **Do** use `search_files` to find all occurrences first
|
|
99
|
+
✅ **Do** maintain URL differentiation between the two groups
|
|
100
|
+
✅ **Do** follow lowercase naming conventions
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: generating-ui-bundle-features
|
|
3
|
-
description: "
|
|
3
|
+
description: "MUST activate when the project contains a uiBundles/*/src/ directory and the user wants to add authentication or search to their app. Use this skill when adding authentication or search to a UI bundle app. Only covers two features: authentication (login, logout, protected routes, session management) and search (global search across pages and content). Always use this skill for these two features instead of building from scratch."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# UI Bundle Features
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: generating-ui-bundle-metadata
|
|
3
|
-
description: "
|
|
3
|
+
description: "MUST activate when the project contains a uiBundles/*/src/ directory and scaffolding a new UI bundle or app, or when editing ui-bundle.json, .uibundle-meta.xml, or CSP trusted site files. Use this skill when scaffolding with sf template generate ui-bundle, configuring ui-bundle.json (routing, headers, outputDir), or registering CSP Trusted Sites. Activate when the task involves files matching *.uibundle-meta.xml, ui-bundle.json, or cspTrustedSites/*.cspTrustedSite-meta.xml."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# UI Bundle Metadata
|
|
@@ -9,7 +9,14 @@ description: "Scaffold new Salesforce UI bundles and configure their metadata
|
|
|
9
9
|
|
|
10
10
|
Use `sf template generate ui-bundle` to create new apps — not create-react-app, Vite, or other generic scaffolds.
|
|
11
11
|
|
|
12
|
-
**
|
|
12
|
+
**Always pass `--template reactbasic`** to scaffold a React-based bundle.
|
|
13
|
+
|
|
14
|
+
**UI bundle name (`-n`):** Alphanumerical only — no spaces, hyphens, underscores, or special characters.
|
|
15
|
+
|
|
16
|
+
**Example:**
|
|
17
|
+
```bash
|
|
18
|
+
sf template generate ui-bundle -n CoffeeBoutique --template reactbasic
|
|
19
|
+
```
|
|
13
20
|
|
|
14
21
|
After generation:
|
|
15
22
|
1. Replace all default boilerplate — "React App", "Vite + React", default `<title>`, placeholder text
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: generating-ui-bundle-site
|
|
3
|
-
description: "
|
|
3
|
+
description: "MUST activate when the project contains a uiBundles/*/src/ directory and the task involves creating or configuring site infrastructure. Use this skill when creating or configuring a Salesforce Digital Experience Site for hosting a UI bundle. Activate when files matching digitalExperiences/, networks/, customSite/, or DigitalExperienceBundle exist and need modification, or when the user wants to publish, host, or configure guest access for their app."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Digital Experience Site for React UI Bundles
|
|
@@ -51,6 +51,8 @@ Use the default templates in the docs below. Values in `{braces}` are resolved p
|
|
|
51
51
|
| DigitalExperienceBundle | [configure-metadata-digital-experience-bundle.md](docs/configure-metadata-digital-experience-bundle.md) |
|
|
52
52
|
| DigitalExperience (sfdc_cms__site) | [configure-metadata-digital-experience.md](docs/configure-metadata-digital-experience.md) |
|
|
53
53
|
|
|
54
|
+
For URL updates, see [update-site-urls.md](docs/update-site-urls.md).
|
|
55
|
+
|
|
54
56
|
### Execution Note for Step 3: Load and use the docs
|
|
55
57
|
- Agents MUST read the full contents of each docs/*.md file referenced in Step 3 before attempting to populate metadata fields.
|
|
56
58
|
- Use your platform's file-read tool (for example, `read_file`) to load these files in full, then perform placeholder substitution for values in `{braces}` using the resolved properties from Step 1.
|
|
@@ -63,7 +65,7 @@ Use the default templates in the docs below. Values in `{braces}` are resolved p
|
|
|
63
65
|
- Read entire file contents, replace placeholders (e.g. `{siteName}`) with the resolved values, then use the expanded templates to populate the metadata XML/JSON content.
|
|
64
66
|
|
|
65
67
|
### Step 4: Resolve Additional Configurations
|
|
66
|
-
Address any extra configurations the user requests. Use the metadata sections and field context identified in Step 2 to understand each field
|
|
68
|
+
Address any extra configurations the user requests. Use the metadata sections and field context identified in Step 2 to understand each field's purpose and constraints, then update only the minimum necessary fields.
|
|
67
69
|
|
|
68
70
|
## Verification Checklist
|
|
69
71
|
Before deploying, confirm:
|
|
@@ -76,3 +78,13 @@ Before deploying, confirm:
|
|
|
76
78
|
```bash
|
|
77
79
|
sf project deploy validate --metadata Network CustomSite DigitalExperienceConfig DigitalExperienceBundle DigitalExperience --target-org ${usernameOrAlias}
|
|
78
80
|
```
|
|
81
|
+
|
|
82
|
+
## Common Workflows
|
|
83
|
+
|
|
84
|
+
### Updating Experience Site URLs
|
|
85
|
+
|
|
86
|
+
**Use when** user wants to update or change site URLs (urlPathPrefix).
|
|
87
|
+
|
|
88
|
+
**Steps**:
|
|
89
|
+
- [ ] Read [update-site-urls.md](docs/update-site-urls.md) to understand the three-component architecture and URL update workflow
|
|
90
|
+
- [ ] Follow the step-by-step workflow in the doc to update URLs consistently across all three components (DigitalExperienceConfig, Network, CustomSite)
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Purpose
|
|
4
4
|
These configuration files create **net-new, default** DigitalExperience content records (`sfdc_cms__site` type) for a Digital Experience React Site. They are not intended to edit or modify existing DigitalExperience content. Use these templates only when provisioning a brand-new React site.
|
|
5
5
|
|
|
6
|
-
The `appContainer: true`
|
|
6
|
+
The `appContainer: true` field in `content.json` is what makes this a React site rather than a standard LWR site. The `appSpace` field should **be left empty if the UIBundle metadata record does not already exist**. When the UIBundle exists, populate the `appSpace` value following the format `{namespace}__{developerName}` to match the deployed `UIBundle` metadata record.
|
|
7
7
|
|
|
8
8
|
## File Location
|
|
9
9
|
The DigitalExperience directory contains only `_meta.json` and `content.json`. Do not create any directories other than `sfdc_cms__site` inside the bundle.
|
|
@@ -32,7 +32,9 @@ digitalExperiences/site/{siteName}1/sfdc_cms__site/{siteName}1/content.json
|
|
|
32
32
|
"contentBody": {
|
|
33
33
|
"authenticationType": "AUTHENTICATED_WITH_PUBLIC_ACCESS_ENABLED",
|
|
34
34
|
"appContainer": true,
|
|
35
|
-
"appSpace": "
|
|
35
|
+
"appSpace": ""
|
|
36
36
|
}
|
|
37
37
|
}
|
|
38
38
|
```
|
|
39
|
+
|
|
40
|
+
**Note:** Leave `appSpace` empty (`""`) if the UIBundle does not exist. If the UIBundle metadata record is already deployed, populate it with `"{appNamespace}__{appDevName}"`.
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Updating Experience Site URLs
|
|
2
|
+
|
|
3
|
+
Experience sites have a three-component architecture with two distinct URL patterns. Understanding this structure is critical when updating site URLs.
|
|
4
|
+
|
|
5
|
+
## Architecture Overview
|
|
6
|
+
|
|
7
|
+
Every Salesforce Experience Site consists of three components:
|
|
8
|
+
|
|
9
|
+
1. **Network** (metadata: `Network`) - Network configuration
|
|
10
|
+
2. **ChatterNetwork Site** (metadata: `CustomSite`) - Legacy site and proxy core site services
|
|
11
|
+
3. **ChatterNetworkPicasso Site** (metadata: `DigitalExperienceConfig` + `DigitalExperienceBundle`) - Customer-facing pages and content
|
|
12
|
+
|
|
13
|
+
## URL Pattern
|
|
14
|
+
|
|
15
|
+
These three components use **two different URLs**:
|
|
16
|
+
|
|
17
|
+
- **Primary URL** (ChatterNetworkPicasso): Used for customer-facing pages
|
|
18
|
+
- Defined in: `DigitalExperienceConfig` → `<urlPathPrefix>`
|
|
19
|
+
- Example: `mysite`
|
|
20
|
+
|
|
21
|
+
- **Secondary URL** (Network + CustomSite): Used for legacy authentication endpoints and other services
|
|
22
|
+
- Defined in: `Network` → `<urlPathPrefix>` AND `CustomSite` → `<urlPathPrefix>`
|
|
23
|
+
- Example: `mysitevforcesite`
|
|
24
|
+
- **Must be synchronized** - both files must have identical values
|
|
25
|
+
|
|
26
|
+
By default, Salesforce differentiates these URLs by appending `vforcesite` suffix to the Network/CustomSite URL.
|
|
27
|
+
|
|
28
|
+
## URL Update Workflow
|
|
29
|
+
|
|
30
|
+
When updating site URLs, follow this workflow:
|
|
31
|
+
|
|
32
|
+
### Step 1: Discover All URL References
|
|
33
|
+
|
|
34
|
+
Search for all occurrences of `urlPathPrefix` across the project metadata files.
|
|
35
|
+
|
|
36
|
+
**For agents**: Use the `search_files` tool with these parameters:
|
|
37
|
+
- path: `force-app/main/default`
|
|
38
|
+
- regex: `urlPathPrefix`
|
|
39
|
+
- file_pattern: `*.xml`
|
|
40
|
+
|
|
41
|
+
**For humans**: Use your IDE's search functionality or command line tools:
|
|
42
|
+
```bash
|
|
43
|
+
# Using grep
|
|
44
|
+
grep -r "urlPathPrefix" force-app/main/default --include="*.xml"
|
|
45
|
+
|
|
46
|
+
# Using VS Code: Ctrl+Shift+F (Windows/Linux) or Cmd+Shift+F (Mac)
|
|
47
|
+
# Search for: urlPathPrefix
|
|
48
|
+
# Files to include: *.xml
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Step 2: Identify URL Groups
|
|
52
|
+
|
|
53
|
+
Determine which files belong to which URL group:
|
|
54
|
+
|
|
55
|
+
- **Primary URL Group**: `DigitalExperienceConfig`
|
|
56
|
+
- **Secondary URL Group**: `Network` AND `CustomSite`
|
|
57
|
+
|
|
58
|
+
### Step 3: Update URLs Consistently
|
|
59
|
+
|
|
60
|
+
Update the `<urlPathPrefix>` value in each file:
|
|
61
|
+
|
|
62
|
+
- **DigitalExperienceConfig**: Update to new primary URL
|
|
63
|
+
- **Network**: Update to new secondary URL (typically primary URL + `vforcesite`)
|
|
64
|
+
- **CustomSite**: Update to **same value as Network** (must be synchronized)
|
|
65
|
+
|
|
66
|
+
### Step 4: Validate Naming Convention
|
|
67
|
+
|
|
68
|
+
Ensure URL values follow best practices:
|
|
69
|
+
- Use lowercase letters only
|
|
70
|
+
- Avoid special characters except hyphens where appropriate
|
|
71
|
+
- Keep URLs concise and meaningful
|
|
72
|
+
|
|
73
|
+
### Step 5: Verify Consistency
|
|
74
|
+
|
|
75
|
+
Before deploying, confirm:
|
|
76
|
+
- [ ] Primary URL in `DigitalExperienceConfig` is set correctly
|
|
77
|
+
- [ ] Secondary URL in `Network` matches `CustomSite` exactly
|
|
78
|
+
- [ ] URLs are properly differentiated (typically via suffix)
|
|
79
|
+
- [ ] All URL values follow naming conventions
|
|
80
|
+
|
|
81
|
+
## Example URL Configuration
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
ChatterNetworkPicasso Site (Primary):
|
|
85
|
+
DigitalExperienceConfig: <urlPathPrefix>bestsupport</urlPathPrefix>
|
|
86
|
+
|
|
87
|
+
Network + ChatterNetwork Site (Secondary):
|
|
88
|
+
Network: <urlPathPrefix>bestsupportvforcesite</urlPathPrefix>
|
|
89
|
+
CustomSite: <urlPathPrefix>bestsupportvforcesite</urlPathPrefix>
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Common Pitfalls to Avoid
|
|
93
|
+
|
|
94
|
+
❌ **Don't** update only one or two files - all three must be updated
|
|
95
|
+
❌ **Don't** use different values in Network and CustomSite
|
|
96
|
+
❌ **Don't** use the same URL for both Primary and Secondary groups
|
|
97
|
+
❌ **Don't** skip the discovery step with `search_files`
|
|
98
|
+
✅ **Do** use `search_files` to find all occurrences first
|
|
99
|
+
✅ **Do** maintain URL differentiation between the two groups
|
|
100
|
+
✅ **Do** follow lowercase naming conventions
|