Packages are bundles of SnapApp components and configurations used to import and export SnapApp components between instances and applications.

Table of Contents

• Create a Package
• Configuration of packages
• View the Package Configuration
• Download a package
• Install a package using CLI
• Install a package using SnapApp
• Delete a Package

Create a Package

1. Open Settings from the User menu.

   

2. Select Packages from the Automation dropdown menu.

   

3. Click + Add New in the top header of the Packages list view to add a new Package.

   

4. Fill out the required fields.

   

5. Add the required components and hit Save.

   

6. Detail view of the package will be shown, while the package is in the Building state.

   

7. After the build is complete, the package will be ready to download.

   

Configuration of packages

1. Create a new Package

2. Update the following settings

   Setting	Description
   Name	The name of the package to be displayed in lists
   Version	The version number for the package
   Description	A brief description of the package
   Primary Image	An image to be displayed for the package
   Marketing Description	Description of the complete product to be used on market listings
   Subtitle	A tagline for the product or a brief marketing description
   Categories	Category of the package, choose from the dropdown
   Industry	Indutry where the package can be used, choose from the dropdown
   Install instructions	A text instruction for the initial setup of the package when installing

3. Click Add on Package Components

   Setting	Description
   Object ID	ID of the object from where the components two be taken
   Object	Choose Object to be added to the package

View the Package Configuration

1. Open Settings from the User menu.
2. Select Packagesfrom the Automation dropdown menu.
3. Select the Package in the list that you want to view.
4. Click the Package name or ID to be taken to the detail view.

Download a package

1. Go to the detail view of the Package needed.
2. Click on the Download button on the top header of the detail view.
3. A .json file will be downloaded.

Install a package using CLI

1. Using CLI create a connection to SnapApp instance. SnapApp CLI Docs
2. Download the package JSON file.
3. Replace the existing data.json file with the downloaded one and rename it to data.json.
4. Run the below command to create a plan of the list of resources that will be created, updated, or deleted.

bash
snapapp plan

To apply the plan to a SnapApp instance, run the below command.

bash
snapapp apply

Install a package using SnapApp

1. Open Settings from the User menu.
2. Select Packagesfrom the Automation dropdown menu.
3. Click Install Package in the top header of the Packages list view.
4. Browse for the package JSON file and select it → Install

Delete a Package

1. Open Settings from the User menu.
2. Select Packages from the UX dropdown menu.
3. Search for the Package in the list that you want to delete.
4. Click the delete button. To see the delete button, you must have Delete permission assigned to your user role.

Thank you for following these steps to configure your SnapApp components 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