How can I install and update QuickBooks using shell apps?

With the Shell Apps feature available in Nerdio Manager, you can script the install and uninstall of applications that were previously unscriptable. QuickBooks is a common use case, particularly during tax season when you may need to install or update QuickBooks on a weekly or sometimes daily basis.

Prerequisites

Before you install QuickBooks using Shell Apps, ensure you set up the following:

• Create a Shell Apps repository at the MSP level. For details, see Unified Application Management: Manage Shell Apps.

  Note: Currently, you can link only one Shell Apps repository per tenant.

• The QuickBooks shell app requires four inherited variables. These must be created at the MSP level before the shell app can be imported. For details, see MSP-level variables.

  Inherited variables limitations

  The following are the limitations of inherited variables.

  Variable names

  • 20-character limit

  • Alphanumeric characters are allowed

  • Hyphens - are allowed

  • Underscores _ are not allowed

  • Special characters and punctuation are not allowed (for example, ~!@#$%^&*()[]{},.<>/?\|`)

  Variable malues

  • Alphanumeric, special characters, punctuation, underscores, and hyphens are all allowed

  Note: If Inherited variables do not exist, you cannot import shell apps.

  The following four variables are required. All four are mandatory — the install and detection scripts will fail if any are missing.

  Variable Name	Format / Example	Description
  qbversionname	Premier, PremierSub, or Enterprise	The QuickBooks edition to install. Must be one of the three accepted values exactly as shown (case-sensitive).
  qbversionyear	22, 23, or 24	The two-digit year of the QuickBooks version to install.
  qblicensekey	XXXX-XXXX-XXXX-XXX	The QuickBooks license key in the format shown. Must be exactly 4-4-4-3 digits separated by hyphens.
  qbproductkey	XXX-XXX	The QuickBooks product key in the format shown. Must be exactly 3-3 digits separated by a hyphen.

  • The default functionality requires the qblicensekey and qbproductkey Inherited variables with the following default values:

    • qblicensekey = XXXX-XXXX-XXXX-XXX

    • qbproductkey = XXX-XXX

    The values can be a combination of different characters.

  • If you need to update multiple versions of QuickBooks, create a separate Inherited variable for each version. You can then update the shell app with the corresponding variable when you import the app. For example:

    • qblicensekeyent23

    • qbproductkeyent23

    • qblicensekeyprem22

    • qbproductkeyprem22

To add the QuickBooks shell app to your customer’s environment, complete the following steps:

• Step 1: Import the QuickBooks app to Nerdio Manager

• Step 2: Modify the shell app name and description

• Step 3: Modify the detection script

• Step 4: Modify the install script

• Step 5: Modify the uninstall script

• Step 6: Assign the shell app to an account

• Step 7: Set the account-level Inherited variable values

• Step 8: Schedule the deployment policies

Step 1: Import the QuickBooks app to Nerdio Manager

First, import the QuickBooks app from the Nerdio library.

To import QuickBooks:

1. At the MSP level, navigate to Applications > Shell Apps.

2. From the Add action menu, select Add from Nerdio Library.

   

3. In the new dialog box, from the Name drop-down menu, select Quickbooks.

4. Select OK.

   

   The Import QuickBooks dialog box opens.

Step 2: Modify the shell app name and description

If you need to install or uninstall multiple versions of QuickBooks, adjust the app name to reflect the version of QuickBooks this shell app should be used for.

To modify the shell app name:

1. In the Import QuickBooks dialog box, go to the General tab.

2. In the Name field, edit the app name to reflect the version of QuickBooks.

3. In the Description field, provide more details about the shell app.

4. Turn the Public option On.

   

Step 3: Modify the detection script

Next, you need to modify variables in the detection script to reflect the needed version of QuickBooks.

To modify the detection script:

1. In the Import QuickBooks dialog box, go to the Detection tab.

2. Modify the qb_version_name variable to reflect the needed version of QuickBooks.

   Note: Make sure you don't remove the double quotations marks.

3. Modify the qb_version_year variable to reflect the two-digit year of the needed version of QuickBooks.

   Note: Make sure you don't remove the double quotations marks.

   

Step 4: Modify the install script

Adjust the install script variables.

To modify the install script:

1. In the Import QuickBooks dialog box, go to the Install tab.

2. If you have multiple versions of QuickBooks, adjust the qblicensekey and qbproductkey variables to match the variables you created in the Prerequisites section.

3. Update the qb_version_name variable with the value you previously set on the Detection tab.

4. Update the qb_version_year variable with the value you previously set on the Detection tab.

   Tip: Right-click the value and select Change All Occurrences to update the value everywhere in the code. This option helps you prevent potential issues caused by missed updates. Alternatively, use Ctrl + H (Find and Replace) to update all instances of the value.

   

Step 5: Modify the uninstall script

Adjust the uninstall script variables.

To modify the uninstall script:

1. In the Import QuickBooks dialog box, go to the Unnstall tab.

2. If you have multiple versions of QuickBooks, adjust the qblicensekey and qbproductkey variables to match the variables you previously created in the Prerequisites section.

3. Update the qb_version_name variable to match the value you previously set on the Detection tab.

4. Update the qb_version_year variable to match the value you previously set on the Detection tab.

   Tip: Right-click the value and select Change All Occurrences to update the value everywhere in the code. This option helps you prevent potential issues caused by missed updates. Alternatively, use Ctrl + H (Find and Replace) to update all instances of the value.

5. Select Import.

   Note: If the Import button is disabled, do the following:

   • Ensure you have completed the necessary Prerequisites.

   • Scan your install script to ensure you don't have a typo in any of your Inherited variables.

   

Step 6: Assign the shell app to an account

After you have created the shell app, you’re ready to assign it to your account(s).

To assign the shell app to an account:

1. Navigate to Unified Catalog, and then search for QuickBooks.

   Tip: You can also filter apps by shell apps using the Repository dropdown.

2. Locate the app, and then from the Properties drop-down menu, select Assign.

   

3. Select Add Assignments, and then in the Select assignments field, select All or choose specific account(s) you want to assign the app to.

   

4. Select Confirm > Apply and close.

5. When prompted, select Confirm.

   

Step 7: Set the account-level Inherited variable values

Once you have imported the QuickBooks shell app and assigned it to the account(s), you can set it up for the account(s).

The first step is to set at the Account level the actual Inherited variables values that you previously created at the MSP level. For details, see Account-level variables.

Step 8: Schedule the deployment policies

After the QuickBooks shell app is assigned to the account(s), and you’ve created the variables, you’re ready to schedule the deployment of that shell app. For more information about creating the deployment policies, see Unified application management: Manage applications.

Update QuickBooks

Once QuickBooks is installed, it’s important to keep it up to date. You can automate this process as well using a scripted action.

For more details, contact your Partner Success Manager.