Setup and Run Admin Tools, Backup My Org, and Clean My Org

Owned by Blake Bilbo
Last updated: May 07, 2024 by Kenny Tran
5 min read

Please expand and review the following in-depth, illustrated guide to Admin Tools Enterprise. This section further expands on the Admin Tools 2.0 Enterprise Installation Instructions:

These steps only apply to ArcGIS Enterprise environments. Users with ArcGIS Online environments do not need to provide connector information or AppID information when using Admin Tools. This is ONLY necessary for installs that DO NOT use Integrated Windows Authentication (IWA).

Step-by-step guide

  1. From the "My Content" tab, select "Add Item” → “An application".

Step1.png

  1. Name the application "Admin Tools”.

Step2.png

  1. Navigate to the "Settings" Tab of the new Admin Tools application.

  1. In the "Application" Section, click the "Registered Info" button.

In some cases, an application URL is required in the “Data Source” field (shown in the image above). This can be any URL, so add your own, or simply add https://geo-jobe.com .

  1. The App ID is listed here (shown in image below). Providing this App ID will be necessary for the creation of your build. Next, click the "Update" button.

  1. Add the full URL of where admin tools will be running from (HTTP and/or HTTPS).

Domain Example

Please add the organization’s actual domain that will be running from Admin Tools to this Redirect URI. Ensure that '/' is not included at the end of your domain as this could potentially cause Admin Tools to unsuccessfully connect to the Redirect URI.

  1. Finally, select the "Update" button to save your changes.

Conclusion

You should now have the OAuth App ID and Redirect URIs necessary to start the Admin Tools Installation.

Please expand and review the following options to run Backup My Org or Clean My Org as HTTPS:

  1. Export the certificate from IIS:
    a. Open the IIS Manager
    b. Click on the server name in the "Connections" pane (located left-hand side) 
    c. In the middle pane, double-click on "Server Certificates"
    d. Select the certificate you want to export
    e. Click "Export" in the "Actions" pane (located on the right-hand side)
    f. Follow the wizard to export the certificate as a .pfx file (Note: remember the passphrase you specified to protect the cert)
    g. Export the PFX to the BackupMyOrg/CleanMyOrg main folder
    (Note: if you don’t have an export option you may need to re-import the certificate to IIS with the allow export option)

  2. Open the command prompt and navigate to the BackupMyOrg/CleanMyOrg directory and type:

    backupmyorg pfx <passphrase>

    OR

    cleanmyorg pfx <passphrase>

    (Note: This will save the passphrase as an encrypted string in the MongoDB database.)

  3. In the main application directory, edit the config/nodeconfig.json file and make the following modifications:
    Note: If you are using an absolute path in your nodeconfig.json file, be sure to use double backslashes, such as "C:\\BackupMyOrg\\Certificates\certificate.pem" or "C:\\CleanMyOrg\\Certificates\certificate.pem"

    "useHTTPS": true,  "certs": {     "certificate": "",     "key": "",     "pfx": "<name of your PFX file>"   },

  4. Restart your BackupMyOrg/CleanMyOrg server app or service, then load https://localhost:8500 or https://yourwebdomain:8500 (for BackupMyOrg) or https://localhost:8000 or https://yourwebdomain:8000 (for Clean My Org) in your browser.

  1. Both a certificate and key .pem file are required. (If you need to generate these, you can do so by downloading OpenSSL at https://slproweb.com/download/Win64OpenSSL_Light-3_2_0.msi)

  2. Open the command prompt in Windows

  3. Run the following commands to generate your private key and public certificate:

  1. Once you have the cert and key files, copy them to your BackupMyOrg or CleanMyOrg main folder

  2. Edit the config/nodeconfig.json file and make the following modifications:

  1. Restart your BackupMyOrg/CleanMyOrg server app or service, then load https://localhost:8500 or https://yourwebdomain:8500 (for BackupMyOrg) or https://localhost:8000 or https://yourwebdomain:8000 (for Clean My Org) in your browser.

To convert an IIS certificate to a .KEY and .PEM format for use in BackupMyOrg or CleanMyOrg, you can follow these steps:

  1. Export the certificate from IIS:
    a. Open the IIS Manager
    b. Click on the server name in the "Connections" pane (located left-hand side) 
    c. In the middle pane, double-click on "Server Certificates"
    d. Select the certificate you want to export
    e. Click "Export" in the "Actions" pane (located on the right-hand side)
    f. Follow the wizard to export the certificate as a .pfx file (remember the password you specified to protect the cert)
    (Note: if you don’t have an export option you may need to re-import the certificate to IIS with the allow export option)

  2. Convert the .pfx file to a .pem file using OpenSSL:
    a. Install OpenSSL on your computer if it is not already installed (Windows version can be found at: https://slproweb.com/products/Win32OpenSSL.html
    b. Copy the .pfx file to the OpenSSL /bin folder
    c. Open a command prompt or terminal window
    d. Navigate to the openSSL bin directory
    e. Run the following command (changing exported cert name as necessary):

This command will prompt you for the password you used to protect the .pfx file. Enter the password and press Enter. The command will create a .pem file in the same directory as the .pfx file.

  1. Extract the private key from the .pem file using OpenSSL:
    a. Run the following command in the same directory where the .pem file is saved:

This command will extract the private key from the .pem file and save it as a separate .key file in the same directory.

  1. Copy the .pem and .key to the application directory and configure config/nodeconfig.json
    a. Copy the new .pem and .key file to your application root directory
    b. Open <application directory>\config\nodeconfig.json
    c. Modify the settings as follows (changing names as necessary):

  1. Restart the BackupMyOrg/CleanMyOrg server and open the browser using https location.