Install
Second-Generation Managed Package
Last updated
Was this helpful?
Second-Generation Managed Package
Last updated
Was this helpful?
The GRAX Managed Package consists of Lightning Web Components that send traffic to a GRAX application server in order to function. Make sure you have a healthy GRAX app running with Auto Backup enabled before setting up the Managed Package.
Installing and configuring the second-generation Managed Package for the first time is quick and easy. The steps below cover everything from choosing the right org to getting a component added to your first page layout. If you become stuck or encounter unexpected issues while following these steps, feel free to for assistance.
Depending on the type of org you've chosen, open the relevant link below to start the install process.
Opening the correct link will cause a package installation menu to appear.
Salesforce allows packages to be installed for all or some of your users and will present you with a few options. These options determine which users are granted access to the components and classes that power the package features. These options, and their impact, break down as follows:
Select the group you would like to install the package for and click "Install."
Installation should take less than a minute in an average org, but may take longer if you have a very large or very customized org. During the wait, you will see a loading indicator.
Once the installation is completed, a success message will show and you will receive a confirmation email.
The components included in the package source the target server URL from a Custom Setting. Installing the package creates this custom setting, but it is empty by default. You will need to set an organization-default value for the setting before anyone can use the components.
Start by opening the custom settings menu.
Find the "GRAX Settings" item in the list and click "Manage."
Click "New" to create a new organization-level default setting.
Enter the full https://[...].com formatted public domain name of your GRAX application without a trailing slash and click "Save."
The components included in the package are iframed pages retrieved from your GRAX application server. Due to browser security restrictions, additional configuration is necessary to tell Salesforce that you trust the GRAX server to serve iframe content in your org.
To start, open the "Trusted URLs" menu.
To add a new Trusted URL for your GRAX application, click "New Trusted URL."
Make the following changes to the "New Trusted URL" form:
Name it anything you'd like
Use the same https://[...].com formatted domain name as used in the Custom Setting as the URL
Check the frame-src box
Leave the img-src box checked
Now click "Save" to create the record.
Due to enhanced default Content Security Policy settings in recent Salesforce releases, it's necessary to also flag GRAX's centralized authentication server as trusted. Repeat the steps above to create another Trusted URL, but make the following modifications to the form:
Name it anything you'd like
Use https://hq.grax.com as the URL
Check the frame-src box
Leave the img-src box checked
Now click "Save" to create the record.
To see a component in action and test it out, you'll need to modify a page layout for a standard object. Start by opening a standard object record (Case, for example) page in your Salesforce org and then opening the "Setup" sidebar. Click the "Edit [Object] Page" option under "Customization" to open the Lightning App Builder.
Within the Lightning App Builder, the record-page-compatible GRAX components will be available under the "Custom - Managed" category in the components list.
It is recommended to place GRAX components on a separate tab that is not loaded by default when a user opens the record page. This improves the load time of the page in common use cases and minimizes unnecessary traffic to and from your GRAX application.
For purposes of initial testing, we'll use the Related Records component. To add a component to the page, create a new tab and drag the GRAX component onto it from the "components" menu. Initially, some components (like Related Records) may have invalid configurations because they need additional setup to behave properly.
Add the API name of any object directly related to the parent object (whatever object's record page you're modifying) to the component's input settings and save the layout.
The component should now render with data based on your backed up data. Depending on exactly which objects you chose, the exact format of the component may vary. A few examples of the Related Records component are shown below for reference.
Initial setup and verification is now complete. For more information about the package, checkout our , , and guides.
Use this link for any Salesforce org that is considered a production org or which uses the login.salesforce.com login page (like Developer Edition orgs).
Specifies the following settings on the installing administrator’s profile and any profile with the Customize Application permission:
Apex classes - enabled
Custom LWC tab - enabled
Custom Settings record - enabled
Second Generation LWCs - enabled
After installation, if you have Enterprise, Performance, Unlimited, or Developer Edition, set the appropriate user and object permissions on custom profiles as needed