Prior to Technology Platform 11.6, STARLIMS Crystal Reports connected to the database using Microsoft OLE DB Providers (SQLOLEDB and OraOLEDB.Oracle). Starting with 11.6, STARLIMS has moved to ODBC connections (ODBC (RDO)) instead, primarily to ensure compatibility with TLS 1.2 and above.
Note: In March 2021 RFC 8996 formally deprecates TLS versions 1.0 and 1.1; and in August 2023 Microsoft announced to disable them in Windows by default.
This article explains how to convert all existing Crystal Reports in STARLIMS to the ODBC connection and what else needs to be updated on the server for the conversion to take effect.
1. How do I know if I have to convert?
Connection info is inside the uploaded (.rpt) Crystal Reports file. You must download it from STARLIMS and check the database connection using Crystal Reports Designer.
It's safe to convert reports to ODBC multiple times. It's easier to test if they work after conversion than to check every single report in every language.
To check the Conditions report from Base Static Tables | Conditions:
- Go to STARLIMS XFD Designer (using IE browser, Native App, or the Designer application in an HTML system (if configured)).
- Navigate to Reports > Crystal Reports > BaseStaticTables > Condition.
- Right-click the report and select Download and choose ENG.
- Save the template locally and open it in Crystal Reports.
- Go to Database > Set Datasource Location > expand report > 'database server' > Properties.
- If Database Type shows ODBC (RDO), it’s already converted. SQLOLEDB or OraOLEDB.Oracle indicate OLE DB providers that need conversion.
2. Prerequisites for On-Prem Customers
- Administrator access to STARLIMS application and batch servers
- Install recommended ODBC drivers* on application and batch servers
- Verify Enterprise Setting RPT_DISABLE_CONV_TO_ODBC
* TP11.16 to TP12.0 requires ODBC13 (x64); TP12.1 to TP12.7 uses ODBC17 (x64); TP12.8+ uses ODBC18 (x64). Recent STARLIMS installers/upgraders install the correct ODBC version. Download ODBC v18, Download ODBC v17. ODBC v13 is no longer provided by Microsoft but is attached here.
3. Workflow
1. Convert a single report and test
STARLIMS lets you convert one report, a category, or all reports at once. To test, convert the Conditions report from Base Static Tables | Conditions.
Note: Before converting it might be good to create a personal backup of the report(s).
- Go to STARLIMS XFD Designer (using IE browser, Native App, or the Designer application in an HTML system (if configured)).
- Navigate to Reports > Crystal Reports > BaseStaticTables > Condition.
- Make sure the report is Checked-in:
- Right-click the report and select Source Control.
- No usernames should be visible behind the Languages (in the example below the ENG report is checked out by JSI)
- Right-click the report and select Convert to ODBC connection.
- Right-click again and choose Preview > ENG to verify the report.
If it works, all others can be converted too.
Note: The report could be empty (only containing headers) as no Condition data is registered in your system, but if the report opens the conversion was successful. Testing another report is also an option of course.
Note: Some reports require parameters to work. Unfortunately STARLIMS doesn't 'know' this and the parameters have to be added manually. Reviewing the converted report through the application solves this problem.
In case of problems, please stop the procedure here and create a support ticket to share the error message and problem found.
2. Convert all reports and test
Note: Before converting it might be good to create a personal backup of the report(s).
- Go to STARLIMS XFD Designer (using IE browser, Native App, or the Designer application in an HTML system (if configured)).
- Make sure all reports are Checked-in:
- At the bottom of the screen go to Pending Checkins, click All Users and hit Refresh
- None of the users should have Crystal Reports checked out (in the example below the Conditions report is checked out by JSI)
- Navigate to Reports > Crystal Reports.
- Right-click and select Convert to ODBC connection.
- Check the log at the bottom of the Designer for progress.
- Test several reports from the Main Menu and verify all custom daily reports work correctly.
3. Convert reports on other environments or export and import from DEV
When steps 1 and 2 are completed successfully on DEV (or TEST) one could continue with the other environments. Steps 1 and 2 could be repeated on all environments or an export of all reports on DEV could be made and rolled out to other environments.
Note: Before converting it might be good to create a personal backup of the report(s).
4. Additional steps / information
1. Check Enterprise Setting RPT_DISABLE_CONV_TO_ODBC
Enterprise Setting RPT_DISABLE_CONV_TO_ODBC might be set to Y, blocking the conversion to ODBC on upload to STARLIMS and blocking the option to (bulk) convert reports to ODBC. It has to be set to N.
Note: This setting is already correct(ed) for cloud customers.
Through STARLIMS (requires Designer access)
- Go to STARLIMS XFD Designer (using IE browser, Native App, or the Designer application in an HTML system (if configured)).
- Navigate to Application > Enterprise_Support > Enterprise_Settings > XFD Forms and open the form Edit_Settings.
- Run the form.
- Locate the setting RPT_DISABLE_CONV_TO_ODBC (under the System category) and set its value to N.
- Close the form, close the Designer, then close the Native App/IE Browser.
Through the STARLIMS DICTIONARY database
Run the following select / update on the STARLIMS DICTIONARY database through SQL Server Management Studio (or a similar tool):
select VALUE from LIMSENTERPRISESETTINGS where SETTINGNAME = 'RPT_DISABLE_CONV_TO_ODBC'
update LIMSENTERPRISESETTINGS set VALUE = 'N' where SETTINGNAME = 'RPT_DISABLE_CONV_TO_ODBC' and VALUE = 'Y'After the setting is changed, it is required to ‘restart’ STARLIMS (recycle the STARLIMS Application Pool, this does not affect active sessions).
2. Backup (export) all Crystal Reports
- Go to STARLIMS XFD Designer (using IE browser, Native App, or the Designer application in an HTML system (if configured)).
- Navigate to Tools > Enterprise > Export Package and click Next
- Pick English and all other languages in active use on the system and click Next
- Click Reports, tick the All Layers checkbox at the bottom, tick the checkbox before Crystal Reports, click OK and click Next
- Give the package a name like PROD_AllCrystalReports_Backup_20260709 and click Start export
- Click Next, tick Download on client and click Next
- Save locally and click Next and Finish to complete the export (backup)
Comments
0 comments
Article is closed for comments.