Troubleshooting RM Unify MIS Sync with the Groupcall Xporter
Published Date : 04 Jun 2015
Last Updated : 04 Oct 2024
Content Ref: TEC4563800
Operating System
(none)
Part No
(none)
Summary
Details some data validation requirements and troubleshooting tips for the Groupcall Xporter used for RM Unify MIS Sync.
Symptoms
Groupcall Xporter - 'Useful Links' document
Groupcall Support have put together a whole document which is full of links that you might find useful when troubleshooting issues with Xporter. It can be accessed here.
Expand the Xporter Platform node for more granular status information.
What are the data validation requirements for users in MIS to be extracted?
This is a quick validation guide for what is required for successful extraction of user data via Groupcall Xporter.
General
All names must be alphanumeric and no more than 50 characters long.
The system should be set up with a current year.
Students For all students, check that:
They have a UPN.
They have a legal forename.
They have a legal surname and preferred surname, even if the same as legal surname.
They have a date of birth entered.
They have a relevant year group allocated.
They have a gender.
They are registered in a registration group.
They have an Enrolment Status in SIMS of Current Single Registration, Main - Dual Registration or Subsidiary - Dual Registration. Note: Guest Pupil status is not supported. A pupil who attends another school as part of a regular pattern, ordinarily, is dual registered.
Staff For each staff member, check that:
There is a Title, Forename and Surname in the Staff Details section.
Their Employment Start date is set to today, or a date in the past
A Staff Code in the Employment Details section, although this is not always required.
They are current.
Their leaving date is blank or in the future.
Note: In Capita SIMS, Groupcall Xporter uses the 'Teaching Staff' box in a staff member's MIS record to differentiate teaching staff from non-teaching staff. Please ensure you have this box ticked if you would like your staff member identified as a teacher in RM Unify, as opposed to a non-teacher.
What will cause a user's data to end up in the rejects log?
The following data conditions will result in MIS records being rejected to the ErrorLog.xml, located in C:\Program Files (x86)\Groupcall\Xporter\RM\Unify\Files: Students
Records with duplicate student id.
Students with missing UPN.
Students with duplicate UPN.
Records with missing forename.
Records with missing surname.
Records with missing year group.
Records with missing gender.
Parents
Records with duplicate id.
Records with missing forename.
Records with missing surname.
Records with missing gender
Staff
Records with duplicate id.
Records with missing name.
Records with missing type.
Classes
Classes with missing staff.
Procedure
Groupcall Xporter misc info
The software installs on your network. Either on the MIS server (for SIMS on-premises), or another computer/domain controller for one of the other cloud-hosted MISs.
The Groupcall Xporter service is set to Automatic and runs as the Local System account.
As there is no local database to check for data or data issues, the best way to check for data is to search in the XML files which are stored in %Program Files (x86)%\Groupcall\Xporter\RM\Unify\Files.
The XML files are created after each extract and uploaded to the RM Unify datacentre. If a user is not in an XML file they have not been extracted, so it would be advised to check the user's data in the MIS.
Checks
Confirm connectivity between Xporter and RM Unify
Connectivity between Xporter and the RM Unify datacentre is simply via https (port 443).
If the page returns "403 - Forbidden: Access Denied" message, this is the expected behaviour and confirms a connection has been made successfully.
Check anti-virus software if there are issues installing the software
As with any software installation, if you have issues installing, you should consider temporarily disabling any anti-virus software running on the server or computer. Once Xporter has been installed and has completed the first full run (extract) of the RMUnify-Data job, it can be re-enabled to test for, or diagnose, any further issues.
Run a full resync of MIS data to RM Unify from Groupcall Xporter
Open the Xporter Management Console. This will be a shortcut on the desktop of the computer where it is installed and is usually your MIS server, but may be another server or desktop PC. Alternatively, click Start, Programs, Groupcall, Xporter.
Select Jobs.
Right-click RMUnify-Data job and select Reset Changes.
Click Yes to the confirmation message.
Monitor the Log file (in the left-hand pane) for the two events - Deleting Change Logs and 'Change Logs deleted'. This indicates that Reset Changes has completed.
Select Jobs.
Right-click RMUnify-Data and select Run Job Now. The status column value will change from Idle to Running.
A full resync of the MIS data will now begin.
When the status column value returns to Idle, the job has finished.
Check the RM Unify Management Console for the expected data.
Where Jobs are shown as Failed in the Xporter Management Console, query the logs for further information.
To query the logs:
Open Xporter Management Console.
Expand Log.
Select RMUnify-Data.
Review the logs entries for errors.
Possible Issues
Common errors and issues
Error
Cause and resolution
"There was no endpoint listening at https://api.platform.rmunify.com/unifyprovisioning/IdentityProvider.svc that could accept the message".
These errors are most commonly caused by incorrect proxy server settings within the Misc section of the Xporter Management Console, or by the Groupcall Xporter being blocked by the specified proxy server.
Resolution:
On the computer with Xporter Management Console installed, open Internet Options.
Click the Connections tab, LAN Settings and note the proxy server details.
Open the Xporter Management Console.
Select Misc from the left-hand pane.
Check the Proxy Server Settings - Proxy Server line contains the correct name or IP address of the proxy server and the correct port in the format <proxyname>:<port>. If it is incorrect, click Modify Setting to edit.
Check the Proxy Server Settings - Proxy Bypass line is correct. If it is incorrect, click Modify Setting to edit though ideally we recommend keeping the Proxy Bypass entry blank unless they are essential.
Once you have confirmed that the values are correct you must ensure that the proxy server specified is configured to allow the Groupcall Xporter access to the Internet on the port specified.
The new settings will apply to the next RM Unify-Data job that is run.
Further information: When Xporter runs it will try to make a connection to the Internet using no proxy details. If this fails, it will try to use any proxy address entered into the Misc, Proxy server settings of the Xporter Management Console. If that fails, it will attempt to use any proxy address configured in the Internet Options of the host computer. Finally, if that fails, Xporter will scan the registry and attempt to retry connection using any and all proxy addresses it finds until it succeeds.
Exception: Result: 99 StdOut endpoint is https://api.platform.rmunify.com/misunifyprovisioning/CMTFSchoolsUpload.svc Warning: A StringBuilder buffer has been overflowed by unmanaged code. The process may become unstable. Insufficient capacity allocated to the StringBuilder before marshaling it. GCX_SendToKaleidos ExitCode=99".
Along with "RMUnify-Data Failed,ServiceBus endpoint not found".
Note: This error is normally seen after the job fails to complete, or appears 'stuck' in the Running state.
"Internal Server Error GCX_SendToKaleidos Exited Exception : GCX_SendToKaleidos failed".
Note: This error is normally seen after the extract is completed and during the upload procedure.
"The remote server returned an error: (407) Proxy Authentication Required".
"An unsecured or incorrectly secured fault was received from the other party. See the inner FaultException for the fault code and detail".
The error can be caused by an incorrect password in the Groupcall Xporter configuration.
Resolution:
Log on to your RM Unify Management Console and on the MIS Sync Settings page, under step 3, click the 'Change registration code' button.
Copy the registration code (it will be in the format 12345-67890-54321-09876) to your clipboard.
Open Xporter Management Console from the shortcut on the desktop or click Start, Programs, Groupcall, Xporter.
In the left-hand pane, select Passwords, then find and select the GcxSend:SendToRMUnify_<DfE code> entry.
In the right-hand pane, click Modify Password.
In the Password field, paste the registration code from step 2 and click Submit.
The new password will apply to the next RMUnify-Data job that is run.
"Exception: Missing uid/pwd setting for Send Context (SendToRMUnify_<DfE code>)".
Note: Either error is normally seen after the extract is completed and during the upload procedure.
RMUnify-Data job fails to upload
The RM Unify Data job will fail to upload if the server clock time is skewed (fast or slow) by five minutes from the actual time.
Resolution:
Correct the server time and re-run the RMUnify-Data job.
The Groupcall Xporter will install, but subsequently fails after 60 seconds (time out) attempting to download the Xporter scripts or RM Unify job.
There may be multiple causes for this error. Please try each Resolution below.
Resolution 1:
Open the Xporter Management Console.
Select Misc from the left-hand pane.
Check the Proxy Server Settings - Proxy Server line contains the correct name or IP address of the proxy server and the correct port in the format <proxyname>:<port>. If it is incorrect, click Modify Setting to edit.
Once you have confirmed that the value is correct you must ensure that the proxy server specified is configured to allow the Groupcall Xporter access to the Internet on the port specified.
Confirm that the Groupcall Xporter job runs successfully. Select Job, the RMUnify-Data job and click Run Job in the right-hand pane.
Resolution 2:
Open the Xporter Management Console, select Gcx File Reference and confirm that the RM Unify entry is present.
Click Jobs, under Actions select Reload Jobs and click OK.
Resolution 3:
Click Services, find the Groupcall Xporter service and click Restart.
Resolution 4:
Open the Xporter Management Console on the computer with Xporter installed.
Select Gcx File References and confirm that there is an RMUnify-Data entry.
Select the entry and in the right-hand pane, click Modify Gcx Reference.
In the UpdateID field, decrease the value by 1000 (e.g. 2018002807 becomes 2018001807) and click OK.
Restart the Groupcall Xporter service. The job should appear in Jobs and run automatically. If not, it can be run by right-clicking and selecting Run Job Now.
Resolution 5*:
Log a support call with RM Cloud Support requesting: "Please add a Rollout Step to reset the RM Unify Job Script ID via the Groupcall Dashboard". This is an admin task that RM Cloud Support can perform to force download of the RM Unify job.
Warning: A StringBuilder buffer has been overflowed by unmanaged code. The process may become unstable. Insufficient capacity allocated to the StringBuilder before marshaling it. GCX_SendToKaleidos ExitCode=99
The bypass proxy settings configured in the Xporter Management Console are too long. Delete the bypass proxy settings, or edit to retain only the settings that are essential for allowing Groupcall Xporter to access the Internet.
Open the Xporter Management Console.
Select Misc from the left-hand pane.
Select the Proxy Server Settings - Proxy Bypass.
Click Modify Setting.
Delete all the values, or retain only the values that are essential for allowing Groupcall Xporter to access the Internet.
Click OK.
EGCSqlException: (Exception) Groupcall.Mis.iSAMS: Error downloading XML : The remote server returned an error: (400) Bad Request., cannot invoke GenericAPIFetch.
One or more permissions may be incorrectly set on Groupcall's API access.