Overview
This document details the steps to build a Salesforce Flow using the Apex Action "Sync an Appointment with Case Status." This action will allow you to sync appointment details between Salesforce and Case Status efficiently.
Prerequisites
- Ensure you have the Case Status API Key, which can be obtained by contacting support@casestatus.com.
- Appropriate permissions to create and modify Flows in Salesforce.
Steps to Create the Flow
-
Navigate to Flow Builder:
- In Salesforce, go to Setup.
- Enter "Flows" in the Quick Find box and select Flows.
- Click on New Flow.
- Select Screen Flow (or any other type of flow based on your use case) and click Next.
-
Add Apex Action:
- Drag and drop the Apex Action element onto the canvas.
- In the Action field, search for and select "Sync an Appointment with Case Status".
-
Set Input Values:
-
You will need to set the following required input values:
- Appointment Address (String): Populate the appointment address or search for resources that provide this value.
- Appointment Date (DateTime): Populate the appointment datetime in the format M/d/yyyy HH:mm a or search for resources that provide this value.
- Appointment Record Id (String): Populate the appointment record ID or search for resources that provide this value.
- If using a field on the matter object, concatenate the field name to the matter object ID
- Appointment Type (String): Populate the appointment type or search for resources that provide this value.
- Case Status API Key (String): Populate the API key provided by Case Status.
- Related Matter Record Id (String): Populate the related matter record ID or search for resources that provide this value.
-
Optional Input Values:
- Appointment Deleted? (Boolean): Specify if the appointment is deleted.
- Appointment Description (String): Populate the description of the appointment.
- Base Url (String): Defaults to "https://app.casestatus.com/".
- Days Before Confirmation Request (Number): Populate the number of days before a confirmation request should be sent to the client.
- Internal Alert Days Before (Number): Enter the number of days before an internal alert should be sent regarding the appointment if unconfirmed.
- Office Name (If Medical) (String): Populate the office name if the appointment is medical-related.
- Provider Name (If Medical) (String): Populate the provider name if the appointment is medical-related.
- Provider Type (String): Should match a treatment type name in Case Status. Required to create a new medical appointment.
- Require Appointment Confirmation (Boolean): Specify if appointment confirmation is required.
- Send Appointment Internal Alert (Boolean): Specify if an internal alert should be sent for the appointment.
-
-
Configure Output Variables (If Any):
- If the Apex Action returns output values that you need to use later in the flow, configure these as necessary.
-
Add Additional Elements:
- Depending on your use case, you may need to add additional elements to your flow (e.g., screens, decisions, assignments).
-
Save and Activate the Flow:
- Once you have configured all necessary elements, save your flow.
- Click Activate to make the flow available for use.
Example Use Case
You can use this Flow to automatically sync new appointments created in Salesforce with Case Status, ensuring that appointment details are consistent across both systems.
Troubleshooting
- Ensure all required fields are populated correctly.
- Verify the Case Status API Key is correct and active.
- Check for any error messages returned by the Apex Action and resolve any issues as indicated.
For further assistance, please contact support@casestatus.com.
Comments
0 comments
Please sign in to leave a comment.