Skip to content

Updates to ADaaS Documentation #128

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.

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
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions fern/docs/pages/adaas/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Before you begin

- If you have not created a development organization on DevRev before, create a dedicated
[DevOrg for development purposes](https://app.devrev.ai/) where you will be publishing your ADaaS snap-in.
[DevRev organization for development purposes](https://app.devrev.ai/) where you will be publishing your ADaaS snap-in.
- Install required tools and packages:
- [devrev-cli](https://developer.devrev.ai/snapin-development/references/cli-install) (version 4.7 or higher)
- [jq](https://stedolan.github.io/jq)
Expand All @@ -12,9 +12,9 @@

1. Create a new repo from the [ADaaS template repo](https://github.com/devrev/adaas-template). Select _Use this template_ and
then _Create a new repository_.
1. Copy `Makefile.variable.example` to `Makefile.variable` and fill in the required variables.
1. Copy `.env.example` to `.env` and fill in the required variables.
1. Configure a keyring for the external system in the `manifest.yaml`.
Refer to [Keyrings](/snapin-development/references/keyrings) for instructions.
Refer to [Keyrings](/snapin-development/references/manifest#developer-keyrings) for instructions.
1. Deploy a draft version of your snap-in to your dev org using `make deploy`.
1. Install the snap-in in your DevRev at **Settings** > **Snap-ins** > **Install snap-in**.
1. Define the connection at **Settings** > **Imports** > **Connections**.
Expand Down
9 changes: 4 additions & 5 deletions fern/docs/pages/adaas/metadata-extraction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ mandatory fields or custom fields).
Categories also provide a way how custom record types can be mapped.

If the external system allows records to change the record type within the category, while still preserving identity,
this can be defined by the `are_transitions_possible` field in the `record_type_categories` section. For example, if
this can be defined by the `are_record_type_conversions_possible` field in the `record_type_categories` section. For example, if
an issue that can be moved to become a problem in the external system.

```json
Expand All @@ -121,7 +121,7 @@ mandatory fields or custom fields).
},
"record_type_categories":{
"issue":{
"are_transitions_possible":true
"are_record_type_conversions_possible":true
}
}
}
Expand Down Expand Up @@ -197,8 +197,7 @@ mandatory fields or custom fields).
"key": "P-1"
},
{
"key": "P-2",
"is_deprecated": true
"key": "P-2"
}
]
}
Expand Down Expand Up @@ -239,7 +238,7 @@ mandatory fields or custom fields).

### Handle special references

- Some references have role of parent or child. This means that the child record doesn't make sense without its parent, for example a comment attached to a ticket. Assigning a `role` helps Airdrop correctly handle such fields in case the end-user decides to filter some of the parent records out.
- Some references have role of parent or child. This means that the child record doesn't make sense without its parent, for example a comment attached to a ticket. Assigning a `reference_type` helps Airdrop correctly handle such fields in case the end-user decides to filter some of the parent records out.

- Sometimes the external system uses references besides the primary key of records, for example when referring to a case by serial number, or to a user by their email. To correctly resolve such references, they must be marked with 'by_field', which must be a field existing in that record type, marked 'is_identifier'. For example:
```json
Expand Down
Loading