Skip to content

groupdocs/GroupDocs.Salesforce-Demo

Repository files navigation

Salesforce App Deployment Guide

This guide provides step-by-step instructions to set up your Salesforce environment and deploy the GroupDocs Demo application from a Git repository.


✅ Prerequisites

Make sure the following tools are installed:


📥 Clone the Git Repository

git clone https://github.com/groupdocs/GroupDocs.Salesforce-Demo.git
cd <repo-name>

🛠️ Check Available Connections with Your Salesforce Organizations

Open the VS Code terminal to see the list of available organizations:

sfdx force:org:list

This command displays the list of connected Salesforce organizations linked to your account.
Pick the Salesforce organization you want to work with and copy its name from the Alias column.


🚀 Download and Deploy GroupDocs.Cloud SDK for APEX

Clone the GroupDocs.Comparison for APEX SDK into a separate folder:

git clone https://github.com/groupdocs-comparison-cloud/groupdocs-comparison-cloud-apex
cd <repo-name>

Open a new VS Code window for the folder with the downloaded GroupDocs.Cloud SDK.
Then open the terminal and run:

sf project deploy start --target-org Demo1Org --source-dir force-app --ignore-conflicts

Close the VS Code window if the deployment is successful.


🚀 Deploy Source to Your Salesforce Organization

Open a new VS Code window with the folder containing the source code of the GroupDocs.Salesforce Demo Application.

Open the terminal and run:

sf project deploy start --target-org SFOrganizationName --source-dir force-app --ignore-conflicts

🔐 Sign In to Your Salesforce Organization in VS Code

Check whether the bottom panel in VS Code displays the connected organization name from Step 1.
If not, look for the label [No Default Org set] in the blue status bar at the bottom of VS Code.
Click it and choose the required Salesforce organization from the dropdown.
A rectangular icon will appear next to the organization name, which serves as a link to sign in.


🚀 Deploy Source to Salesforce (Alternative)

Option A: VS Code

  • Right-click on the force-app folder → SFDX: Deploy Source to Org

Option B: Terminal

sfdx force:source:deploy -p force-app --targetusername demoOrg

🔐 Configure Salesforce Settings

  1. Go to Setup in Salesforce.
  2. Navigate to ProfilesSystem Administrator.
  3. Add the required Apex Classes and Visualforce Pages.
  4. Go to Custom Settings → e.g., GroupDocsCredentialsManage.
  5. Enter API credentials or other required values.

⚙️ Final App Configuration

  1. Open the App Launcher and locate your custom app.
  2. Launch it and verify everything loads correctly.
  3. Upload test documents or necessary metadata.

🧪 Test the Application

  • Run the main features and confirm expected behavior.
  • Use Developer Console to debug any issues.
  • Inspect network/API errors through browser tools.

💡 Optional Web Deploy (If Available)

If the repository supports web-based deployment:

https://deploy.salesforce.com/?repo=<your-repo-url>

⚠️ Possible Issues & Configuration Tips

1. Enable Enhanced Profile User Interface

Navigate to:

Setup → Administration → Users → User Management Settings

Ensure that the Enhanced Profile User Interface setting is enabled (set to true / yes / enabled).


2. Grant Access to Demo Application Components

Some pages in the Demo Application may not be accessible by default. You need to manually enable them:

  1. Go to:

    Setup → Users → Profiles
    
  2. Find and select System Administrator.

  3. Click Edit.

  4. Scroll to Custom Tab Settings.

  5. Locate the Compare tab and set it to Default On.

  6. Save changes.


3. Setup Personal GroupDocs Credentials

  1. In the Quick Find search bar, go to:

    Setup → Administer → Profile Overview
    
  2. Under Custom Settings Definition, click Edit.

  3. Move GroupDocs Credentials to the Enabled Custom Settings Definitions section.

Next:

  1. In the Quick Find bar, go to:

    Setup → Administer → Custom Code → Custom Settings
    
  2. Locate GroupDocs Credentials and click to Edit.

  3. Enter the credentials from your GroupDocs Cloud Dashboard.


4. Confirm Apex Class Access

  1. Go to:

    Setup → Users → Profiles → System Administrator
    
  2. Locate Apex Class Access.

  3. Ensure all SDK-related Apex classes are listed under Enabled Apex Classes.


© 2025 GroupDocs (Aspose). All rights reserved.

About

Document Management Salesforce Demo Application using GroupDocs.Cloud SDK for APEX

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •