TABLE OF CONTENTS
- Azure Resources
- Enable Access to tyGraph Resources
- Running Queries With SSMS
- Using the Admin Console
- Running a Safe Revival
Azure Resources
First, familiarize yourself with the Azure resources that are used to host tyGraph. These can be found by opening the Azure Portal (https://portal.azure.com), and searching in the search bar for "tyGraph":
If you can't find any tyGraph resources this way, you likely don't have access to them, or they were named something else in order to comply with naming conventions for your organization. Either way, you will likely need the assistance of your Azure Tenant administrator to locate them.
Once you have found a tyGraph resource, you can use it to navigate to the Resource Group that holds the rest of the tyGraph resources. Resource Groups are containers in Azure that organize related resources, much like a folder organizes files on your computer. You can click the Resource Group link on any Azure resource to see the Resource Group that it is part of:
* It is possible that your Azure tenant admin has not organized your tyGraph resources into a single Resource Group. If this is the case, you will need their assistance to locate each one.
Once you have located all your tyGraph resources, you should have access to the following:
- An App Service, which hosts the tyGraph Harvester code
- An App Service Plan, which provides the pricing controls for the App Service
- A Language instance, which provides sentiment analysis functionality to tyGraph (this resource is optional, and may not be deployed for all solutions)
- A SQL Server, which holds the SQL database(s) used by tyGraph.
- One or more SQL databases, which hold tyGraph data.
In addition, if you have installed tyGraph Pages, you will see the following:
- An Application Insights instance, which ingests tyGraph Pages data
- A Log Analytics Workspace, which stores the tyGraph Pages data
Enable Access to tyGraph Resources
Before interacting with the tyGraph resources directly, you will need to add your IP address to the firewall. Follow the steps below to do this.
- Open your tyGraph Resource group in the Azure Portal and select the SQL Server.
- Search for "network", then open the Networking panel.
- Under "Firewall rules", click "Add your client IPv4 address (IP address)".
- Click the menu button, then click "Edit". Change the "Rule name" to "Admin Config". Copy the Start IP address for the next steps, and click "OK".
- Navigate back to your Resource group and click your tyGraph App Service.
- Search for "networking" and open the Networking panel.
- Click "Access restriction".
- Click "Add rule".
- Give the rule a name, a priority (ie. 300), and paste in the IP address you recorded above. Then click "Add rule".
Running Queries With SSMS
- Copy your SQL Server name from the Azure Portal
- Launch SSMS and connect to the server using the appropriate credentials for your solution. (If you do not know the credentials, you may need to contact an administrator for assistance.
- Expand the list of databases in the object explorer, right click on your tyGraph database, and select "New Query".
- Paste the query into the resulting window (or drag in a .sql file provided to you) and click the Execute button to get the results.
- If a CSV file export is requested, right click on the grid of results and select Save Results As..., then choose a name a location for the resulting CSV file export.
Using the Admin Console
- The tyGraph Admin Console is a small app that runs on your local machine (or sometimes a VM connected to a network associated with the tyGraph solution). If you don't have a copy, the tyGraph Ops team can provide a download link.
- The program can be run by launching the "tyGraph365.AdminClientWinform.exe" file in the Admin Console folder. It is the only file in the folder of the Application type.
- Once the console is launched, you can connect using the details for your SQL Server by pressing the Go button.
- Different sections of the console can be navigated to on the left side, allowing for management of different aspects of the harvester's operation and configuration.
Running a Safe Revival
- You may be asked to perform a revival of the tyGraph harvester in some instances where connectivity issues or minor errors have caused a stall. To perform a Safe Revival, connect to the tyGraph Admin Console, then navigate to the Manage Harvester > Trigger or Revive Harvester section.
- Once in this section, change the Start Mode dropdown to "Safe Revival Only", check the "Unsuspend harvesting if needed" checkbox, and hit the Trigger Harvester button.