Skip to Content

Upgrade Jitterbit App Builder on Microsoft Windows (x64)

Introduction

To upgrade App Builder on Microsoft Windows, follow these steps:

  1. Satisfy the [software requirements(/app-builder/documentation/hardware-requirements/) for both the [web server(/app-builder/documentation/hardware-requirements/#web-software-win) and [database server(/app-builder/documentation/hardware-requirements/#db-software).

  2. Get and unpack the software.

  3. Restore settings.

  4. Configure IIS.

  5. (Optional) Enable Crystal Reports.

  6. Test and run.

Note

The word Vinyl, used in parts of the following instructions, is the former name for App Builder.

Get and unpack the software

To get and unpack the software, follow these steps:

  1. Contact your Customer Success Manager (CSM) to get a copy of the App Builder 4.0 software.

    The software is provided as a compressed file with the name vinyl-X.Y.N-win.zip, where X.Y is the version number (for example, 4.0) and N is the build number (for example, 45678).

  2. Copy this file to a folder on the host where IIS runs.

  3. Depending on your system's security settings, you may need to unblock the file. To do this, right-click on the file, then select Properties. In the Properties dialog, select the Security tab, then select Unblock.

  4. Right-click on the vinyl-X.Y.N-win.zip file, and select Extract All.

  5. Set the extract destination to a temporary folder: C:\temp\Vinyl.

  6. Click the Extract button.

    Caution

    Do not continue until the extraction is complete. This can take many minutes.

Restore settings

To restore your settings, follow these steps:

  1. Stop IIS:

    1. Open Internet Information Services (IIS) Manager.

    2. Select the web server.

    3. Click the Stop button at the top right of the Actions pane.

  2. Make a backup copy of your databases.

  3. Move the current installation folder to a temporary location (for example, from C:\inetpub\wwwroot\Vinyl to C:\temp\OLD_Vinyl).

  4. Rename the new installation folder (for example, from C:\temp\Vinyl to C:\inetpub\wwwroot\Vinyl).

  5. Copy the following files from your old installation folder to your new one:

    Copy from To
    C:\temp\OLD_Vinyl\Connection.xml C:\inetpub\wwwroot\Vinyl\Connection.xml
    C:\temp\OLD_Vinyl\appsettings.json C:\inetpub\wwwroot\Vinyl\appsettings.json
    C:\temp\OLD_Vinyl\keys\* C:\inetpub\wwwroot\Vinyl\keys\

Configure IIS

To configure IIS after upgrading App Builder, follow these steps:

  1. Open Internet Information Services (IIS) Manager.

  2. Expand the Vinyl folder.

  3. Right click the data folder and choose the Edit Permissions option.

  4. Select the Security tab.

  5. Click the Edit button to launch the Permissions for data dialog box.

  6. Click the Add... button to launch the Select Users or Groups dialog box.

  7. Provide the name IIS AppPool\Vinyl in the bottom field.

  8. Check Allow Full Control in the Permissions field, then click the OK button to close the Permissions for data dialog box.

  9. Click the OK button to close the data Properties dialog box.

  10. Repeat steps 3-9 for the logs and keys directories as well.

  11. Restart IIS by selecting the server and clicking the Start button in the Actions pane.

(Optional) Enable Crystal Reports

App Builder supports Crystal Reports on Windows systems. Crystal Reports is hosted out-of-process in a COM server. To register the Crystal Reports COM server, open a Windows PowerShell as an administrator, then run these commands:

Set-ExecutionPolicy RemoteSigned
cd C:\inetpub\wwwroot\Vinyl\Scripts
.\RegisterCrystalReports.ps1

Test and run

To run App Builder after an upgrade, follow these steps:

  1. Go to http://localhost/Vinyl/.

  2. It can take several minutes to update the database. When the login screen appears, enter your administrator's credentials, then click the Sign In button.

  3. If necessary, upload and activate a new license file.