Skip to content

Commit 2853ea7

Browse files
ADaaS revision (#113)
* light reorganization * headings * Mermaid diagrams * headings structure * heading punctuation * obsolete * Update overview.mdx * no colors --------- Co-authored-by: Atul-Butola <[email protected]>
1 parent cf3d3fa commit 2853ea7

File tree

8 files changed

+306
-298
lines changed

8 files changed

+306
-298
lines changed

fern/docs/img/adaas/adaas-architecture.mmd

Lines changed: 0 additions & 21 deletions
This file was deleted.

fern/docs/img/adaas/adaas-architecture.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

fern/docs/img/adaas/adaas-extraction-phases.mmd

Lines changed: 0 additions & 53 deletions
This file was deleted.

fern/docs/img/adaas/adaas-extraction-phases.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

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

Lines changed: 58 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,75 @@ the external system, that would be another sync run.
55
Each sync run is comprised out of phases. Phases follow sequentially, and each can consist of one or more invocations
66
of the snap-in.
77

8-
![ADaaS extraction phases](../../img/adaas/adaas-extraction-phases.svg)
8+
```mermaid
9+
sequenceDiagram
10+
%%{init: { "fontFamily": "Segoe UI" } }%%
11+
actor user as User
12+
participant gw as REST API Gateway
13+
participant ad as Airdrop components
14+
participant ee as External extractor
15+
16+
note over gw,ad: Extract External Sync Units
17+
user ->> gw: Select import connection
18+
gw ->> ad: Start External Sync Unit extraction
19+
ad ->> ee: Start External Sync Unit extraction
20+
ee -->> gw: List of External Sync Units
21+
gw ->> ad: List of External Sync Units
22+
ad ->> gw: List of External Sync Units
23+
gw -->> user: Show available External Sync Units
24+
25+
26+
note over gw,ad: Extract Metadata
27+
ad ->> ee: Start Metadata extraction
28+
ee -->> gw: List of extracted metadata artifacts
29+
gw ->> ad: List of extracted metadata artifacts
30+
31+
note over gw,ad: Extract data
32+
ad ->> ee: Start data extraction
33+
ee -->> gw: List of extracted data artifacts
34+
gw ->> ad: List of extracted data artifacts
35+
36+
note over ad: Transform and import data into DevRev
37+
38+
note over gw,ad: Extract attachments
39+
ad ->> ee: Start attachment extraction
40+
ee -->> gw: List of extracted attachments
41+
gw ->> ad: List of extracted attachments
42+
43+
ad -->> gw: Finished import
44+
gw -->> user: Show finished import and report
45+
46+
note over gw,ad: Delete data
47+
user ->> gw: Delete import
48+
gw ->> ad: Delete import
49+
ad ->> ee: Delete data
50+
ee -->> gw: Finished deleting data
51+
gw ->> ad: Finished deleting data
52+
53+
note over gw,ad: Delete attachments
54+
ad ->> ee: Delete attachments
55+
ee -->> gw: Finished deleting attachments
56+
gw ->> ad: Finished deleting attachments
57+
note over ad: Deletes internal data
58+
ad -->> gw: Finished deleting import
59+
gw -->> user: Import deleted
60+
```
961

1062
## Sync modes
1163

1264
### Initial import
1365

1466
An _initial import_ is the first import of data from the external system to DevRev.
15-
It is triggered manually by the end user in DevRev's Imports UI.
67+
It is triggered manually by the end user in DevRev's **Imports** UI.
1668

1769
An _initial import_ consists of the following phases:
1870
1. External sync units extraction
1971
2. Metadata extraction
2072
3. Data extraction
2173
4. Attachments extraction
2274

23-
## 1-way sync
75+
76+
### 1-way sync
2477

2578
A _1-way sync_ refers to any extraction after the initial import has been successfully completed.
2679
An extractor extracts data that was created and/or updated in the external system
@@ -35,10 +88,10 @@ A 1-way sync consists of the following phases:
3588
2. Data extraction
3689
3. Attachments extraction
3790

38-
A 1-way sync extracts only the domain objects updated and/or created since the previous successful sync run.
91+
A 1-way sync extracts only the domain objects updated or created since the previous successful sync run.
3992

4093

41-
## Deletion mode
94+
### Deletion mode
4295

4396
A _deletion_ consists of the following phases:
4497
1. Data deletion

0 commit comments

Comments
 (0)