Skip to main content

Upgrade Guide (Windows Service)

CxSAST Reporting Service is a service delivered independently from CxSAST, giving you new features and improvements regularly and frequently. For each new version, you are able to upgrade the service and make use of the new features.

Upgrade Steps

Notice

Dependency Requirements:

The Authorization Setup Script must be executed prior to the Reporting Service version upgrade. The script installs the latest Access Control updates.

The guide can be found at CxSAST Reporting Authorization Setup.

Cx Reporting Service Manager

  1. Download the latest artifacts for CxSAST Reporting Service.

  2. Stop the CxReportingService service.

    StopServiceManager.png
  3. Extract zip contents and copy all binaries and folders from the unzipped Manager artifact except the appsettings.json file.

  4. Paste the files copied in the previous step into your CxSAST Reporting Service Manager installation folder and accept all the file replacements.

  5. Start the CxReportingService service again and validate that it is working properly by checking the newly generated logs.

Cx Reporting Service Client

  1. Stop the CxReportingClientAPI Website on IIS.

    ClientAPIwebsiteIIS.png
  2. Extract zip contents for the Client and copy all binaries and folders from the unzipped Client artifact except the appsettings.json file.

  3. Paste the files copied from the previous step into your CxSAST Reporting Service Client installation folder and accept all the file replacements.

  4. Start the Client API Website on IIS again and check the success of the operation by accessing the swagger in <ip or hostname>/swagger.

Cx Reporting Wizard

  1. Stop the CxReportingPortal Website on IIS.

  2. Extract zip contents of CxReportingPortal to C:\Checkmarx\CxReportingPortal

  3. Run the following configuration script auth-script.ps1 that is available in the installation folder where you placed the binaries, adjusting the parameters to your env:

    ./auth-script.ps1 -AccessControlAddress "http://localhost" -ReportingApiAddress "http://localhost:5555" 
  4. Start the CxReportingPortal Website on IIS again and check if the installation went accordingly by checking <ip>:<port> on the browser. This should open the application correctly. The user is redirected to the CxSAST authentication page.