DOCSEARCHbyAlgolia
Submit Docs

Package Builder Documentation

website·Indexed 31 days ago

https://package-builder.chiefpansancolt.dev/

A tool for generating selected metadata types for XML or SFDX. Documentation covers installation, usage of the Package.xml and CLI command, and updates including Version 2.0 support for the sf cli command.

Tokens
1.2K
Snippets
1
Records
12
Agent score
52%

What's inside Package Builder

  1. Package Builder Features Overview

    Package Builder helps admins and developers find metadata APIs to retrieve and pull to local environments or version control. Key capabilities include:

    • Selecting Metadata Types and up to 3 folders for applicable types.
    • Filtering by Package Type (All, Managed, Unmanaged).
    • Generating package.xml output for selected metadata (with options to copy the full output or just the type grouping).
    • Generating sfdx or sf CLI command output to retrieve metadata locally.
    • Configurable API Versioning to support new Salesforce releases.

  2. Suggest an enhancement for Package Builder

    To suggest new features or improvements, first check the existing open enhancement issues list. Use the feature request form to submit your suggestion, ensuring you include detailed descriptions and the imagined steps/workflow for how the requested feature would function.

  3. Configure the CLI command output for Package Builder

    Package Builder allows you to choose between sfdx and sf CLI command outputs for all users of the tool. This is useful for teams transitioning to the newer sf CLI.

    Steps to update:

    1. Navigate to Setup > Custom Code > Custom Metadata Types.
    2. Click Manage Records for the System Property (PackBuild) type.
    3. Locate the record labeled "CLI Command" and click Edit.
    4. Update the Value field. The only acceptable values are sfdx or sf.

  4. Report a bug in Package Builder

    Before reporting a bug, check the existing open bug issues list to avoid duplicates. When submitting a report, use the official bug report template and provide as many details as possible to help maintainers reproduce the behavior. If you find a closed issue that matches your experience, open a new issue and include a link to the original closed issue in the body.

  5. Install Package Builder Version 2.0 in a Salesforce Org

    Package Builder is available as a managed package. To install it in your Salesforce environment, use the following installation URL and password.
    URL: /packaging/installPackage.apexp?p0=04t1U000007vQ5C
Password: QuXshu9Q8xbNeK4b

  6. Submit a Pull Request to Package Builder

    To have a contribution reviewed and accepted, follow these requirements:

    1. Use the provided Pull Request template.
    2. Ensure all status checks pass after submission.
    3. If a status check fails and you believe it is unrelated to your changes, leave a comment on the PR explaining why; a maintainer will then re-run the check.

    Note: Reviewers may request additional design work, tests, or changes before the PR is ultimately merged.

  7. Install Package Builder to a Salesforce Org

    To install Package Builder, append the installation URL of the desired version to your Salesforce org's base URL (e.g., https://orgname.my.salesforce.com). After navigating to the URL, enter the required password, select the target profiles (Administrators are recommended), and click install.

    Available Versions:

    • 2.0: Package Id 04t1U000007vQ5C, Password QuXshu9Q8xbNeK4b, URL /packaging/installPackage.apexp?p0=04t1U000007vQ5C
    • 1.1: Package Id 04t1U000006I6Zc, Password dVRu4KuQa2LKUuaN, URL /packaging/installPackage.apexp?p0=04t1U000006I6Zc
    • 1.0: Package Id 04t1U000006I6N9, Password 3BpmOLZnwPQO, URL /packaging/installPackage.apexp?p0=04t1U000006I6N9

  9. Generate Package.xml and CLI commands using Package Builder

    Package Builder allows users to generate a package.xml file or a CLI reference command for Salesforce metadata. To access the tool, search for 'Package Builder' in the Salesforce App Launcher (waffle menu).

    Depending on the metadata type, the selection process varies:

    1. Standard Metadata: Select the Metadata Type and the packaging group (All, Managed Only, or Unmanaged Only).
    2. Folder-based Metadata: For EmailTemplate, Report, Dashboard, or Document, you must also select 1-3 folders.

    After clicking 'Search', select a specific metadata value to reveal the 'Package XML' and 'CLI Reference Command' panels. You can copy the full package.xml file or just the specific types group to append to an existing local file.

  12. Configure the Salesforce API version for Package Builder

    You can specify the preferred Salesforce API version used by Package Builder via Custom Metadata Types. This allows the tool to stay current with Salesforce releases without requiring a package update.

    Steps to update:

    1. Navigate to Setup > Custom Code > Custom Metadata Types.
    2. Click Manage Records for the System Property (PackBuild) type.
    3. Locate the record labeled "API Version Used" and click Edit.
    4. Update the Value field to the desired API version (e.g., 56.0).