Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,25 @@ Unsubscribe Link Resources:

- [Installation instructions Updated 9/25/24](https://docs.google.com/document/d/1vevs5MKiTmHEtJXceSsenAm3sViQF38bAfoJ6WdATYA/edit#heading=h.3d7st1pta4ai)

## Community Sprints
## Community Sprints

### Working with Unsubscribe Link in a scratch org

Unsubscribe link is set up to use CumulusCI(CCI) for development of the managed package. To work on development of items within the managed package you will need to use CumulusCI to install the unmanaged metadata in a scratch or development org. The following trailhead describes how to install and setup CumulusCI on your computer [CumulusCI Setup](https://trailhead.salesforce.com/content/learn/modules/cumulusci-setup).

Once you have CCI installed and have opened this repository on your computer, run the following commands:
```
cci flow run dev_org --org dev
cci org browser --org dev
```

Optionally, you can run `cci org default dev` to set the 'dev' org definition as your default. If you do this, you can omit the `--org dev` portion of any CCI command.

To install the packaged version into a scratch or developer org, use one of the following commands
```
cci task run install_managed
cci task run install_managed_beta
```

### [Upcoming] September 2024 Virtual Community Sprint - September 26th and 27th global virtual sprint

Expand Down
51 changes: 51 additions & 0 deletions cumulusci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,54 @@ tasks:
run_tests:
options:
required_org_code_coverage_percent: 75

install_v3:
description: install the older SF Labs version 3 of Unsubscribe Link. Useful for upgrade testing
class_path: cumulusci.tasks.command.Command
options:
command: sf package install --package 04t4W000002kcU0QAI

install_v4-prerelease:
description: install the pre-release packaged version of the Commons version of Unsubscribe Link. Used in the March 2025 sprint, but should be deprecated after the package is released in favor of default CCI tasks.
class_path: cumulusci.tasks.command.Command
options:
command: sf package install --package 04taj000000471JAAQ

labs_upgrade_package:
description: Installs metadata used for a scripted migration from the Salesforce Labs package to the Commons managed package.
class_path: cumulusci.tasks.salesforce.Deploy
options:
path: unpackaged/labs-upgrade

flows:
customer_org:
description: Flow that installs the managed version and, optionally, the upgrade package into a customer org
steps:
1:
task: install_managed


plans:
install:
slug: install
title: Base Install
tier: primary
is_listed: true
preflight_message: This will install Unsubscribe Link into your org.
steps:
1:
flow: customer_org

lab-upgrade:
slug: labs-upgrade
title: Salesforce Labs Upgrade Path
is_listed: true
preflight_message: For orgs upgrading from Salesforce labs, install a migration tool for moving old Unsubscribe records to the new managed object.
post_install_message: "Within your org, run the 'Unsubscribe: Data Migration Flow' screen flow to kick off the data migration batch."
checks:
- when: "'jrsl_ul_Unsubscribe__c' not in tasks.check_sobjects_available()"
action: error
message: "This plan is only accessible if you have previously installed the Salesforce Labs version of the application in your org."
steps:
1:
task: labs_upgrade_package
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
2 changes: 1 addition & 1 deletion force-app/main/default/classes/UUIDBatchJob.cls-meta.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
2 changes: 1 addition & 1 deletion force-app/main/default/classes/UUIDUtility.cls-meta.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>60.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>60.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>63.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexClass xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>63.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexComponent xmlns="http://soap.sforce.com/2006/04/metadata">
<ApexComponent xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>63.0</apiVersion>
<label>UnsubscribeLink</label>
</ApexComponent>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">
<FlexiPage xmlns="https://soap.sforce.com/2006/04/metadata">
<flexiPageRegions>
<appendable>enabled</appendable>
<itemInstances>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<actionCalls>
<name>Generate_UUID</name>
<label>Generate UUID</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<actionCalls>
<name>Generate_UUID</name>
<label>Generate UUID</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<actionCalls>
<description>Send email to administrators alerting them about the error.</description>
<name>Send_Error_Email</name>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<actionCalls>
<description>Send error email to alert admin.</description>
<name>Send_Error_Email</name>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<actionCalls>
<description>Alert the person that they unsubscribed. Turn this off in the custom metadata type Unsubscribe Link.</description>
<name>ConfirmationEmail</name>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<actionCalls>
<name>Contact_Batch</name>
<label>Contact Batch</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
<Flow xmlns="https://soap.sforce.com/2006/04/metadata">
<apiVersion>61.0</apiVersion>
<assignments>
<description>Assign variables to the email variable from the screen and assign a null value to the recordId variable.</description>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
<Layout xmlns="https://soap.sforce.com/2006/04/metadata">
<excludeButtons>OpenSlackRecordChannel</excludeButtons>
<excludeButtons>Submit</excludeButtons>
<layoutSections>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
<Layout xmlns="https://soap.sforce.com/2006/04/metadata">
<layoutSections>
<customLabel>false</customLabel>
<detailHeading>false</detailHeading>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata"></CustomObject>
<CustomObject xmlns="https://soap.sforce.com/2006/04/metadata"></CustomObject>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Part1_Unsubscribe_Link__c</fullName>
<description>This is used to create the Unsubscribe Link which is a formula field.</description>
<externalId>false</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Public_Id__c</fullName>
<caseSensitive>true</caseSensitive>
<externalId>true</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Unsubscribe_Link_Contact__c</fullName>
<description>Insert this link into emails to allow contacts to unsubscribe from emails sent from Salesforce. This will work if you have followed the instructions for the Unsubscribe link app. Modify the text of the link in the Custom Metadata type Unsubscribe Link, the record called Unsubscribe, the field Link Text.</description>
<externalId>false</externalId>
Expand Down
2 changes: 1 addition & 1 deletion force-app/main/default/objects/Lead/Lead.object-meta.xml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata"></CustomObject>
<CustomObject xmlns="https://soap.sforce.com/2006/04/metadata"></CustomObject>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Part1_Unsubscribe_Link__c</fullName>
<description>Used to generate the Unsubscribe Link formula field.</description>
<externalId>false</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Public_Id__c</fullName>
<caseSensitive>true</caseSensitive>
<externalId>true</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Unsubscribe_Link_Lead__c</fullName>
<description>Insert this link into emails to allow leads to unsubscribe from emails sent from Salesforce. This will work if you have followed the instructions for the Unsubscribe link app. Modify the text of the link in the Custom Metadata type Unsubscribe Link, the record called Unsubscribe, the field Link Text.</description>
<externalId>false</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Confirmation_Email_Text__c</fullName>
<defaultValue
>&quot;You have successfully unsubscribed from all email from &quot; +
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Confirmation_Page__c</fullName>
<defaultValue>&quot;No&quot;</defaultValue>
<externalId>false</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Enable_Type_in_Email_Address__c</fullName>
<externalId>false</externalId>
<label>Enable Type-in Email Address</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Error_Email_Recipient__c</fullName>
<externalId>false</externalId>
<label>Error Email Recipient</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Link_Text__c</fullName>
<externalId>false</externalId>
<label>Link Text</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Org_Wide_Email_Address__c</fullName>
<externalId>false</externalId>
<label>Org Wide Email Address</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Our_Organization__c</fullName>
<externalId>false</externalId>
<label>Our Organization</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Screen_1_Part_1__c</fullName>
<externalId>false</externalId>
<label>Screen 1 Part 1</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Screen_1_Part_2__c</fullName>
<externalId>false</externalId>
<label>Screen 1 Part 2</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Screen_2_Part_1__c</fullName>
<externalId>false</externalId>
<label>Screen 2 Part 1</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Screen_2_Part_2__c</fullName>
<externalId>false</externalId>
<label>Screen 2 Part 2</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Screen_3__c</fullName>
<externalId>false</externalId>
<label>Screen 3</label>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Send_Confirmation_Email__c</fullName>
<defaultValue>&quot;No&quot;</defaultValue>
<externalId>false</externalId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<CustomField xmlns="https://soap.sforce.com/2006/04/metadata">
<fullName>Site_Domain__c</fullName>
<externalId>false</externalId>
<label>Site Domain</label>
Expand Down
Loading