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: docs/install.md
+25-3Lines changed: 25 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ permalink: /installation/
12
12
**OrgCheck** is a Salesforce application which can be installed on **any** Salesforce organization **very easily**. No additional infrastructure is required. No additional license. Simple as A.B.C.
13
13
14
14
15
-
## A) URLs for the installation
15
+
## Step 1: URLs for the installation
16
16
17
17
Go to one of the following URLs depending on the nature of the organization you want to install **OrgCheck**.
18
18
@@ -27,7 +27,7 @@ After selecting the previous URL, you were redirected to Salesforce servers.
27
27
If you were not yet authenticated, you will have to sign on using your credentials.
28
28
29
29
30
-
## B) Install the package
30
+
## Step 2: Install the package
31
31
32
32
Just like an AppExchange application you have to:
33
33
- Select the profiles -- we recommand to select **Admins Only**
@@ -38,7 +38,7 @@ For some orgs that have Apex class not compiling, you can install the package wi
Once installed, go to your org and assign your Salesforce user to the Permission Set called "OrgCheck Users".
44
44
@@ -58,3 +58,25 @@ We are also able to **push a new version** of the package in your org, to make s
58
58
We made the choice to use a specific **namespace** for this package, which is __OrgCheck__ of course, so that you can identify faster components of this package when browsing the metadata of your org (additionally to the naming convention).
59
59
60
60
Finally, the content of the application can be modified in your org (using the Salesforce Dev Console) in case you find a solution to a bug. Do not forget that every component of this package is under the MIT licence.
61
+
62
+
63
+
## Known issues
64
+
65
+
### I can't install the package because some Apex class are not compiling
66
+
- Our package does **NOT include ANY Apex class**.
67
+
- It is more likely a **existing Apex class** in the org you want to analyze that **does not compile** (it happens!).
68
+
- In that case, you can still install the package BUT you will have to specify during the installation process that you only want to validate the classes that are included in the package. This can be done via the **advanced setting when installing the app**.
69
+
70
+
### I can't see the OrgCheck application, even if I am SysAdmin and/or are assigned the OrgCheck Permission set
71
+
- The app is called "**OrgCheck**" obviously, maybe you spell it wrong?
72
+
- Double check that you are assigned to the **permission set** (just in case you missed that part).
73
+
- You should see the application definitly!
74
+
75
+
### I have the same error on EVERY tabs when the tool is accessing the API: INVALID_SESSION_ID: This session is not valid for use with the REST API
76
+
In case you have enabled the "**API Client Whitelisting**" feature, you will need to:
77
+
- Create another permission set (don't modify the OrgCheck permission because on the next release your setting will be overwritten).
78
+
- In this permission set, check the system permission called "**Use any API Client**" (which appears ONLY if you activate the "**API CLient Whitelisting**" feature -- that's why we can't add it to everybody).
79
+
- And assign your user to this additional permission set.
80
+
For more information, you can check that closed issue: https://github.com/VinceFINET/OrgCheck/issues/118
0 commit comments