Home > System Admin Role > Links & Integrations > xSage > xSage HRMS > xSQL Web API Connection

xSQL Web API Connection

Cyber Train and Sage HRMS can be connected so that when employees are hired, terminated or have a job change in Sage HRMS, Cyber Train will be updated with the information and the training profile can be adjusted.  With this option, there is an extra website set up where an SSL certificate needs to be installed because of the sensitive data going across. Take the following steps to set up this integration. 

Step 1: On the Web Server

Last Update to Web Service - October 2018

1. If Visibility Software hosts your Cyber Train system, you  may skip this step
   
2. If the software is on your network:

1. Download the CTAPI (http://www.vspublic.com/ctupdates/CT64/CTAPI.zip) and unzip it on the server where Cyber Train is installed.
2. Create an application in IIS named CTApi and browse to the files unzipped above
3. Create an application pool to which to connect the application. The settings of which you need to be aware are:
   1. .NET 2.0 should be used
   2. Identity should be Network Service
   3. Enable 32-bit applications
4. Verify that you can browse to the asmx page – ex: www.visibilitysoftware.com/CTApi/CTStudents.asmx  if you cannot browse to the asmx page you will not be able to transfer data properly.
   Note: you will get a 403 forbidden error if you browse just to the www.vspublic.com/CTApi. This is expected; errors when browsing the asmx files are not expected

Step 2:On the Sage HRMS Server​​

Last Update to Executable - October 2018

1. Create an empty folder (SagetoCT) on the Sage HRMS web server to hold the integration files 
2. Download and unzip http://www.vspublic.com/ctupdates/CT64/CTAbraRemote.zip and http://www.vspublic.com/ctupdates/CT64/CTAbraRemoteSetup.zip files linked here into that folder  
3. Right-click/Run As Administrator on CTAbraRemoteSetup.exe 

Step 3: Configuration Settings

The first tab is the basic configuration to connect the two system systems.

1. Sage Abra Data Type = SQL
2. CT Web Service = URL to the Cyber Train API
   1. If Visibility Software hosts your system please call our support line for this URL
   2. If the software is on your network, the URL endpoint would be determined by your IIS and DNS settings as established in Step 1.  
3. Authorization Code = Allows the Cyber Train web service to confirm the connection
   1. If Visibility Software hosts your system please call our support line for this code
   2. If the software is on your network, then this can be found by opening web.config file or the AppSettingsOverride.config file in the Cyber Train file structure.  It will be the 'value' found in the line which contains add key = "ConString"
4. Email Log To = Who should receive the log every day after it runs can be left blank if nobody should get it
5. SMTP Info = Required for the email to work (not necessary if you don’t fill in Email Log To)

 

​

Sage HRMS Data Tab
The second tab is where the information of the SQL Servers that holds the SageHRMS system is entered.

 

​

Synchronization Tab
The third tab indicates what information should be pulled into Cyber Train from SageHRMS.

Cyber Train Field                   Sage HRMS Field

Job Code                                  Job Title / Job Code

Organization Code 1                Organizational Level 1

Organization Code 2                Organizational Level 2

Organization Code 3                Organizational Level 3

Organization Code 4                Organizational Level 4

Organization Code 5                Organizational Level 5

​

1. Sync Job Codes and Sync Org Codes will update the codes from Sage HRMS to Cyber Train (NOTE: Don't forget to add requirements as needed to new codes)
   
2. Process Requirements: When checked, instructs the system to auto-add requirements for New Hires and Job Changes 
3. CT Login Field (if not using SSO from Sage ESS): Select the fields to make up the employee's login for Cyber Train.  The options to use are the student's Employee Number {Empno}; Company {Company}; First Name {FirstName}; First Initial {FirstInitial}; Middle Initial {MiddleInitial}; Last Name {LastName}; Last Initial {LastInitial}  (NOTE: When the CT Login Field is left blank, the program will treat the field like it is not being used so that if you want to use something different, you can do so. e.g. the Student's ESS login, which can be synchronized with our ESS utility.)

 

​

 Companies Tab

The fourth tab indicates what company in SageHRMS should be connecting with Cyber Train.  

1. Enter the 'Abra Company Code' on the left-hand side and then enter the 'Cyber Train Company Number' on the right-hand side. To locate the company code you will log into Cyber Train navigate to Admin > Codes > Companies. Click on the edit pencil for your company and note the SEQ=# in the URL– the number indicated is the company. In the screenshot below the company number is 8. 
   
   
   

Step 4: Creating the Task to Run

1. In Windows Scheduler, create a task to run CTAbraRemote.exe (this will be located in the folder where CTAbraRemote.zip was unzipped).
   1. The task should be able to run with highest privileges and should be set to run nightly. It should be able to run whether the user is logged in or not.
2. This step is key as without it the program will have to manually run to perform the update.

Troubleshooting

If you run into issues or errors, please reach out to support.

One error you may see is in the logs on the HRMS server that says: Registry Entries not valid. If you see this message double check that on the HRMS server both registry keys are in place and that they match in both locations:

HKLM > Software > Visibility Software > CTAbraRemote
HKLM > Software > Wow6432node > Visibility Software > CTAbraRemote

*to ensure that they match export the registry key and import 

Sage HRMS Info: 
Everything is driven by the P_ACTIVE field in SageHRMS.  So if an emloyee's P_ACTIVE field equals 'T', then in Cyber Train, the Employee is added as 'I' for Inactive.  If the employee is anything other than a 'T,' the employee is added as 'A' for Active in Cyber Train.  

If the checkbox for 'Sync Job Codes' is checked on the Sage HRMS side, then when a student is added to Cyber Train and the job code/job title is not currently in the Cyber Train Job Code Table, that job code/job title will be added in Cyber Train for that company. 

If the checkbox for 'Sync Org Codes' is checked on the Sage HRMS side, then when a student is added to Cyber Train and the org code/org title is not currently in the Cyber Train Organization Code Table, that org code/org title will be added in Cyber Train for that company.