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

Changes to Org Browser Behavior #3941

Merged
merged 7 commits into from
Mar 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
12 changes: 7 additions & 5 deletions docs/_articles/en/user-guide/org-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Org Browser displays the available metadata types and their corresponding co

## Opening the Org Browser
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved

![Org Browser Overview](./images/org_browser_overview.png)
![Org Browser Overview](../../../images/org_browser_overview.png)

1. Open Org Browser
2. Refresh available metadata types in the org
Expand All @@ -19,7 +19,7 @@ The Org Browser displays the available metadata types and their corresponding co
8. Retrieve source for all components of metadata type
9. Retrieve source for metadata component and open it in VS Code

To open the Org Browser, click the cloud icon in the side bar of the VS Code window **(1)**. If you don't see the icon, make sure your [default org](./en/user-guide/default-org/) is set to a non-scratch org.
To open the Org Browser, click the cloud icon in the sidebar of the VS Code window **(1)**. If you don't see the icon, make sure your [default org](./en/user-guide/default-org/) is set to a non-scratch org.
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved

When you open the Org Browser, all the metadata for the default org is saved in your local project under the .sfdx directory to minimize the number of calls to the org.
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -38,20 +38,22 @@ You can refresh metadata at org level, for a type, for folders in a type, and fo
- folder metadata type to update the folders in the type, but not the components in the folder
- folder in a metadata type to refresh the components in it

![Metadata type with folders](./images/org_browser_folders.png)
![Metadata type with folders](../../../images/org_browser_folder_ret.png)

sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved
## Retrieving Metadata

You can retrieve a single metadata component or all components of the same type. Click retrieve icon next to:

- component name **(7)** to retrieve a component to your local project
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved
- metadata type **(8)** to retrive all components of the type
- metadata type **(8)** to retrieve all components of the type

You can retrieve all folders of folder metadata types such as Reports, Dashboards, Documents, and EmailTemplates, by clicking on the retrieve icon next to the metadata type. When you retrieve a folder, only information about the folder is retrieved and added to a <folder>-meta.xml file. To retrieve components within folders, view the components in a folder by expanding it and then retrieve the individual component by clicking the retrieve icon.
Copy link
Contributor

Choose a reason for hiding this comment

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

Something to think about moving forward - and I didn't catch this here but did above for .sfdx. File names are supposed to be in , so I'm thinking it should be <folder.-meta.xml

Copy link
Contributor

Choose a reason for hiding this comment

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

"filepath" - when I put something in chevrons, it gets deleted in comments here. Ha.


Currently, the source is retrieved into your default package directory as defined in the [sfdx-project.json](./en/getting-started/first-project#the-sfdx-projectjson-file) file.
Copy link
Contributor

Choose a reason for hiding this comment

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

so, sfdx-project.json should be in courier - so would you put the back ticks within the braces? [sfdx-project.json] ??


You can also retrieve multiple components from the default org by clicking the retrieve button next to the metadata type. If retrieving a component overwrites it, you'll be prompted to select how to proceed.
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved

![Overwrite components](./images/overwrite-prompt.png)
![Overwrite components](../../../images/overwrite-prompt.png)

When you retrieve components for a metadata type, the Org Browser automatically refreshes the component list for the selected type and then retrieves them. This ensures that the extensions accurately check the local workspace for existing components.
sbudhirajadoc marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Binary file added docs/images/org_browser_folder_ret.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.