Administration

How to Scan for, Create, and Edit Environments

Scanning for Environments and Creating Environments via the Scanner

  1. Login to the machine on which the CRSPSift Administrator Tool software resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    NOTE: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  3. Click on the Environment Scanner option on the left menu panel.

  1. Add any folder hint paths if the databases have been locally installed on the server at a different location. The hint paths direct the scanner where to scan for CRSP databases. If your databases reside in a path not shown in the Folder Hint Paths you will want to add that path. To do so, click the down arrow to the left of Scan Folder Hint Paths.
  2. You may also perform a one-off scan of a specific directory or directories by using the Scan Specific Location option. To do so, click the down arrow to the left of “Scan Specific Location.”
  3. If you want to scan for CRSP databases in subdirectories of the paths you have specified, check the Scan Subdirectories option.
  4. Click the Start Scan button to begin scanning for directories based on the checked scan options.

  1. If any valid Environments, that are not already added, are discovered in the scan they will appear in the New Environments Found data grid.
  2. At this point it is possible to edit the environment before it is added to the Environments List. If you wish to edit an Environment before adding it, select that Environment and click the Edit button, then proceed to Step 6 of the next section titled “Editing Environments”.
  3. Check the Load checkbox next to each Environment you wish to add.
  4. Click the Add button to add the selected environment(s).

Editing Environments

  1. Login to the machine on which the CRSPSift Administrator Tool software resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    NOTE: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  3. If you are not already on the Environments screen, select the Environments option on the left menu panel.
  4. In the data grid view select the Environment you wish to edit.
  5. Select Edit Environment from the dropdown under the data grid view and click the Perform Action button.

  1. On this screen you may customize the environment by changing the Name, Set as Default (if not already) property, choose a Stock, COMPUSTAT and/or Treasuries database, and set the working directory for the environment. The working directory is where the Sift Enterprise Client will initially prompt users to save their Sift Enterprise files on the client computer such as queries, query results and input. The user must have rights to create files at this location on their computer. The user may change this location to anywhere they have create rights when saving files.
  2. Once you are satisfied with the changes click the Apply button to save the changes. If you are not satisfied with the changes you may click the cancel button to undo the changes to the environment.

Creating Environments

  1. Login to the machine on which the CRSPSift Administrator Tool Software resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    NOTE: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  3. If you are not already on the Environments screen, select the Environments option on the left menu panel.

  1. Select Load Environment from the dropdown and click the Perform Action button.
  2. Type a nickname for the Environment in the Environment Name textbox.
  3. Type the path for the Working Directory or select the Browse for more locations… option from the dropdown and navigate to the directory for the Environment.
  4. The working directory is where the Sift Enterprise Client will initially prompt users to save query, query results, and input files. The user must have rights to create files at this location on their computer. The user may change this location to anywhere they have create rights when saving files.
  5. If you wish to make the environment the default environment, check the Default Environment checkbox.
  6. Select a Stock Database for the Environment. If the environments you wish to add are not displayed go to the Environment Scanner, run an environment scan and the results from the scan will display when you come back to Create Environment. Note: It may be easier to simply create the new environment from the Environment Scanner.
  7. If desired, a Compustat database and/or a Treasury database may also be selected for the Environment.
  8. Click the Apply button to save the new Environment.

How to Change SMTP Settings Enterprise Edition (Post Installation)

  1. Login to the computer on which CRSPSift Administrator Tool resides.
  2. Launch the SIFT Administrator Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  3. Click on the SMTP Settings option in the menu.
  4. Type the name of the server hosting your email services into the Host Server text box.
  5. Type the email service port (usually port 25) into the port text box.
  6. Type in an email address which will be used to send the email from Sift Enterprise. (e.g. SIFT_Admin@mycompany.com)
  7. Next choose the Authentication Credentials for this connection. If your email server does not require authentication, select the Anonymous option. Otherwise, select the option next to This Account: and provide the account name and password needed to connect to your email server.
  8. Press the Save button to save the changes to the SIFT database.

How to Manage the Query Queue

Navigating to Query Queue Management Screen

  1. Login to the computer on which the CRSPSift Administrator Tool resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu -> All Programs -> CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    NOTE: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe.
  3. Click the Query Queue option on the left menu panel.

Query Queue Management Options

Search Options

These options are used to filter the batches that are displayed in the data grid. It is possible to filter by batch owner, batch status, schedule date, start date, and end date of batches.

Query Queue Actions

At the bottom left side of the Query Queue screen is a drop down list of actions that may be performed on the selected batch or batches displayed in the batch data grid view. Actions are not performed until the Perform Action button has been pressed. These actions are:

  • View Batch Details This action opens the batch details screen for a specified batch.
  • Delete Batch This action permanently deletes the batch.
  • Cancel Batch This stops a running batch and marks it as cancelled.
  • Rerun Batch This action reruns a specified batch.
  • Delete All Batches This action permanently deletes all batches.

How to Restart the Manager Service and Query Engine Service
(Without Rebooting the Server)

Restarting the Manager Service
  1. Login to the computer on which the Manager Service resides.
  2. Go to the Start Menu and right click on My Computer.
  3. In the Right Click Menu select Manage.
  4. In the left panel tree view under Computer Management expand the Services and Applications node.
  5. In the left panel tree view under Services and Applications select Services.


  1. In the right detailed list panel locate the item marked CRSPSift Query Manager.
  2. Right click CRSPSift Query Manager and select Restart.
Restarting the Query Engine Service
  1. Login to the computer on which the Query Engine Service resides.
  2. Go to the Start Menu and right click on My Computer.
  3. In the Right Click Menu select Manage.
  4. In the left panel tree view under Computer Management expand the Services and Applications node.
  5. In the left panel tree view under Services and Applications select Services.

  1. In the right detailed list panel locate the item marked CRSPSift Query Engine.
  2. Right click CRSPSift Query Engine and select Restart.

How to Change the Account Running the Manager Service

The Sift Enterprise install sets all Sift Enterprise Service to run under the Local System Account. If you need to change this account due to your organization’s standards, make sure this account has rights to your Sift SQL Databases (SIFTExpress and SiftResources) as well as the Temporary File Folder.

  1. Login to the computer on which the Manager Service resides.
  2. Go to the Start Menu and right click on My Computer and choose the Manage option.
  3. In the left panel tree view under Computer Management expand the Services and Applications node.
  4. In the left panel tree view under Services and Applications select Services.
  5. In the right detailed list panel locate the item marked CRSPSift Query Manager.
  6. Right click CRSPSift Query Manager and select Properties.
  7. Navigate to the Log On tab.
  8. To change from Local System Account to another specified account select the radio button This Account.
  9. In the text box to the right of This Account type the domain\username of the account.
  10. Replace the text in the Password textbox with the account’s password.
  11. Replace the text in the Confirm Password textbox with the account’s password.
  12. Click the Apply button on the form and Okay on the notification stating the change will not take effect until the service is restarted.
  13. Click the Okay button.
  14. Right click the CRSPSift Query Manager and select Restart.

How to Change the Account Running the Query Engine Service

The Sift Enterprise install sets all Sift Enterprise Service to run under the Local System Account. If you need to change this account due to your organization’s standards, make sure this account has rights to your Sift Temporary File Folder.

  1. Login to the computer on which the CRSPSift Administrator Tool resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    NOTE: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe.
  3. Click on the Services option in the menu.
  4. Click the Change Account button on the Query Engine connection you wish to change.
  5. Select Custom Account.
  6. Type the domain\username of the account in the Account Username text box.
  7. Type the account’s password in the Account Password text box.
  8. Type the account’s password again in the Repeat Account Password text box.
  9. Press the OK button to save the changes to the database.

How to Change the Enterprise Client’s Default Server (Post Installation)

You may want to change the server hosting Sift Enterprise possibly to move to a server with more power. If you change the server hosting Sift Enterprise you do not have to uninstall and reinstall each of your clients. However, you do need to change the configuration file for each client to point to the new server.

  1. Login to the computer on which the Enterprise Client resides.
  2. Navigate to the directory at which the Enterprise Client is installed. If it was installed in the default location it would be located at C:\Program Files\CRSP\CRSPSift 4.3.6 Enterprise Edition \bin.
  3. Open the file marked as SiftWPF.exe.config.
    • If the file is not associated with an application for opening it, Windows will prompt you to specify an application with which to open.
    • Choose "Select the program from a list" and click OK
    • Select Notepad or your preferred text editor from the list of programs and click OK.

<client>
<endpoint address=”net.tcp://ServerName:9001/SiftClientService binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.SiftClientContract” name=”Default_Service” />
<endpoint address=”net.tcp://ServerName:9001/CrspResourceService” binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.Resources.CrspResourceContract” name=”Default_Resource” />
<endpoint address=”net.tcp://ServerName:9001/SiftAdminService” binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.Admin.SiftAdminContract” name=”Default_Admin” />
<endpoint address=”net.tcp://ServerName:9001/CrspEScanService” binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.EnvScanner.CrspEScanContract” name=”Default_Crsp_EScan” />
<endpoint address=”net.tcp://ServerName:9003/CrspStreamStream” binding=”netTcpBinding” bindingConfiguration=”TcpStreamBinding” contract=”SiftComponents.Communications.Client.Stream.CrspStreamContract” name=”Default_Stream” />
</client>

  1. Find the Client Endpoint Nodes as seen above
  2. In the address field replace the Server Name with the New Enterprise Server Name for the Enterprise Client. The result would look something like this:
     

<client>
<endpoint address=”net.tcp://NewEnterpriseServerName:9001/SiftClientService binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.SiftClientContract” name=”Default_Service” />
<endpoint address=”net.tcp://NewEnterpriseServerName:9001/CrspResourceService” binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.Resources.CrspResourceContract” name=”Default_Resource” /><endpoint address=”net.tcp://NewEnterpriseServerName:9001/SiftAdminService” binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.Admin.SiftAdminContract” name=”Default_Admin” /><endpoint address=”net.tcp://NewEnterpriseServerName:9001/CrspEScanService” binding=”netTcpBinding” bindingConfiguration=”TcpBinding1” contract=”SiftComponents.Communications.Client.EnvScanner.CrspEScanContract” name=”Default_Crsp_EScan” /><endpoint address=”net.tcp://NewEnterpriseServerName:9003/CrspStreamStream” binding=”netTcpBinding” bindingConfiguration=”TcpStreamBinding” contract=”SiftComponents.Communications.Client.Stream.CrspStreamContract” name=”Default_Stream” />
</client>

Note: If the New Enterprise Server is using ports other than 9001 and 9003 for the SiftClientService and the CrspClientStream they will also need to be changed to match the New Enterprise Server ports.

 

  1. Save the configuration file.
  2. Close the text editor.
  3. If Sift is currently open on the machine the application must be restarted for the port changes to take effect.

How to Change SIFT Enterprise Ports

You may need to change the ports Sift Enterprise uses to communicate to its components because other applications installed in your environment use these same ports. When changing ports make sure you change the ports for both the Query Manager and Query Engine as well as for each Sift Enterprise Client.

If you need to change ports please contact CRSP support at 312-263-6400 option # 2. There are quite a few configuration files you will need to change.

How to Change the Location of Temporary Files in the Manager Service

The temporary file location in the Manager Service is the location where the Query Engine Service writes the query output files. The files reside in the temporary file location until the SIFT Client requests the output file to be transferred from the Manager Service to the Client location. Once the file transfer is complete, the file is removed from the temporary location. Upon installation of the Manager Service the temporary file location is set to “default” in the Manager Service configuration file, which corresponds to “%AllUsersProfile%\Application Data\SQE” on the machine running the Manager Service. This location can be changed with a few easy steps.

Steps to change the location of temporary files in the Manager Service
  1. Login to the computer on which the Manager Service resides.
  2. Navigate to the directory at which the Manager Service is installed. If it was installed in the default location it would be located at c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin.
  3. Open the file marked as SiftQueryManager.exe.config.
    • If the file is not associated with an application for opening it, Windows will prompt you to specify an application with which to open.
    • Choose “Select the program from a list” and click OK.
    • Select Notepad or your preferred text Editor from the list of programs and click OK.
  4. Find the <add key “WorkingDirectory” value=”default” /> line within the <appSettings> XML tags. This line is typically located on the 5th line down from the top.
    <appSettings>
    <add key=”AppConnStr” value=”Data Source=|DataDirectory|\SiftExpress.vdb4;Open Mode=NonexclusiveReadWrite” />
    <add key=”ResourcesConnStr” value=”Data Source=|DataDirectory|\SiftResources.vdb4;Open Mode=NonexclusiveReadWrite” />
    <add key=”WorkingDirectory” value=”default” />
    <add key=”ClientSettingsProvider.ServiceUri” value=”” />
    <add key=”SiftVersion” value=”CRSPSift 4.3.6 Enterprise Server” />
    <add key=”DisableMUT” value=”false” />
    <add key=”DisableRIN” value=”false” />
    </appSettings>
     
  5. On the same line find the term value=”default”.
  6. Place full file path location for the temporary files with in the quotes. (e.g. value=”E:\CRSPOutput”)

    <appSettings>
    <add key=”AppConnStr” value=”Data Source=|DataDirectory|\SiftExpress.vdb4;Open Mode=NonexclusiveReadWrite” />
    <add key=”ResourcesConnStr” value=”Data Source=|DataDirectory|\SiftResources.vdb4;Open Mode=NonexclusiveReadWrite” />
    <add key=”WorkingDirectory” value=”E:\CRSPOutput” />
    <add key=”ClientSettingsProvider.ServiceUri” value=”” />
    <add key=”SiftVersion” value=”CRSPSift 4.3.6 Enterprise Server” />
    <add key=”DisableMUT” value=”false” />
    <add key=”DisableRIN” value=”false” />
    </appSettings>
     
  7. Save the configuration file.
  8. Close the text editor.
  9. Restart the Manager Service for the change to take effect. (See the “How to Restart the Query Engine and Manager Services” section of this document.)
    Note: The Query Engine Service must have the ability to write files to the temporary file location. Also, the Manager Service must have the ability to read and delete files from the temporary file location.
    Note: Be sure to preserve the quotes on either end of the file path entered for the value property or this will cause the program to crash.

How to Change the Number of Threads for Query Engine

  1. The number of threads Query Engine equates to the number of simultaneous queries Query Engine executes. The install program sets this to 15. You may want to adjust this up to 25 if you are running on a powerful server to increase performance. You may also want to adjust this down if running on a very small server and experiencing lockups. If after adjusting, you do not realize expected results CRSP suggests the setting be changed back to 15.
  2. Navigate to the directory at which the Query Engine is installed. If it was installed in the default location it would be located at c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin
  3. Open the file marked as SiftQueryEngine.exe.config.
    • If the file is not associated with an application for opening it, Windows will prompt you to specify an application with which to open it.
    • Choose “Select the program from a list” and click OK.
    • Select Notepad or your preferred text editor from the list of programs and click OK.
      <appSettings>
           <add key=”numThreads” value=”15”/>
      </appSettings>
  4. Find the <add key=”numThreads” value = “15” /> as seen above.
  5. Change the value from 15 to desired value. In the below example it is being changed to 25:
    <appSettings>
         <add key=”numThreads” value=”25”/>
    </appSettings>
  6. Save the configuration file.
  7. Close the text editor.
  8. Restart the Query Engine for the changes to take effect. (See the “How to Restart the Query Engine and Manager Services” section of this document.)

Other Admin Tool Functions

The Administrator Tool has several functions intended for management of the future scalable (multi Query Engine) environment. These functions are briefly discussed here.

Services

 

The Services function allows you to view the components active in your Sift Enterprise environment. It will display the ports and server each component is running from.

  1. Login to the computer on which the CRSPSift Administrator Tool resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    NOTE: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  3. Click the Services option on the left menu panel.

Usage

The Usage function allows you to view some usage statistics from your Sift Enterprise environment.

  1. Login to the computer on which the CRSPSift Administrator Tool resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
  3. Note: Alternatively, you can open a Windows Explorer and navigate to the c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  4. Click the Usage option on the left menu panel.

Users

The User function allows you to view who has logged into your Sift Enterprise environment.

  1. Login to the computer on which the CRSPSift Administrator Tool resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
  3. Note: Alternatively, you can open a Windows Explorer and navigate to the c:\program files\CRSP\ CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe.
  4. Click the Users option on the left menu panel.

Options

The Options function allows you to do two things:

  • Change the Default Working Directory for all newly defined environments .
  • Import/Export/Clear Favorites associated with Query Tool Products.
  1. Login to the computer on which the CRSPSift Administrator Tool resides.
  2. Launch the SIFT Admin Tool by going to the Start Menu > All Programs > CRSPSift 4.3.6 and clicking on the CRSPSift Administrator Tool.
    Note: Alternatively, you can open a Windows Explorer and navigate to the  c:\Program Files (x86)\CRSP\CRSPSift 4.3.6 Enterprise Server\bin directory and run the SiftAdminTool.exe
  3. Click the Options option on the left menu panel.

The Default Working Directory for each environment defines where queries and results will be Stored on the client machines for that environment as a default. The user can change this directory when saving queries or results. See section “How to Scan for, Create, and Edit Environments” for more information on the “Working Directory” and how to modify it for a specific environment.

The Favorites section allows you to Import/Export/Clear All favorites from the database. These favorites relate to TsQuery, StkQuery, CcmQuery or TrsQuery queries and can be added from the Data Items section of those tools. A sample screen shot of StkQuery’s Data Items screen with a Favorite selected is shown below: