You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The options are: `dvrv-us-1`, `dvrv-eu-1`, `dvrv-in-1`, and `dvrv-de-1`.
90
90
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.
93
93
94
94
### Continue to initial domain mapping
95
95
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.
98
98
99
99
</Steps>
100
100
101
-
## Use the local UI to create initial domain mappings
101
+
## Use the Chef UI to create initial domain mappings
102
102
103
-
The final artifact of the recipe creation process is the `initial_domain_mapping.json`, which has to be embedded in the extractor.
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.
104
104
105
-
This mapping, unlike the recipe blueprint of a concrete import, can contain multiple options for each external record type from which the end-user might choose (for example, allow *task* from an external system to map either to *issue* or *ticket* in DevRev), and it can also contain mappings that apply to a record type category.
106
-
When the user runs a new import, and the extractor reports in its metadata record types belonging to this category that are not directly mapped in the initial domain mappings, the recipe manager applies the per-category default to them.
105
+
Initial domain mappings provide two key configuration capabilities:
107
106
108
-
After the blueprint of the test import is completed, the *Install in this org* button takes you to the initial domain mapping creation screen, where you can *merge* the blueprint to the existing initial mappings of the org.
107
+
-**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*).
108
+
-**Category-based defaults**: Mappings can apply to entire record type categories, automatically handling new record types.
109
109
110
-
By repeating this process (run a new import, create a different configuration, merge to the initial mappings), you can create an initial mapping that contains multiple options for the user to choose from.
110
+
<Steps>
111
+
112
+
### Map record types and fields
113
+
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.
117
+
118
+
### Specify fallback mappings
119
+
120
+
For some required DevRev fields a fallback is required.
121
+
122
+
The fallback you choose is 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.
124
+
125
+
### Install the blueprint
126
+
127
+
Apply the mappings and **install them in your org** to access the initial domain mapping creation screen.
128
+
Follow the instructions to create your initial domain mapping.
129
+
130
+
### Merge configurations
131
+
132
+
To create multiple mappings for different record types and fields, repeat this process:
133
+
Create a new import, map the record types and fields, then install the mappings in your org.
134
+
The install screen allows you to merge new mappings with existing initial domain mappings.
135
+
136
+
### Export the mapping file
137
+
138
+
When all fields are mapped correctly, click **Export** to download `initial_domain_mapping.json`.
139
+
140
+
</Steps>
141
+
142
+
### Advanced configuration
111
143
112
-
Finally, when all the fields are mapped without deficiencies and the blueprint is installed, the Export button allows you to retrieve the `initial_domain_mapping.json`.
144
+
You can provide a local metadata file for enhanced functionality:
113
145
114
-
<Tip>
115
-
You can also provide a local metadata file to the command using the `-m` flag, for example:
Copy file name to clipboardExpand all lines: fern/docs/pages/airdrop/mcp.mdx
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -42,6 +42,11 @@ Create a `.mcp.json` file with the following content:
42
42
3. Use the editor to guide the AI to create the initial domain mappings.
43
43
4. Use `initial-mapping check` to test the initial domain mappings against the local domain metadata file.
44
44
45
+
<Hint>
46
+
To assist you in creating the Airdrop snap-in you can add DevRev's documentation to your MCP server, just add `https://developer.devrev.ai/public/airdrop/` as a custom docs URL.
47
+
See [Cursor documentation](https://docs.cursor.com/context/@-symbols/@-docs#add-custom-docs) for more information.
48
+
</Hint>
49
+
45
50
### Claude Code setup
46
51
47
52
1. Provide `.mcp.json` in your project root.
@@ -58,7 +63,7 @@ You can use the same `.mcp.json` file in other IDEs that support MCP.
58
63
To guide the AI tool, provide the following instructions to your AI assistant:
59
64
60
65
```markdown
61
-
When asked to perform airdrop initial mapping:
66
+
When asked to perform Airdrop initial mapping:
62
67
63
68
- Refer to the `metadata.json` for the external domain metadata.
64
69
- Use `mappings.json` as your initial domain mapping file.
0 commit comments