- 13 Nov 2024
- 4 Minutes to read
- Print
- DarkLight
Salesforce.com
- Updated on 13 Nov 2024
- 4 Minutes to read
- Print
- DarkLight
This technical documentation provides a guide for integrating Salesforce with Relay Network, offering custom components for data synchronization, user experience enhancement, automation, and customization. The package aims to establish bidirectional data exchange, optimize workflows, and improve user interactions within Salesforce. The guide covers installation, configuration, Flow actions, Lightning Web Components, custom objects, best practices, and troubleshooting. Prerequisites include understanding Relay Network, Salesforce basics, package installation, security configurations, user permissions, and customization options. By meeting these requirements, organizations can successfully implement and maintain the integration for efficient data management and workflow automation.
Overview
Welcome to the technical documentation for our Salesforce integration package. This comprehensive guide is designed to assist developers and administrators in seamlessly integrating Salesforce with Relay Network. The package includes custom Apex classes, Flow actions, and Lightning Web Components, providing a robust framework for streamlining data integrations and enhancing user experiences within the Salesforce environment.
Intended Purpose
The primary goal of the Salesforce.com Integration Package is to establish a bidirectional data exchange between Salesforce and Relay Network. By leveraging custom components and functionalities, this integration empowers users to seamlessly synchronize, update, and retrieve data across both systems, ensuring a unified and efficient workflow.
Key objectives of the integration package:
Data Synchronization: Enable real-time and batch data synchronization between Salesforce and Relay Network, ensuring consistency and accuracy of shared information.
Enhanced User Experience: Provide a seamless and intuitive user experience within the Salesforce interface, utilizing Lightning Web Components and custom Flow actions to optimize user interactions.
Automation and Customization: Leverage custom Flow actions to automate complex business processes and tailor the integration to specific organizational needs.
How to Use This Guide
This documentation is structured to guide both developers and administrators through the integration process. Here's a breakdown of the sections:
Getting Started: Begin with an introduction to the integration package, including prerequisites and system requirements.
Installation: Walk through the installation process, detailing the necessary steps to deploy the package within your Salesforce environment.
Configuration: Explore configuration options, including how to set up and customize the integration based on your organization's specific needs.
Flow Integrations: Learn about the custom Flow actions provided, with step-by-step example guides on how to incorporate them into your workflows for enhanced automation.
Lightning Web Components: Explore Lightning Web Components designed to improve the user interface and experience within Salesforce, with examples showcasing their usage.
Custom Objects: Understand how the custom objects can be leveraged and incorporated into your processes.
Best Practices: Gain insights into best practices for maintaining and optimizing the integration for long-term success.
Troubleshooting: Find guidance on identifying and resolving common issues that may arise during the integration process.
By following this guide, you'll be equipped to successfully implement and maintain a robust Salesforce.com integration with our software, unlocking the full potential of your combined systems.
Common Terms
Throughout this guide we will be referring to two types of users; Your employees that have a logon to the Salesforce platform and the end users that have access to the Relay Feed.
Term | Description |
---|---|
agent | Throughout this guide agent refers to your employee that have a Salesforce logon and may be interacting with the Relay package in some form or another. The most common interaction use case is through the Relay Lightning Web Component. However, they could also be indirectly interacting with the Relay package through flows that are running in the background based on activity being performed by the agent. |
user | Throughout this guide user refers to your end user, customer, member, etc. that will be accessing their personalized Relay Feed. |
Getting Started
Prerequisites
Understanding of Relay Network
Familiarity with "The Feed" - Ensure a clear understanding of our software Relay's messaging platform, including its functionalities and capabilities.
Onboarding Process - Knowledge of the onboarding process and data requirements for users within the Relay Platform.
Messages and Triggering - Understanding of how messages are generated and triggered within "The Feed," including the events that initiate message notifications.
TCPA Consent - Awareness of the Telephone Consumer Protection Act (TCPA) regulations regarding consent for messaging communications.
CCID (Client Customer Identification) - Understanding of how customer contacts are identified and managed within Relay.
Understanding of Salesforce
General Salesforce CRM platform basics - Data structures, object relationships, and security models.
Installation of Packages - Ensure access to Salesforce Setup and Administrative privileges to install unlocked or managed packages. Knowledge of the installation process, including selecting the appropriate version of the Salesforce.com Integration Package and confirming compatibility with your Salesforce instance.
Security Configurations - Awareness of security considerations and best practices for integrating external systems with Salesforce, including securing API connections and data encryption. Understanding of OAuth authentication mechanisms and configuring connected apps for secure communication between Salesforce and our software platform.
User Permissions - Understanding of Salesforce user roles, profiles, and permission sets. Grant appropriate permissions to users who will be involved in configuring and using the Relay package, ensuring they have the necessary access rights to perform required actions.
Editing of Lightning Web Components (LWC) Pages - Knowledge of how to edit and customize LWC pages to tailor them to your organization's specific requirements.
Creating Flows - Understanding of Salesforce Flow Builder and its capabilities for automating business processes. Ability to create and manage flows within Salesforce, including configuring flow actions and integrating external services. Knowledge of how to incorporate Flow actions from the integration package into your custom flows to streamline data processing and workflow automation.
By ensuring that these prerequisites are met, you can effectively prepare your organization for the successful installation, configuration, and utilization of the Relay Network Salesforce.com Integration Package. Should you have any questions or require further clarification on any of these prerequisites, please reach out to our support team for assistance.