See the blog post "Use Subflow EVERYWHERE" 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" 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.)
- The "build your own API endpoint inside of Salesforce" API endpoint supported by the Apex class "SalesRepAPI," which lives in "
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.
- Download a copy of this codebase to your computer.
- 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:
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 adminEmail=your-github-email@example.com [12/25/22 08:20:33] Created: OrgId: 00D123456789123, Username:scratch-org-username@example.com Generating scratch org user password with command: sfdx force:user:password:generate -u scratch-org-username@example.com [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!
- 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):
- 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:
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.)
- (If you want to open the scratch org in a specific browser, add "
- Or this SFDX command:
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.)
- (If you want to open the scratch org in a specific browser, add "
- Either this CumulusCI command:
- 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"):<response>005987123654456987</response>
- 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!
- Validate that the contents of this website look something like this (should contain a Salesforce user ID starting with "
- If you get stuck and need to delete your scratch org and start over, run the following CumulusCI command:
cci org remove --org feature
- Download a copy of this codebase to your computer.
- 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):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:
{ "status": 0, "result": { "username": "scratch-org-username@example.com", ... "orgId": "00D123456789123" } }
- 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:
- Install Mitch Spano's Trigger Actions Framework package into the scratch org with the following SFDX command:
sfdx force:package:beta:install -u sfdxstyle --package 04t3h000004VaHaAAK
- Wait about 1 minute, then install the most interesting part of this codebase into the scratch org with the following SFDX command:
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.
- 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:
- 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:executecommand will run with correct output):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:
sf deploy metadata --target-org sfdxstyle --source-dir ./force-app-sfdx-manual-only/
- Either this one (after which you might need to wait a few minutes before the subsequent
- Associate code from the most interesting part of this codebase with the public API you just created with the following SFDX command:
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:createand it simply isn't done yet. Try theforce:apex:executecommand 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 ...
- 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):
- 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:
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.)
- (If you want to open the scratch org in a specific browser, add "
- 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"):<response>005987123654456987</response>
- 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!
- Validate that the contents of this website look something like this (should contain a Salesforce user ID starting with "
- If you get stuck and need to delete your scratch org and start over, run the following SFDX command:
sfdx force:org:delete -u sfdxstyle
- 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 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