Skip to content

Update Airdrop documentation regarding IDM installation #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 16, 2025
Merged

Update Airdrop documentation regarding IDM installation #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed45b93
Update Airdrop documentation regarding IDM installation
radovanjorgic May 15, 2025
3fa1bdb
Note fixes
radovanjorgic May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions fern/docs/pages/airdrop/extraction-phases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,21 @@ const run = async (events: AirdropEvent[]) => {
event,
initialState,
workerPath: file,
initialDomainMapping: {
/* your initial domain mapping JSON here */
},
// options: {},
});
}
};

export default run;
```

<Note>
You must pass the <code>initialDomainMapping</code> parameter to{" "}
<code>spawn</code> when running extraction phases. This ensures the correct
domain mapping is installed and used by the snap-in.
</Note>

```
3 changes: 2 additions & 1 deletion fern/docs/pages/airdrop/initial-domain-mapping.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ This mapping is configured once and then becomes available to all users of your
allowing them to import data while maintaining semantic meaning from their source systems.

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

## Chef-cli initial domain mapping setup

Expand Down
11 changes: 10 additions & 1 deletion fern/docs/pages/airdrop/loading-phases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ const run = async (events: AirdropEvent[]) => {
event,
initialState: initialLoaderState,
workerPath: file,
initialDomainMapping: {
/* your initial domain mapping JSON here */
},
// options: {},
});
}
Expand All @@ -44,6 +47,12 @@ const run = async (events: AirdropEvent[]) => {
export default run;
```

<Note>
You must pass the <code>initialDomainMapping</code> parameter to{" "}
<code>spawn</code> when running loading phases. This ensures the correct
domain mapping is installed and used by the snap-in.
</Note>

## State handling

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

## Creating items in DevRev

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.
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.
2 changes: 0 additions & 2 deletions fern/docs/pages/airdrop/manifest.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ functions:
description: Extraction function for the template snap-in
- name: loading
description: Loading function for the template snap-in
- name: install_initial_domain_mapping
description: Create blueprint and install initial domain mapping
```

If loading is not implemented, remove it from the list. This action also removes the option from the DevRev app.
Expand Down
3 changes: 1 addition & 2 deletions fern/docs/pages/airdrop/snap-in-template.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Starting with the template is recommended, as it includes all the necessary boil

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

It provides features such as:
Expand Down Expand Up @@ -35,7 +35,6 @@ If you check the template, you can see that a snap-in is a Node.js project with
- external-sync-units-extraction.ts
- metadata-extraction.ts
- index.ts
- install_initial_domain_mapping/
- loading/
- workers/
- load-attachments.ts
Expand Down
Loading