Skip to content

docs: ISS-179977, Add documentation for mapping custom objects and custom links #254

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 23 commits into from
Jun 12, 2025

Conversation

ftopic
Copy link
Contributor

@ftopic ftopic commented Jun 9, 2025

Add documentation about mapping custom objects and custom links in AD snap-in development.

Based on and should be merged after #241
https://app.devrev.ai/devrev/works/ISS-179977

@ftopic ftopic requested review from tilenkavcic and B-Lorentz June 9, 2025 06:27
@tilenkavcic
Copy link
Contributor

tilenkavcic commented Jun 9, 2025

Thanks and sorry for the conflicts, I can address them once my part gets merged (which I will once we release the new CLI version)

shalomgk and others added 15 commits June 11, 2025 11:00
* Update user-identity.mdx

* Update user-identity.mdx

Add beta message with limitations
* adding a note

* Update ue-migration.mdx

---------

Co-authored-by: Atul-Butola <[email protected]>
- Use imperative tense in headings.
  This has been done in the custom objects documentation.

- Use smaller image for group_name UI hint.
* some minor updates and organization

* MP style and sample

* corrected LLM token var name

* prohibited

* check responses better

---------

Co-authored-by: Atul-Butola <[email protected]>
* add instructions for local instance

* use yarn

---------

Co-authored-by: Atul-Butola <[email protected]>
* Update supported objects for Airdrop

* Update supported-object-types.mdx

* Update supported-object-types.mdx

* Update supported-object-types.mdx
ISS-180063

Co-authored-by: Atul-Butola <[email protected]>
* Cross-domain session tracking link

* Update fern/docs/pages/sdks/web/methods.mdx

---------

Co-authored-by: Atul-Butola <[email protected]>
* Update IDM docs

* Update supported object types

* Add fallback description

* Address comments

* Don't capitalize titles in supported object types

* Add hint for integrating DevRev documentation into MCP server

* Introduce Chef UI, better explain fallbacks

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

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Nits

* Address comments

* frontend user-identity method (#232)

* Update user-identity.mdx

* Update user-identity.mdx

Add beta message with limitations

* changed the position of note (#243)

* adding a note

* Update ue-migration.mdx

---------

Co-authored-by: Atul-Butola <[email protected]>

* chore: Update OpenAPI specs (#245)

* Point to customization API docs from identity SDK docs (#246)

* chore: Include 'Bearer' in authorization header documentation (#247)

* Document `unit` and `is_read_only` customization UI hints (#248)

- Use imperative tense in headings.
  This has been done in the custom objects documentation.

- Use smaller image for group_name UI hint.

* style rules for marketplace (#214)

* some minor updates and organization

* MP style and sample

* corrected LLM token var name

* prohibited

* check responses better

---------

Co-authored-by: Atul-Butola <[email protected]>

* add instructions for local instance (#171)

* add instructions for local instance

* use yarn

---------

Co-authored-by: Atul-Butola <[email protected]>

* Update supported objects for Airdrop (#250)

* Update supported objects for Airdrop

* Update supported-object-types.mdx

* Update supported-object-types.mdx

* Update supported-object-types.mdx

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: shalomgk <[email protected]>
Co-authored-by: Avinash Singh <[email protected]>
Co-authored-by: Atul-Butola <[email protected]>
Co-authored-by: Brian Byrne <[email protected]>
Co-authored-by: Shivansh Rai <[email protected]>
Co-authored-by: Ben Colborn <[email protected]>
Co-authored-by: Arturo Aparicio <[email protected]>
Copy link
Contributor

github-actions bot commented Jun 11, 2025

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

@ftopic ftopic marked this pull request as ready for review June 11, 2025 10:54
@ftopic ftopic requested a review from a team as a code owner June 11, 2025 10:54
Copy link
Contributor

@bc-devrev bc-devrev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with one markup suggestion.

Copy link
Contributor

The system allows importing record types and categories as custom objects. To achieve this you have to select `new_custom_object` when mapping the record type. For each external record type mapped as a custom object, a new custom **Leaf type** will be defined in DevRev and a **Subtype** will automatically be created. For more details on customization concepts, please refer to the
[Customization](../customization.mdx) and [Custom Objects](../custom-objects.mdx) documentation.

The field mapping works the same as for the stock DevRev types, with the difference being that there are significantly fewer fields to map. All the unmapped fields of the external record type will be created as custom fields.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change
The field mapping works the same as for the stock DevRev types, with the difference being that there are significantly fewer fields to map. All the unmapped fields of the external record type will be created as custom fields.
All the unmapped fields of the external record type are created as custom fields.

@ftopic ftopic merged commit 96c5332 into main Jun 12, 2025
6 checks passed
@ftopic ftopic deleted the farist/custom_objects branch June 12, 2025 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants