You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/salesforce/README.md
+29-23Lines changed: 29 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,20 @@
1
-
# PSPDFKit for Salesforce Integration
1
+
> ⚠️ **Repository Moved**
2
+
> This repository has been moved to https://github.com/PSPDFKit/nutrient-web-examples/tree/main/examples/salesforce.
3
+
> Please update your bookmarks and issues accordingly.
4
+
>
5
+
> This repo is now archived and will no longer receive updates.
6
+
7
+
# Nutrient Salesforce SDK Integration
2
8
3
9
## Integrate into a New Salesforce Project as a Lightning Web Component
4
10
5
-
PSPDFKit for Salesforce enables you to open PDF, JPG, PNG, and TIFF files inside Salesforce. This unlocks the full functionality of PSPDFKit in Salesforce, including PDF generation, redaction, and signatures.
11
+
Nutrient Salesforce SDK enables you to open PDF, JPG, PNG, and TIFF files inside Salesforce. This unlocks the full functionality of Nutrient Web SDK in Salesforce, including PDF generation, redaction, and signatures.
6
12
7
-
This README explains how to integrate PSPDFKit into a new Salesforce project. The integration works as a [Lightning web component (LWC)][lwc] that you can add to any Salesforce organization.
13
+
This README explains how to integrate Nutrient Web SDK into a new Salesforce project. The integration works as a [Lightning web component (LWC)][lwc] that you can add to any Salesforce organization.
8
14
9
-
For more information on integrating PSPDFKit into an existing Salesforce project, see the [PSPDFKit for Salesforce documentation][salesforce docs].
15
+
For more information on integrating Nutrient Web SDK into an existing Salesforce project, see the [Nutrient Salesforce SDK documentation][salesforce docs].
10
16
11
-
PSPDFKit for Salesforce shares the same APIs as Nutrient Web SDK Standalone. For more information on customizing your Salesforce application, see the [Nutrient Web SDK Standalone documentation][web docs].
17
+
Nutrient Salesforce SDK shares the same APIs as Nutrient Web SDK Standalone. For more information on customizing your Salesforce application, see the [Nutrient Web SDK Standalone documentation][web docs].
12
18
13
19
## Requirements
14
20
@@ -21,17 +27,17 @@ Before continuing, perform all of the following actions:
21
27
22
28
## Deploying the Package
23
29
24
-
To deploy the PSPDFKit package to your Salesforce organization, follow these steps.
30
+
To deploy the Nutrient Web SDK package to your Salesforce organization, follow these steps.
25
31
26
-
1. Download the [PSPDFKit for Salesforce project][zip] from GitHub, and then unpack the ZIP file.
32
+
1. Download the [Nutrient Salesforce SDK project][zip] from GitHub, and then unpack the ZIP file.
27
33
28
-
Alternatively, run the following terminal command to clone the [PSPDFKit for Salesforce repository][repo] from GitHub:
34
+
Alternatively, run the following terminal command to clone the [Nutrient Salesforce SDK repository][repo] from GitHub:
2. In the terminal, go to the PSPDFKit for Salesforce project folder and run the following command to install the PSPDFKit npm module.
40
+
2. In the terminal, go to the Nutrient Salesforce SDK project folder and run the following command to install the Nutrient Web SDK npm module.
35
41
36
42
Use the following code for npm:
37
43
@@ -45,15 +51,15 @@ To deploy the PSPDFKit package to your Salesforce organization, follow these ste
45
51
yarn install
46
52
```
47
53
48
-
3. The PSPDFKit for Salesforce integration example now makes use of the PSPDFKit version available from our CDN at https://cdn.cloud.pspdfkit.com/pspdfkit-web, which means it's no longer limited by Salesforce's upload assets size 5MB limit.
54
+
3. The Nutrient Salesforce SDK integration example now makes use of the Nutrient Web SDK version available from our CDN at https://cdn.cloud.pspdfkit.com/pspdfkit-web, which means it's no longer limited by Salesforce's upload assets size 5MB limit.
49
55
50
-
In order to set the PSPDFKit version you want to use, open `./force-app/main/default/pages/PSPDFKit_InitPSPDFKit.page` and edit the line 7 to reflect the PSPDFKit version. For example, in order to use version 2024.4.0, you should change the URL pointing to the CDN to:
56
+
In order to set the Nutrient Web SDK version you want to use, open `./force-app/main/default/pages/Nutrient_InitNutrient.page` and edit the line 7 to reflect the Nutrient Web SDK version. For example, in order to use version 1.0.0, you should change the URL pointing to the CDN to:
You can find the latest version of Nutrient Web SDK in the [PSPDFKit changelog](https://www.nutrient.io/changelog/web/).
62
+
You can find the latest version of Nutrient Web SDK in the [Nutrient Web SDK changelog](https://www.nutrient.io/changelog/web/).
57
63
58
64
4. Run the following command in the terminal to start the Salesforce authentication process:
59
65
@@ -63,47 +69,47 @@ In order to set the PSPDFKit version you want to use, open `./force-app/main/def
63
69
64
70
5. In the browser window that opens, log in to your Salesforce organization and authorize the Salesforce CLI.
65
71
66
-
6. In the terminal, run the following command from the PSPDFKit for Salesforce project’s root folder:
72
+
6. In the terminal, run the following command from the Nutrient Salesforce SDK project’s root folder:
67
73
68
74
```bash
69
75
sfdx force:source:deploy -x manifest/package.xml
70
76
```
71
77
72
-
## Enabling Users to Use PSPDFKit
78
+
## Enabling Users to Use Nutrient Web SDK
73
79
74
-
To enable users of your Salesforce organization to use PSPDFKit, follow these steps.
80
+
To enable users of your Salesforce organization to use Nutrient Web SDK, follow these steps.
75
81
76
82
1. In Salesforce, go to **Users** > **Permission Sets**.
77
83
78
-
2. Find **PSPDFKit Admin Access** in the list and click it.
84
+
2. Find **Nutrient Admin Access** in the list and click it.
79
85
80
86
3. Click **Manage Assignments**.
81
87
82
88
4. Click **Add Assignment**.
83
89
84
-
5. Select the users you want to authorize to use PSPDFKit.
90
+
5. Select the users you want to authorize to use Nutrient.
85
91
86
92
6. Click **Next**, and then click **Assign**.
87
93
88
94
## Changing the Security Settings
89
95
90
-
PSPDFKit for Salesforce requires Lightning Locker to protect Lightning web components, but Salesforce uses Lightning Web Security by default. To change the default security settings, follow these steps.
96
+
Nutrient Salesforce SDK requires Lightning Locker to protect Lightning web components, but Salesforce uses Lightning Web Security by default. To change the default security settings, follow these steps.
91
97
92
98
1. In Salesforce, go to **Security** > **Session Settings**.
93
99
94
100
2. Deselect **Use Lightning Web Security for Lightning web components**.
95
101
96
102
3. Scroll down and click **Save**.
97
103
98
-
## Using the PSPDFKit for Salesforce Integration
104
+
## Using the Nutrient Salesforce SDK Integration
99
105
100
-
To use PSPDFKit in your Salesforce organization, follow these steps.
106
+
To use Nutrient Web SDK in your Salesforce organization, follow these steps.
101
107
102
-
1. Ensure you’re logged in as a user authorized to use PSPDFKit.
108
+
1. Ensure you’re logged in as a user authorized to use Nutrient Web SDK.
103
109
104
110
2. In the top-right corner, open the App Launcher.
105
111
106
-
3. Search for and select **PSPDFKit**.
112
+
3. Search for and select **Nutrient**.
107
113
108
114
4. Click **browse** to upload local PDF files, or open a file from Salesforce.
0 commit comments