Skip to content

DOCS-1751 - Document _orgName field in MSSP child-org search #6915

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

Open
JV0812 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOCS-1751 - Document _orgName field in MSSP child-org search #6915

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion docs/search/search-across-child-orgs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ Follow the steps below to perform a child org-level search:
1. Click the <img src={useBaseUrl('img/search/get-started-search/search-page/child-org-select-button.png')} alt="Child org select button" style={{border: '1px solid gray'}} width="30"/> button to select the child org where you want to query. You can either select one child org or multiple child orgs.<br/><img src={useBaseUrl('img/search/get-started-search/search-page/child-org-dropdown.png')} alt="Child org dropdown" style={{border: '1px solid gray'}} width="800"/>
1. Enter the required query and click the search button to obtain the search results.
:::note
Make sure you use an aggregator and `_orgID` for multi-child org queries. For example, `* | count by _orgId` or `* | count by _orgId | sum (_count)`.
Make sure you use an aggregator and `_orgId` for multi-child org queries. For example, `* | count by _orgId` or `* | count by _orgId | sum (_count)`.
:::

:::info
Search results also include the `_orgName` field, which shows the organization name for each child org alongside its `_orgId`. When you manage many child orgs, `_orgName` helps you identify an org by name without remembering its `_orgId`. The `_orgId` field is still required for multi-child org queries. The `_orgName` field is an additional field to make results easier to read, and you can reference it in your queries. For example, `* | count by _orgId, _orgName`.
:::

There can be two possible errors while running the multi-child org queries:
Expand Down