Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kkgthb/sf-flow-service-layer
Salesforce subflow as a service layer
https://github.com/kkgthb/sf-flow-service-layer
Last synced: about 1 month ago
JSON representation
Salesforce subflow as a service layer
- Host: GitHub
- URL: https://github.com/kkgthb/sf-flow-service-layer
- Owner: kkgthb
- Created: 2022-10-24T18:54:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-27T14:59:26.000Z (almost 2 years ago)
- Last Synced: 2023-05-11T19:22:05.542Z (over 1 year ago)
- Language: Apex
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## What's in this codebase
See the blog post "[Use Subflow EVERYWHERE](https://katiekodes.com/subflow-service-layer-principles/)" for the reason this codebase exists.
* The Autolaunched Flow labeled "**Sales Rep Suggester**," which lives in "`/force-app/00_shared_subflow_main`" in this codebase, is used by both:
* The "[build your own API endpoint inside of Salesforce](https://katiekodes.com/introduction-salesforce-rest-apis/#1--build-your-own-endpoint-inside-salesforce)" API endpoint supported by the Apex class "**SalesRepAPI**," which lives in "`/force-app/20_rest_api_main`" in this codebase.
* The record-triggered flow labeled "**Account Assign Sugg Sales Rep Flow (TAF)**," which lives in "`/force-app/40_dml_triggered_main`" in this codebase.
* _(Technically it's not a typical Salesforce record-triggered flow. Technically it's also yet another Autolaunched Flow, and it's called by the "**AccountTrigger_TAF**" trigger and the "**TAF SOA Account**" custom metadata entry the "**TAF Account Assign Sugg Sales Rep FlwBI** custom metadata entry.)_
**Project idea:** Enhance this codebase by adding some extra users to the scratch org and making the "**Sales Rep Suggester**" Flow more complex about which countries go to which sales rep. Edit some Account records and validate that your changes take effect _(that `OwnerId` gets assigned correctly)_. You can do so by opening a scratch org based on this codebase and editing the Flow in your web browser, just like administering any other Salesforce org.
**Project idea:** Enhance this codebase by adding another Autolaunched Flow labeled "**Contact Assign Sugg Sales Rep Flow (TAF)**," being sure to also add a "**TAF SOA Contact**" custom metadata entry and a "**TAF Contact Assign Sugg Sales Rep FlwBI** custom metadata entry. Don't forget you'll have to change the new Flow to work with a `MailingCountry` instead of a `BillingCountry`. Edit some Contact records and validate that your changes take effect _(that `OwnerId` gets assigned correctly based on the logic in "**Sales Rep Suggester**")_. You can do so by opening a scratch org based on this codebase and editing the Flow and Custom Metadata in your web browser, just like administering any other Salesforce org.
---
## How to create a scratch org from this codebase using the CumulusCI command-line tool:
1. Download a copy of this codebase to your computer.
2. With your computer's command prompt set to the folder into which you downloaded this codebase, run the following CumulusCI command-line command to create a scratch org:
```sh
cci flow run dev_org --org feature
```
* It should take a couple of minutes to set up, and you should see the following things occur in the output of running this command _(please **be sure to validate** that the "robot" tests and the "run_tests" tests pass)_:
```
[12/25/22 08:20:08] Creating scratch org with command: sfdx force:org:create --json -f orgs/feature.json -w 120 -n --durationdays 1 -a flow-service-layer-demo__feature
[email protected]
[12/25/22 08:20:33] Created: OrgId: 00D123456789123, Username:[email protected]
Generating scratch org user password with command: sfdx force:user:password:generate -u [email protected]
[12/25/22 08:20:37] ============================================================
Initializing flow: FlowCoordinator (dev_org)
Set up an org as a development environment for unmanaged metadata
============================================================
[12/25/22 08:21:35] ------------------------------------------------------------
Running task: create_community
------------------------------------------------------------
...
[12/25/22 08:22:21] Community 0DB987654321321 created
------------------------------------------------------------
Running task: enable_sales_rep_api_class_on_public_apis_profile
------------------------------------------------------------
...
Anonymous Apex Executed Successfully!
------------------------------------------------------------
Running task: robot
------------------------------------------------------------
...
Tests.Sales Rep Api | PASS |
1 test, 1 passed, 0 failed
...
Tests.Sales Rep Api Unauthenticated | PASS |
1 test, 1 passed, 0 failed
==============================================================================
Tests | PASS |
2 tests, 2 passed, 0 failed
==============================================================================
...
[12/25/22 08:22:28] ------------------------------------------------------------
Running task: run_tests
------------------------------------------------------------
...
--------------------------------------------------------------------------------
Pass: 93 Retried: 0 Fail: 0 CompileFail: 0 Skip: 0
--------------------------------------------------------------------------------
...
[12/25/22 08:22:44] Completed flow 'dev_org' on org feature successfully!
```
3. If you'd like to poke around and see what's in this scratch org, open the scratch org in the browser with either of the following commands:
* Either this CumulusCI command:
```sh
cci org browser --org feature
```
* _(If you want to open the scratch org in a specific browser, add "` --url-only`" to the end of the command and, after running it, and copy the URL to your clipboard from the command-line output.)_
* Or this SFDX command:
```sh
sfdx force:org:open -u flow-service-layer-demo__feature
```
* _(If you want to open the scratch org in a specific browser, add "` -b chrome`," "` -b firefox`," etc. to the end of the command.)_
* _(Alternatively, add "` -r`" to the end of the command and, after running it, and copy the URL to your clipboard from the command-line output.)_
4. To see the public API in action, if the URL your browser opened _(or the URL that "` --url-only`" or "` -r`" put into the command line)_ looks like "`https://12345.scratch.lightning.force.com/...`" or "`https://12345.scratch.my.salesforce.com/...`," make note of what actually appears in your URLs instead of "`12345`" and then visit this URL, of course replacing "`12345`" with your value from your scratch org _(note that it's "`site.com`" not "`salesforce.com`")_:
```
https://12345.scratch.my.site.com/services/apexrest/get_sales_rep
```
* **Validate** that the contents of this website look something like this _(should contain a Salesforce user ID starting with "`005`")_:
```xml
005987123654456987
```
* Note that you shouldn't even need to open this URL in the same browser that's already logged into your scratch org -- theoretically, you could visit it from a totally different browser in incognito mode and it would work, because it's a _**publicly available**_ URL for an "API" included with this codebase.
* In fact, please **validate** that this is the case!
5. If you get stuck and need to delete your scratch org and start over, run the following CumulusCI command:
```sh
cci org remove --org feature
```
---
## How to create a scratch org from this codebase using the SFDX command-line tool:
1. Download a copy of this codebase to your computer.
2. With your computer's command prompt set to the folder into which you downloaded this codebase, run the following SFDX command-line command to create a scratch org _(you may change the scratch org's command-line "**alias**" from "`sfdxstyle`" to anything you'd like -- just be sure to also do so in the additional commands in these instructions)_:
```sh
sfdx force:org:create -f ./orgs/sfdxstyle.json --setalias sfdxstyle --durationdays 1 --json --loglevel fatal
```
* It should take a couple of minutes to set up, and you should see the following things occur in the output of running this command:
```json
{
"status": 0,
"result": {
"username": "[email protected]",
...
"orgId": "00D123456789123"
}
}
```
3. Install Mitch Spano's [Trigger Actions Framework](https://github.com/mitchspano/apex-trigger-actions-framework) package into the scratch org with the following SFDX command:
```sh
sfdx force:package:beta:install -u sfdxstyle --package 04t3h000004VaHaAAK
```
4. Wait about 1 minute, then install the most interesting part of this codebase into the scratch org with the following SFDX command:
```sh
sf deploy metadata --target-org sfdxstyle --source-dir ./force-app/
```
* If it doesn't work, **wait** another minute or two for Trigger Actions Framework to finish installing and **try again**. Failure due to Trigger Actions Framework not existing yet typically looks like this command-line output:
```
Status: Failed | ████████████████████████████████████████ | 14/14 Components
Component Failures [3]
=======================================================================================================================================================
| Type Name Problem
| ───── ────────────────────────────────────────────────────── ────────────────────────────────────────────────────────────────────────────────────────
| Error Trigger_Action.TAF_Account_Assign_Sugg_Sales_Rep_ApxBI Custom metadata type Trigger_Action__mdt is not available in this organization.
| Error Trigger_Action.TAF_Account_Assign_Sugg_Sales_Rep_FlwBI Custom metadata type Trigger_Action__mdt is not available in this organization.
| Error sObject_Trigger_Setting.tafsoa_Account Custom metadata type sObject_Trigger_Setting__mdt is not available in this organization.
```
5. Enable the scratch org to host public APIs with either of these SFDX commands _(just choose one)_:
* Either this one _(after which you might need to wait a few minutes before the subsequent `force:apex:execute` command will run with correct output)_:
```sh
sfdx force:community:create -u sfdxstyle -n "Public APIs" -d "A place to stash miscellaneous public APIs" -p "publicapis" -t "Build Your Own"
```
* Or this one:
```sh
sf deploy metadata --target-org sfdxstyle --source-dir ./force-app-sfdx-manual-only/
```
6. Associate code from the most interesting part of this codebase with the public API you just created with the following SFDX command:
```sh
sfdx force:apex:execute -u sfdxstyle -f ./scripts/setup.cls
```
* The output should look someting like this _(please **validate** that there are 3 SOQL queries w/ 2 rows, and 1 DML statement with 1 row)_:
```
...
10:27:26.528 (528164996)|LIMIT_USAGE_FOR_NS|(default)|
Number of SOQL queries: 3 out of 100
Number of query rows: 2 out of 50000
...
Number of DML statements: 1 out of 150
...
Number of DML rows: 1 out of 10000
...
```
* If the output looks more like this, with just 1 query and 0 for all other values, you probably tried to create a community with `force:community:create` and it simply isn't done yet. Try the `force:apex:execute` command again in a few minutes.
```
10:39:13.265 (265244398)|LIMIT_USAGE_FOR_NS|(default)|
Number of SOQL queries: 1 out of 100
Number of query rows: 0 out of 50000
...
Number of DML statements: 0 out of 150
...
Number of DML rows: 0 out of 10000
...
```
7. If you'd like to poke around and see what's in this scratch org, open the scratch org in the browser with the following SFDX command:
```sh
sfdx force:org:open -u sfdxstyle
```
* _(If you want to open the scratch org in a specific browser, add "` -b chrome`," "` -b firefox`," etc. to the end of the command.)_
* _(Alternatively, add "` -r`" to the end of the command and, after running it, and copy the URL to your clipboard from the command-line output.)_
8. To see the public API in action, if the URL your browser opened _(or the URL that "` -r`" put into the command line)_ looks like "`https://12345.scratch.lightning.force.com/...`" or "`https://12345.scratch.my.salesforce.com/...`," make note of what actually appears in your URLs instead of "`12345`" and then visit this URL, of course replacing "`12345`" with your value from your scratch org:
```
https://12345.scratch.my.site.com/services/apexrest/get_sales_rep
```
* **Validate** that the contents of this website look something like this _(should contain a Salesforce user ID starting with "`005`")_:
```xml
005987123654456987
```
* Note that you shouldn't even need to open this URL in the same browser that's already logged into your scratch org -- theoretically, you could visit it from a totally different browser in incognito mode and it would work, because it's a _**publicly available**_ URL for an "API" included with this codebase.
* In fact, please **validate** that this is the case!
9. If you get stuck and need to delete your scratch org and start over, run the following SFDX command:
```sh
sfdx force:org:delete -u sfdxstyle
```
---
## Misc. notes:
* Note that the two Apex classes under "`/force-app/40_dml_triggered_main/classes`" aren't even really used when you spin up a scratch org from this codebase. They would be if "`Bypass_Execution__c`" in the custom metadata entry "**TAF Account Assign Sugg Sales Rep ApxBI**" weren't set to "`true`" -- but it is set to "`true`," because I want you to be impressed by the Flow, not the Apex. These two classes are just artifacts of an earlier time when I wanted to validate that Mitch Spano's [Trigger Actions Framework](https://github.com/mitchspano/apex-trigger-actions-framework) package could delegate "trigger handling" to an Apex class or to an Autolaunched Flow with equal ease.
* https://www.cloudwaale.com/post/how-to-create-public-rest-web-service-in-salesforce
* https://salesforce.stackexchange.com/questions/378966/how-to-include-a-guest-user-license-profile-in-the-ci-for-a-digital-experience
* https://github.com/pgonzaleznetwork/sfdx-community-deployment
---