Packages are bundles of SnapApp components (like objects, workflows, configurations, and templates) that facilitate seamless portability across different environments. They allow you to share reusable solutions across multiple applications or move features from a sandbox to a production instance quickly and efficiently.

Table of Contents

• Overview
• Creating a Package
• 1. Navigate to Settings
• 2. Access the Packages Menu
• 3. Initialize a New Package
• 4. Define Package Metadata
• 5. Add Components
• 6. Build and Finalize
• Configuration and Marketplace Listing
• Downloading and Installing
• Exporting a Package
• Installation via UI (Recommended)
• Installation via CLI
• Management Best Practices

Overview

Think of a Package like a containerized feature set. It includes all the underlying logic, data structures, and UI components needed to recreate a specific set of functionalities in another SnapApp environment without manual rebuilding.

Creating a Package

Follow these steps to bundle your components into a new package:

1. Navigate to Settings

Click on your User menu and select Settings. This is the hub for all system-level configurations.

2. Access the Packages Menu

Within Settings, open the Automation dropdown and select Packages. This page displays your library of existing packages.

3. Initialize a New Package

Click + Add New in the top-right header to create a new package record.

4. Define Package Metadata

Provide the essential identification details: - Name: A clear name for the feature set (e.g., “Customer Portal”). - Version: The current iteration (e.g., “1.0.0”). - Description: A short summary of what this package provides.

5. Add Components

Select the specific objects, workflows, or pages you want to include. SnapApp will identify related dependencies to ensure the package is functional upon installation. Click Save when finished.

6. Build and Finalize

After saving, SnapApp will build the package. The status will display Building until the process completes, at which point the status will change to Active and the package will be ready for export.

Configuration and Marketplace Listing

If you intend to share this package more broadly, you can configure additional “Marketplace” metadata:

Downloading and Installing

Once a package is created, it can be exported and imported into other instances.

Exporting a Package

To export, open the Detail View of an active package and click the Download button in the header. This will generate a .json file containing the package definition.

Installation via UI (Recommended)

1. Navigate to Settings > Automation > Packages.
2. Click Install Package from the top header.
3. Upload your .json file. SnapApp will validate the contents and deploy the components automatically.

Installation via CLI

For automated deployments, use the SnapApp CLI: 1. Download the package .json and rename it to data.json. 2. Run snapapp plan to preview the changes. 3. Run snapapp apply to finalize the installation.

Management Best Practices

• Versioning: Always increment your version number when making significant changes to ensure clean upgrades.
• Dependencies: Before installing, ensure the target instance has any required standard objects or license tiers (e.g., Enterprise license for certain features).
• Cleanup: If a package is no longer needed, use the Delete button. This removes the package record from the list but does not uninstall components already deployed in other instances.

Thank you for following these steps to manage your SnapApp Packages effectively. If you have any questions or need further assistance, please don’t hesitate to reach out to our support team. We’re here to help you make the most out of your SnapApp experience.

For support, email us at snapapp@bluevector.ai