Welcome to Blackthorn Events!

How to Install Blackthorn Events and Provision Licenses to Your Users

Welcome to Blackthorn! To simplify the installation process, Blackthorn has adopted the Candy Shop. If you are installing Events for the first time, the installer will automatically install the Base Package first, then Payments, and lastly Events.

If either Base Package or Payments are already installed, the installer will make sure the correct versions are either installed or upgraded before installing Events.

Start Here

  1. Go to the Blackthorn Candy Shop.

  2. Click Blackthorn Events.

19021902
  1. Click Install Blackthorn Events - Click Here for Details.
18961896
  1. If you are not logged into Salesforce, you will be prompted to do so now.

  2. Click Allow to allow Blackthorn to access the following information.

651651
  1. Click Install.
    As each step is completed, a green checkmark will appear in the Install column.
18971897
  1. For new installs, the Candy Shop will take care of the following configuration steps for Events.
  • Install Base Package
  • Install Blackthorn Payments
  • Install Blackthorn Events
  • Assign Blackthorn | Events (Admin) and Blackthorn | Payments (Admin) permission sets to the installing user
  • Automatically scheduled Events Scheduled jobs
  • Authorize the Event App as the installing user
  1. The installing user will receive the following email alerts.
  • Base Package install successful
  • Payments Package install successful
  • Events Package install successful
  • Payment Gateway Customer Matching Rule activated
  • Attendee Matching Rule activated
18851885
  1. Click View Org to go to your Salesforce Org.

Configure Events for Use

Before Events can be used, a multi-step configuration process must be completed. In addition to authorizing the Events app, the Configuration tab on the Blackthorn | Events Admin page allows users to set up Events for first time users. The additional tabs on the Blackthorn | Events Admin page give users an easy way to deploy and make automatic updates.

📘

Recommendation

Before configuring the Events app or activating Scheduled Jobs, we recommend logging as an integration user. This can help reduce issues related to configuration and authorization and individual employee user access.

Provision Licenses

After you have purchased Blackthorn licenses, perform the following steps to assign them to the designated users. To transfer licenses between users, repeat the process.

🚧

This step does not apply if you are using the free trial. However, you will need to complete this step after purchasing Blackthorn licenses in order to give designated users access to the app.

Assign Users to the Payments Application

📘

Requirement for Events Customers

An Events authorization user must be assigned a Payments license. This prerequisite applies even if you are only offering Free Events.

  1. From Setup, navigate to:

    • Lightning: Apps | Packaging | Installed Packages.
    • Classic: Build | Installed Packages.
  2. Click on Manage Licenses next to Blackthorn | Payments.

  3. Click Add Users.

  4. Select the users you want to add.

  5. Click Add.

Assign Users to the Events Application

  1. From Setup, navigate to:

    • Lightning: Apps | Packaging | Installed Packages.
    • Classic: Build | Installed Packages.
  2. Click on Manage Licenses next to Blackthorn | Events.

  3. Click Add Users.

  4. Select the users you want to add.

  5. Click Add.

Events Permission Sets

📘

When a user installs Blackthorn Events via Candy Shop, we automatically assign the Blackthorn Events Admin and Blackthorn Payments Admin Permission Sets to the installing user.

Access to Events is managed by permission sets. After installation, it is necessary to assign permission sets to designated users to ensure that they have the necessary level of access.

To automatically assign all non-system admin users the Admin Permission Set, click the Assign Events Permission Sets to All Users button.

28802880

IMAGE 6: ASSIGN PERMISSION SET TO ALL USERS

Pre-configured Permission Sets

Out of the box, Blackthorn provides a set of pre-configured permission sets that can be assigned to users.

❗️

If you create a custom permission set, you will need to modify it after each new Events’ release to ensure that users with that custom permission set continue to have the appropriate access.

Blackthorn | Events (Admin)
The Events Admin permission set gives users full access to all objects, including custom objects. The user will also have Create/Read/Update permissions for several Payments features including Relationship Settings, the Data Dictionary, Codes, and Codes Eligibility.

Blackthorn | Events (Limited Access)
The Events Limited Access permission set provides users with Create/Read/Update permissions for the Event and Attendee objects. Users do not have access to the Event Settings object nor delete access to any custom objects.

Blackthorn | Events (Read Only)
The Read Only permission set is for users who have a Read-Only license and provides Read-Only permission to the entire app. This permission set is commonly given to users who need to review reports.

Blackthorn | Events (Community/Platform User)
The Community/Platform User permission set provides Create/Read/Update permissions for all Event objects. However, there is no access to Assigned Apps, Leads, and Opportunity fields so the permission set can be assigned to Community and Platform license users.

How to Assign a Permission Set

  1. From Setup, navigate to:

    • Lightning: Users | Permission Sets.
    • Classic: Administer | Manage Users | Permission Sets.
  2. Click a permission set name (e.g. Blackthorn | Events (Admin)).

  3. Click Manage Assignments.

  4. Click Add Assignments.

  5. Select the users.

  6. Click Assign.

  7. Click Done.

📘

If any of your users need access to financial data related to paid registrations or Discount Codes, they will need a Payments license and to be related to one of the packaged Payments permission sets or a custom permission set. Financial data includes data from Invoices, Discount Codes, Transactions, Payments Methods, and the Payment Gateway objects.

Payments Permission Sets

Payments access is managed by permission sets. After installation, it is necessary to assign permission sets to designated users to ensure they have the correct type of access.

Pre-configured Permission Sets

Out of the box, Blackthorn provides a set of pre-configured permission sets that can be assigned to users.

❗️

If you create a custom permission set, you will need to modify it after each new Payments’ release to ensure that users with that custom permission set continue to have the appropriate access.

Blackthorn | Payments (Admin)
The Payments Admin permission set is automatically given to Salesforce users with the System Administrator Profile. Users with Payments Admin permissions are able to access the Payments (Admin) app, Setup Wizard, and Payment Settings tabs and perform view all, modify all, and delete records tasks for custom objects.

Blackthorn | Payments (Manager)
The Payments Manager permission set is given to Salesforce users without a System Administrator profile. Users with this permission set only have Read permissions for the Payment Gateway and Webhook Event objects. All other custom objects have Delete permissions.

Blackthorn | Payments (User)
The Payments User permission set has Read permissions for Payment Gateway and Webhook Event objects and Read/Create permissions for the Blackthorn Log object. Users do not have Delete permissions on any custom objects.

Blackthorn | Payments (Community/Platform User)
The Payments Community/Platform User permission set is identical to the Blackthorn | Payments (User) permission set except that it does not have any of our Assigned Apps (a collection of tabs). This is because a permission set assigned to a Community user cannot have any Assigned Apps. Customers who want to give Community users access to Payments should use this permission set.

Blackthorn | Payments (Stripe Billing)
The Payments Stripe Billing permission set provides Admin permissions to all Stripe Billing objects and fields. This should be used by customers who want to give access to users who use the Stripe Billing feature.

How to Assign a Permission Set

  1. From Setup, navigate to:

    • Lightning: Users | Permission Sets.
    • Classic: Administer | Manage Users | Permission Sets.
  2. Click on a permission set name (e.g. Blackthorn | Payments (Admin)).

  3. Click Manage Assignments.

  4. Click Add Assignments.

  5. Select the users.

  6. Click Assign.

  7. Click Done.

Set Up Payment Gateway

A Payment Gateway record is synonymous with a gateway (i.e. Stripe, Authorize.net etc.) account. Each Payment Gateway record you create connects your Salesforce org to one gateway account, in either test or live mode. To have your gateway account in both test and live mode, create two Payment Gateway records. There is no limit on the number of Payment Gateway accounts you can connect to your org.

📘

A Payment Gateway must be created for all Events, including Free Events.

To create a Payment Gateway for only Free Events, click the Create a Payment Gateway for Free Events button, and the gateway will be created for you.

19061906

IMAGE 7: CREATE A PAYMENT GATEWAY FOR FREE EVENTS

Payment Gateway for Paid Events

To support paid Events, you'll need to connect to your Payment Gateway in Salesforce. To create and connect a Payment Gateway for paid Events, follow the instructions for Stripe or Authorize.net.

We suggest connecting to your Gateway in "Test Mode," initially. When you are ready to go live, create another Payment Gateway record connecting to your Gateway in "Live Mode."

🚧

Note About Payment Gateway Records

Do not change your Payment Gateway record from Test to Live mode or vice versa by clicking Connect to Gateway or checking/unchecking the Test Mode checkbox. Instead, create a new record for the other mode you wish to enable.

First Payment Gateway Record

Your first Payment Gateway record, named "primary" was automatically created during setup. To view the record, follow the steps below.

  1. Navigate to the Payment Gateway object.
    Lightning/Classic: Payments (Admin) App | Click the "Payment Gateways" Tab

  2. Select “All” from the list of List Views.

  3. Click on the record named "primary."

18931893

IMAGE 8: FIRST PAYMENT GATEWAY RECORD

To connect to your gateway account in test mode, check the Test Mode field. When the Default field is checked, Payment Methods created without a related Payment Gateway will automatically be set to use the default Payment Gateway. Only one Payment Gateway can be set as the default.

The Gateway Information section provides the connection details. If these fields are blank, data in Salesforce will not process in the gateway.

📘

Do not copy your Stripe API keys and insert them here as these keys are different from your Stripe keys (they are OAuth keys). You can only get them by clicking the Connect to Stripe button.

Create a Payment Gateway for Stripe

NOTE: To create a Payment Gateway with Authorize.net, please use these instructions.

Each Stripe account mode (Test and Live) needs its own Payment Gateway record.This is to ensure that your data is separated from Live and Test.

Navigate to the Payment Gateway Object.
Lightning/Classic: Payments (Admin) App | Click the "Payment Gateways" Tab

  1. Click New.

  2. Populate the following fields:

    • Payment Gateway Name = Name for this record.
    • Webhook Label = Name for the webhook URL.
    • Default = Check this field if you want this as your default Payment Gateway.
      If you have multiple Stripe Payment Gateway accounts, you can change which one should default.
    • Test Mode = Check this field if you are connecting to the Test mode in your Stripe account.
  3. Click Save.

  4. Click the Connect to Gateway button.

  5. Enter your Stripe Credentials.

Once you have signed in, the fields under the "Gateway Information" section in the Payment Gateway record will be filled out.

📘

There will be no data in the "Related Lists" section. Connecting to your Stripe Account does not automatically sync existing data over into Salesforce. If you have data in your Stripe Account that needs to come over into Salesforce, see the Historical Sync documentation.

Create Default Test Group

Click Create Default Group.

19061906

IMAGE 9: CREATE DEFAULT TEST GROUP

Create Test Records

Once you click the Create Test Records button, 8 sample Events are available for testing. The following Events will be added to your Salesforce org.

21902190

IMAGE 10: TEST RECORDS

Create Email Templates

Clicking Create Email Templates creates our out-of-the-box email templates.

19061906

IMAGE 11: CREATE EMAIL TEMPLATES

For more information about using email templates, click here.

Deploy to Production

When you are ready to install Blackthorn into your production org, please email [email protected] with your org id and we will update your licenses. We have to update your licenses from a trial version before it expires.

Once we upgrade your licenses, you'll need to navigate to, "installed packages", click manage next to Blackthorn | Payments and add all users who need access to payments, including the authorized user. Most of our Events customers have a site license for the Events app, so you won't need to add users. They will have access based on their profile and permission sets.


Did this page help you?