tyGraph & AvePoint logos

tyGraph Support has moved to the AvePoint Account Portal.

Learn more more about important next steps.

Support

Submit a ticket My Tickets Login
Welcome
Login

tyGraph Harvester Update 2022-02-23

TABLE OF CONTENTS

Overview


This article is intended to give detailed instructions on how to update the tyGraph harvester.

To perform the update, you will need the access to your tyGraph SQL Server and corresponding database, as well as your tyGraph Web App. 


Enable Access (if needed)


  1. Open your tyGraph SQL Server, and search for “firewall” to open the Firewalls and virtual networks panel.
  2. Add or update your IP address in the list of firewall rules, and press Save.
  3. Open the tyGraph App Service which hosts your tyGraph Webjob, search for “Networking”, and open the Networking panel.
  4. Click "Access restriction".
  5. Add a rule, set a priority (ie. 300) and enter your machine’s IP address.


Extract the Deployment Package


  1. Download the deployment package from the link provided by the tyGraph team.
  2. Right Click on deployment package ZIP file and select "Properties". If there is an option to "Unblock" the file, select it and hit Apply. IMPORTANT: Proceeding with a blocked ZIP file will prevent the package from extracting properly and can cause the update to fail.
  3. Extract the deployment package. It contains the new version of the Admin Console for tyGraph management and a new public certificate file (a CER file).

(Optional) Upload New Public Certificate


Note: Certificates should be rotated periodically in accordance with best practices. Make sure to upload new private certificates for each harvester after uploading a new public certificate.

  1. Open your list of App Registrations in the Azure Portal.
  2. Select "All Applications".
  3. Search for your tyGraph App Registration by name or ID and select it. Note: If you do not know the name of your App Registration, you can retrieve the ID from your tyGraph harvester database using the following query: SELECT AzureAppClientID FROM tgAppCore.EngineConfiguration
  4. Open the “Certificates and Secrets” panel.
  5. Click the “Upload Certificate” button.
  6. Click the browse button icon on the right-hand side.
  7. Select the .CER file from your installation package.
  8. The certificate will be installed in the App Registration.

Connect the Admin Console and Unschedule the Harvester


If you are updating multiple tyGraph instances, you will need to run through these steps for each tyGraph database in your tenant.

  1. Open the Admin Console folder and find the tyGraph365.AdminClientWinForm application.
  2. Run the application and enter your tyGraph connection details. Check the boxes if you want the application to remember your connection details. Select "Login Only (For Upgrades)" from the dropdown, and press Go.
  3. You may see an error if the Admin Console doesn't have sufficient permissions to save your connection details. This won't affect your ability to update, but you will need to re-enter your connection details each time you use the Admin Console.
  4. Click the "Remove scheduling" button.


Wait for existing harvest to finish


If you are deploying multiple tyGraph instances, you will need to run through these steps for each harvester database.

  1. Open a connection to your tyGraph harvester database using SSMS or another program capable of running SQL queries.
  2. Open the UpdateStatus.sql script located in the Diagnostic Scripts folder of your deployment package.
  3. Run the script to check the status of the harvester. Once the query displays “Ready to update”, you can move on to updating the database. Note: The harvester can run for a long time. You may have to check back over the course of several days.


Update the Database


If you are deploying multiple tyGraph instances, you will need to run through these steps for each harvester database.

Note: Do not proceed with this section until you have verified the harvester is ready to update as detailed in section 6.

  1. Return to the Admin Console and connect using the same settings as before.
  2. Open the “Manage Database” node and click “Database Updates”, then click the “Apply Updates” button.
  3. Wait for the console to show that all updates are applied. 
  4. Note: Once you have finished updating the database, all further connections to that database should be made using the "Retrieve Configuration" setting on the connection page.


(Optional) Upload A New Private Certificate


If you are deploying multiple tyGraph instances, you will need to run through these steps for each database.

IMPORTANT: You must follow the steps to upload a new public certificate before you can upload a new private certificate.

  1. Open the Configuration > Certificate section of the Admin Console, then click the Update tab.
  2. Click Browse and select the .PFX file included with the Admin Console.
  3. Click the Current tab and use the view button to access the current certificate password, then copy it.
  4. Move back to the Update tab, paste in the password, and click Load.
  5. Click Test to make sure the certificate is working, then click Apply to save the new private certificate.


Update the Webjobs and Reapply Scheduling


If you are deploying multiple tyGraph instances, you will need to run through these steps for each database.

  1. Expand the “Manage Harvester” node and click “Deploy Harvester”, then click the “Deploy Harvester” button. Note: The “Operation Group” dropdown will be automatically set to match your current configuration, so there is no need to change it.
  2. Click the “Deploy Monitoring Service” node. Check the checkboxes to enable tyGraph call-home monitoring and email notifications. Then click the “Deploy Monitor” button.
  3. Finally, click the “Schedule Harvester” node, check the “Enable scheduling” box, select a time for the harvester to run, and click the “Apply” button.


(Optional) Remove Old Certificates


Note: Do not proceed with this section until you have finished updating all tyGraph harvester instances in your tenant and make sure you have uploaded new private certificates for each.

  1. Return to the “Certificates and Secrets” panel of your App Registration.
  2. Remove any old tyGraph certificates.