Skip to content

Commit b6825a3

Browse files
committed
Introduce Chef UI, better explain fallbacks
1 parent b7508d5 commit b6825a3

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

fern/docs/pages/airdrop/initial-domain-mapping.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ system is triggered.
1111

1212
You can create initial domain mappings using two methods:
1313

14-
1. **Chef-cli UI**: Interactive web interface for comprehensive mapping creation
14+
1. **Chef UI**: Interactive web interface for comprehensive mapping creation
1515
2. **Model Context Protocol (MCP)**: AI-assisted mapping creation for developers (experimental)
1616

17-
Choose the chef-cli UI for manual control or use MCP for rapid prototyping with AI assistance.
17+
Choose the Chef UI for manual control or use MCP for rapid prototyping with AI assistance.
1818
MCP is an experimental feature and works locally without requiring a sync to be created.
1919

2020
<Info>
2121
For AI-assisted mapping creation, see the [Model Context Protocol integration guide](./mcp.mdx).
2222
</Info>
2323

24-
## Chef-cli initial domain mapping setup
24+
## Chef UI setup
2525

2626
### Prerequisites
2727

@@ -70,7 +70,7 @@ Or you can use the interactive helper of the CLI:
7070
eval $(chef-cli ctx init); chef-cli ctx show > ctx.json
7171
```
7272

73-
### Use the local UI to create a recipe blueprint for your initial import
73+
### Use the Chef UI
7474

7575
```bash
7676
chef-cli configure-mappings --env prod
@@ -88,21 +88,21 @@ ACTIVE_PARTITION=dvrv-in-1 chef-cli configure-mappings --env prod
8888

8989
The options are: `dvrv-us-1`, `dvrv-eu-1`, `dvrv-in-1`, and `dvrv-de-1`.
9090

91-
The first function of the local UI is to assemble a *blueprint* for a concrete import running in the test-org, allowing the mapping to be tested out and evaluated.
92-
After it is used for the import, the mappings become immutable, but the chef-cli UI offers a button to make a draft clone, which can be edited again for refinements.
91+
The first function of the Chef UI is to assemble a *blueprint* for a concrete import running in the test-org, allowing the mapping to be tested out and evaluated.
92+
After it is used for the import, the mappings become immutable, but the Chef UI offers a button to make a draft clone, which can be edited again for refinements.
9393

9494
### Continue to initial domain mapping
9595

96-
When you are done, you should have the chef-cli context set up and have the chef-cli local UI running in your browser.
97-
You can now use the chef-cli web UI to create initial domain mappings.
96+
When you are done, you should have the chef-cli context set up and have the Chef UI running in your browser.
97+
You can now use the Chef UI to create initial domain mappings.
9898

9999
</Steps>
100100

101-
## Use the local UI to create initial domain mappings
101+
## Use the Chef UI to create initial domain mappings
102102

103-
The chef-cli UI generates an `initial_domain_mapping.json` file that must be embedded in your extractor. This defines the options that the end-user sees when they are mapping the data.
103+
The Chef UI generates an `initial_domain_mapping.json` file that must be embedded in your extractor. This defines the options that the end-user sees when they are mapping the data.
104104

105-
Initial domain mappings differ from user mappings in two key ways:
105+
Initial domain mappings provide two key configuration capabilities:
106106

107107
1. **Multiple mapping options**: The developer can choose how external record types map to DevRev records (for example, external *task* can map to either *issue* or *ticket*).
108108
2. **Category-based defaults**: Mappings can apply to entire record type categories, automatically handling new record types.
@@ -111,26 +111,26 @@ Initial domain mappings differ from user mappings in two key ways:
111111

112112
### Map record types and fields
113113

114-
Use the chef-cli UI to map record types and fields.
115-
The UI shows you the record types that are available in the org and allows you to map them to the external record types.
116-
You should map one record type at a time.
114+
Use the Chef UI to map record types and fields.
115+
The UI displays the external record types you defined in external domain metadata and allows you to map them to DevRev objects.
116+
Map one record type at a time, ensuring you map all required fields and as many optional fields as possible.
117117

118118
### Specify fallback mappings
119119

120-
For most required DevRev fields a fallback is required. This is used on object creation if the extractor doesn't provide a value.
120+
For some required DevRev fields a fallback is required.
121121

122-
The fallback should be a DevRev value that is valid for the field.
123-
For enum fields, the fallback should be the enum **value** as specified in [Supported object types](./supported-object-types.mdx).
122+
The fallback you choose will be used on item creation if the extractor doesn't provide a value for the required DevRev field.
123+
This is useful for fields that are required by DevRev but optional in the external system.
124124

125125
### Install the blueprint
126126

127-
Click **Install in this org** to access the initial domain mapping creation screen.
127+
Apply the mappings and **install them in your org** to access the initial domain mapping creation screen.
128128
Follow the instructions to create your initial domain mapping.
129129

130130
### Merge configurations
131131

132132
You can repeat the process for different record types and fields to create multiple mappings.
133-
In the install screen, you can merge your mappings with existing initial mappings.
133+
In the install screen, you can merge new mappings with existing initial domain mappings.
134134

135135
### Export the mapping file
136136

0 commit comments

Comments
 (0)