Skip to content
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

Documentation for Salesforce DLS #2056

Merged
merged 6 commits into from
Feb 8, 2024
Merged

Conversation

moxarth-rathod
Copy link
Contributor

Part of #1859

Checklists

Pre-Review Checklist

  • this PR has a meaningful title
  • this PR links to all relevant github issues that it fixes or partially addresses
  • if there is no GH issue, please create it. Each PR should have a link to an issue
  • this PR has a thorough description

Document level security (DLS) enables you to restrict access to documents based on a user'­s permissions. This feature is available by default for the Salesforce connector.
Salesforce connector DLS supports for both standard & custom objects.

Refer to [document level security](https://www.elastic.co/guide/en/enterprise-search/master/dls.html) for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this link to /current/ ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took the reference from already merged connector DLS documentation. Do we need to update this link?

Copy link
Contributor

Choose a reason for hiding this comment

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

We're on main here so master in the main docs makes sense

2. Choose `Read Only` or `Standard User` for the Existing Profile dropdown, give a name to the profile and save it. By default, `Read Only` or `Standard User` have the read permission to access all standard objects. There can be some more profiles which do have a read access to standard objects but these are some of them.
3. Now, edit the newly created profile and under `Object Permissions`, assign at least a `Read` access to the standard objects and custom objects you want to ingest into ElasticSearch.

**Note:** If users specify advanced sync rules then they need to assign a `Read` access for that specific object in the profile.
Copy link
Contributor

Choose a reason for hiding this comment

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

need to assign a Read access for that specific object

Is this true for both standard and custom objects?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, this is applicable to both standard and custom objects


Refer this tutorial to get more idea on setting the permissions - [link](https://howtovideos.hubs.vidyard.com/watch/B1bQnMFg2VyZq7V6zXQjPg#:~:text=This%20is%20a%20must%20watch,records%20in%20your%20Salesforce%20organization.)

### Set Permissions using Profiles
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this + the sections below revolving around permissions can be simplified to just explaining what permissions are required for the user.

From what I can see, the only required permissions would be "Read" permissions for the standard/custom objects that the user wants to ingest. Is that correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the Read permission is sufficient for the users to ingest the objects.

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Looking good, just some copyediting from me. If @navarone-feekery and @danajuratoni are happy we can merge this

Document level security (DLS) enables you to restrict access to documents based on a user'­s permissions. This feature is available by default for the Salesforce connector.
Salesforce connector DLS supports for both standard & custom objects.

Refer to [document level security](https://www.elastic.co/guide/en/enterprise-search/master/dls.html) for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

We're on main here so master in the main docs makes sense

@navarone-feekery
Copy link
Contributor

LGTM also, once @leemthompo's change requests are implemented 👍🏻

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

LGTM

@leemthompo leemthompo merged commit d6e0cd4 into main Feb 8, 2024
2 checks passed
@leemthompo leemthompo deleted the salesforce-dls-documentation branch February 8, 2024 09:50
Copy link

github-actions bot commented Feb 8, 2024

💔 Failed to create backport PR(s)

The backport operation could not be completed due to the following error:
There are no branches to backport to. Aborting.

The backport PRs will be merged automatically after passing CI.

To backport manually run:
backport --pr 2056 --autoMerge --autoMergeMethod squash

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants