Skip to content

Commit 6644cf5

Browse files
Update Airdrop documentation regarding IDM installation (#228)
* Update Airdrop documentation regarding IDM installation * Note fixes
1 parent d4f6edb commit 6644cf5

File tree

5 files changed

+24
-6
lines changed

5 files changed

+24
-6
lines changed

fern/docs/pages/airdrop/extraction-phases.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,21 @@ const run = async (events: AirdropEvent[]) => {
6969
event,
7070
initialState,
7171
workerPath: file,
72+
initialDomainMapping: {
73+
/* your initial domain mapping JSON here */
74+
},
7275
// options: {},
7376
});
7477
}
7578
};
7679

7780
export default run;
7881
```
82+
83+
<Note>
84+
You must pass the <code>initialDomainMapping</code> parameter to{" "}
85+
<code>spawn</code> when running extraction phases. This ensures the correct
86+
domain mapping is installed and used by the snap-in.
87+
</Note>
88+
89+
```

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ This mapping is configured once and then becomes available to all users of your
44
allowing them to import data while maintaining semantic meaning from their source systems.
55

66
The initial domain mapping is installed with your snap-in.
7-
The extractor automatically triggers a function to upload these mappings to the Airdrop system.
7+
On each snap-in version update, function to upload these mappings to the Airdrop
8+
system is triggered.
89

910
## Chef-cli initial domain mapping setup
1011

fern/docs/pages/airdrop/loading-phases.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ const run = async (events: AirdropEvent[]) => {
3636
event,
3737
initialState: initialLoaderState,
3838
workerPath: file,
39+
initialDomainMapping: {
40+
/* your initial domain mapping JSON here */
41+
},
3942
// options: {},
4043
});
4144
}
@@ -44,6 +47,12 @@ const run = async (events: AirdropEvent[]) => {
4447
export default run;
4548
```
4649

50+
<Note>
51+
You must pass the <code>initialDomainMapping</code> parameter to{" "}
52+
<code>spawn</code> when running loading phases. This ensures the correct
53+
domain mapping is installed and used by the snap-in.
54+
</Note>
55+
4756
## State handling
4857

4958
Loading phases run as separate runtime instances, similar to extraction phases, with a maximum execution time of 13 minutes.
@@ -54,4 +63,4 @@ Access to the `state` is available through the SDK's `adapter` object.
5463

5564
## Creating items in DevRev
5665

57-
To create an item in DevRev and sync it with the external system, start by creating an item with a **subtype** that was established during the initial sync. After selecting the subtype, fill out the necessary details for the item.
66+
To create an item in DevRev and sync it with the external system, start by creating an item with a **subtype** that was established during the initial sync. After selecting the subtype, fill out the necessary details for the item.

fern/docs/pages/airdrop/manifest.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ functions:
1919
description: Extraction function for the template snap-in
2020
- name: loading
2121
description: Loading function for the template snap-in
22-
- name: install_initial_domain_mapping
23-
description: Create blueprint and install initial domain mapping
2422
```
2523

2624
If loading is not implemented, remove it from the list. This action also removes the option from the DevRev app.

fern/docs/pages/airdrop/snap-in-template.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Starting with the template is recommended, as it includes all the necessary boil
44

55
The template makes use of **[DevRev's SDK library](https://www.npmjs.com/package/@devrev/ts-adaas)**,
66
which provides abstraction over the DevRev’s Airdrop control protocol.
7-
The SDK simplifies the workflow for data extraction and loading, handling events,
7+
The SDK simplifies the workflow for data extraction and loading, handling events,
88
state management, and artifacts (batches of extracted items).
99

1010
It provides features such as:
@@ -35,7 +35,6 @@ If you check the template, you can see that a snap-in is a Node.js project with
3535
- external-sync-units-extraction.ts
3636
- metadata-extraction.ts
3737
- index.ts
38-
- install_initial_domain_mapping/
3938
- loading/
4039
- workers/
4140
- load-attachments.ts

0 commit comments

Comments
 (0)