Generic SQL Installs

REQUIREMENTS:

• The server must have .NET Framework 4.7.2 or greater.

• The server must be able to access the SQL database through the network.

• Credentials for user that has SQL access is required. 

• Credentials for admin user in SARA is required.

• Company IDs from ERP are required for the install

STEPS:

• The customer should have SQL views ready by the install call. These views can be created by our internal Engineering team or by the user's IT Team. They must follow the Schema guidelines or else you will encounter errors during the initial sync.

• On any machine, pull up my.anytimecollect.com and provide them their login info. 

• Once in the system, navigate to "Admin Setting & Utilities Sync Setup"

• Add a new sync record. Enter a description, comment (it is recommended to set the comment as the name of the SQL Server), and ERP system. The ERP system must be set to "Generic SQL." Insert the record, once finished. 

• Pull up the server they intend to install the sync on. When choosing a server, it is recommended to to pick one that will not be shut off during night times. If they are planning on doing File Location document support, it is also recommended to place the sync on the same server as their invoice documents, for simplicity.  

• In a browser, retrieve the sync files here and download onto the server. Once downloaded, unzip the files and run the installer. At the end of the install, it will request you enter a license key. The SARA Project Team can retrieve this information in the subscription maintenance system or the information can be found in SARA by selecting the character icon in the upper-right-hand corner of the screen and navigating to "My Profile."

• Enter the license key into the field then submit. The other fields can be left blank.

• This will create an AnytimeCollect folder in the C:\Program Files (x86) folder. Users can now search for the sync application by entering "Anytime Sync Launcher" into the Windows search bar. It is recommended to pin this to either the taskbar or desktop for easier use later. 

• Pull up the Anytime Sync Launcher. **NOTE** if the sync is not launching, the launcher does not have enough permissions. Give full permissions to the SARA folder in both the "C:\Program Files (x86)" folder. 

• Additionally, it may take over 30 seconds to launch initially. When launched, it creates a folder in the "C:\ProgramData" folder named "AnytimeCollect" and creates the logs folder that will be accessed later.

• Enter the user's SARA credentials into the window and select "Validate User". If correct, it will pull up the Generic SQL sync record you created back in step 4. 

• Select the Generic SQL sync record and launch the sync setup. 

• The sync install window will pull up. See below for required info:
  ​

• SQL Server - Machine name that hosts the SQL views.

• Trusted Connection - Uses Windows Authentication to log into the SQL Server. Will disable the Login and Password fields since you are opting to use Windows Authentication to access the views. 

• Login & Password - Credentials used to access the SQL Server. You should be able to use these exact credentials to manually log into the SQL Server. You can either enter a username and password or you can use Windows Authentication, you cannot use both. 

• Database - Name of the database where the SQL views are.  

• Companies to Import - These company ID's are pulled from the ERP system. These need to be separated with a pipe delimiter; no space required (i.e "ATC1|ATC2|ATC3|ATC4")

• Re-Initialize - This option should only be selected if you intend to run the sync everyday as a re-init. Discuss with Project Team if this is intended. Typically, this will remain unselected. 

• Entities To Sync - Controls what this sync will pull every time it runs. Typically, all will remain checked unless you need to split off a specific entity onto it's own sync. 

• Schedule/Run Option - Mark the "Schedule Task" option, then select for it to run either daily or weekly (daily runs everyday, weekly allows you to choose days of the week.) At the bottom, renter the password for the user currently logged into the server. The username is displayed directly above the password field. 

• Once you have all information entered, select the "Run Now" box and hit "OK."

•  A window will appear that will load in the options you chose in the setup. These settings will load in each time you open this sync. If you want to run a sync that only pulls a certain entity once or runs as a re-init once, this is where you would want to change that. Confirm all settings are correct and hit "Start Sync."

• If you encounter any issue during the sync process, the sync will notate to check the sync log. The sync log is located at "C:\ProgramData\AnytimeCollect\Logs" and will always be the most recent file in the folder. After 1 week, the date will be appended onto the end of the file name and a new file will be started. 

• Once the sync finishes successfully, check the data in SARA to make sure it displays correctly.
  ​