Upgrade considerations
Updated in 2024.2
We strive to maintain backward compatibility between versions so that you can upgrade seamlessly. However, sometimes we are forced to break compatibility, although we try to keep backward-incompatible changes to a minimum.
This page covers all the backward-incompatible changes that might affect you, as well as other considerations you need to be aware of when upgrading to the most recent version. Please review the respective sections as part of your upgrade planning depending on which version you are upgrading from.
TIP: If you have questions or need help, please contact Alloy Professional Services Team at support@alloysoftware.com.
Version 8.0 or earlier
Pager field removed from Person records
Backward-incompatible change
The Pager field has been removed from Person records as obsolete. The contents of that field are imported into the user-defined field UDF_Pager, and the business logic involving this field is updated correspondingly.
If you have any reports or views based on the Pager field, you will need to review them and update as necessary.
Version 8.2 or earlier
Sharing properties removed from KB Articles and Library Items
Backward-incompatible change
The upgrade removes the Shared_with_Everyone column from the KB_Articles and Library tables, and deletes the Library_Item_Organizations and KB_Article_Organizations tables.
If you have any reports or views based on these items, you will need to review them and update as necessary.
Version 8.2.6 or earlier
Welcome to Mobile App
Backward-incompatible change
All technicians who used to work with the Mobile Portal should be instructed to install our new Mobile App on their mobile devices. Alloy Navigator mobile app is available for iOS and Android mobile devices on Google Play and App Store.
Requests from mobile web browsers to the Web App will not be redirected to the Mobile App anymore.
Version 8.3 or earlier
Discontinued support for Internet Explorer and older browsers
We maintain and develop the Alloy Navigator platform to support the latest, most stable, and most secure web browser versions. We highly recommend updating your browser to the latest version to have the best and most secure user experience across our services.
For the list of supported web browsers, see Installation Guide: Web Client Requirements.
Version 8.6 or earlier
PowerShell instead of CMD in integrations
Backward-incompatible change
Starting with version 8.7,
PowerShell is much more than just a shell. It is a powerful scripting environment that can run complex scripts and automate system administration tasks. Now you can leverage advanced PowerShell capabilities for more efficient solutions.
Among other things, PowerShell can be used to launch external programs, like CMD was used in previous versions. In most cases, native CMD commands are available in PowerShell through aliases. However, there are times when names or syntax of native CMD commands might be misinterpreted. That's why we strongly recommend that you review all your custom integrations after the upgrade to make sure that they work as expected.
The first thing to consider is the location of your external programs. The best practice is to add paths to directories where programs reside to the PATH environment variable. This will help PowerShell find the programs by the name of their executable files. Some standard programs, such as Ping or Remote Desktop, can be run just by typing the filename because their directory path (C:\Windows\System32) exists in the Windows search path by default. An alternative method is specifying full paths to programs.
See the table below for some issues with your custom
| Issue | Description | Solution |
|---|---|---|
|
PowerShell cannot understand the path enclosed with quotes and sends that path it to the output. When the command contains parameters after the path, this error occurs:
|
If you specify a path for an external program in CMD, and the path contains spaces, you must enclose the path with double quotation marks ("). PowerShell considers commands enclosed with quotation marks as PowerShell strings, or objects of the type "String." PowerShell cannot execute strings. When passed a string, it simply attempts to send it to the output. |
Add an ampersand character (&) before the first quotation mark in the path. The ampersand is the Call operator that tells PowerShell to treat the string expression as a command to be executed. For example: INCORRECT:
CORRECT:
NOTE: Make sure that the executable file exists on all computers from which the workflow action is initiated, and the path is the same. Alternatively, add the path to the program to the PATH environment variable, and then delete the path with the quotes from your integration. |
|
PowerShell cannot find the external program that you are trying to launch. This error occurs:
|
PowerShell cannot find programs when their paths are not specified, either explicitly or in the PATH environment variable. For example, if your program is in the Bin directory of Now, when launching external programs is delegated to PowerShell, PowerShell knows nothing about where the executable file is located, and cannot find it. |
Add the path to the program to the PATH environment variable. Alternatively, specify the full path to the program, enclose it in double quotation marks if it contains spaces, and add an ampersand (&) before the first quotation mark. TIP: Our native programs from the Bin directory, such as Alloy Screenshot or WakeOnLan, are not an exception. Now you should specify the full path to the Bin folder, or add it to PATH. NOTE: Make sure that the executable file exists on all computers from which the workflow action is initiated, and the path is the same. |
INFO: For additional information, see Administration Guide: Creating Integrations.
INFO: You can find the official product documentation for PowerShell at https://docs.microsoft.com/powershell/.
Integrations in the Web App
Starting with version 8.7, External Command workflow operations are available not only in the Desktop App, but also in the Web App and the Self Service Portal.
When Web App users run a workflow
Native API integration for the Mobile App
Starting with version 2.0, Alloy Navigator Mobile App no longer needs the Mobile App Service (formerly, "the Mobile Portal") as a backend. Instead, it uses the native API integration, which significantly improves the application performance.
Starting with version 8.7, we are retiring the Mobile App Service and replacing it with the API module. As soon as you upgrade the Mobile App Service from version 8.6 or earlier and your technicians update their Mobile App to version 2.0, the app will prompt them to update the application URL, warning that the existing address is being deprecated. However, technicians will still be able to use the "deprecated" URL until you are ready to install the API module of the latest version.
TIP: When you are ready, switch the Mobile App to the native API integration. For instructions, see Installation Guide: Switch the Mobile App to the Native API Integration.
Version 8.7 or earlier
The transition from 32-bit to 64-bit architecture
Backward-incompatible change
The world had shifted from 32-bit to 64-bit architecture over a decade ago, and the time to shift our products to x64 has come. The transition improves the overall performance and provides much more capabilities for integration with external apps and tools.
If you run a 32-bit environment, you will need to switch to a more modern 64-bit architecture before starting the upgrade process.
Discontinued SAP Crystal Reports support
Backward-incompatible change
Alloy Navigator Express has renounced Crystal Reports and moved to SQL Server Reporting Services (SSRS) reports (or "Microsoft Report Builder reports") years ago. Starting with version 2021, we officially announce the end of support for the SAP Crystal Reports integration.
If you still have any Crystal Reports (.rpt) reports in Alloy Navigator Express, they will no longer be working after the upgrade. The new version comes with a rich set of premade Microsoft Report Builder reports and includes all the necessary software for running them.
INFO: For more details about our reporting services, see Installation Guide: Reporting.
Retirement of the Mobile App Service (former Mobile Portal)
Backward-incompatible change
Since August 2020, our Alloy Navigator mobile app does not need the Mobile App Service (formerly, "the Mobile Portal") as a backend but uses the native API integration instead. As your technicians update their mobile app to version 2.0, it prompts them to update the application URL, warning that the existing address is being deprecated.
Starting with version 2021, we are permanently removing the Mobile App Service. If you still use the Mobile Portal as the backend, you need to switch over your Alloy Navigator mobile app to the native API before or during the upgrade of your Alloy Navigator Express API module.
INFO: For instructions, see Installation Guide: Switch the Mobile App to the Native API Integration.
Reset of all customizations for the Self Service Portal homepage
Backward-incompatible change
The Self Service Portal 2021 comes with a dramatically changed homepage. A set of colorful templates allows you to quickly customize the homepage layout and the color theme of the whole portal
If you have made any customizations to the Self Service Portal by editing the WelcomePage.config, config.less, or ssp.less files, the upgrade will overwrite all your changes with the new, default configuration. If you want to keep your changes, back them up before starting with the upgrade. If needed, you can redo them in the new version by editing the template files.
See the table below to understand the location of configuration files for the old and new versions of the Self Service Portal.
| Self Service Portal 8 (old) | Self Service Portal 2021 (new) |
|---|---|
|
The HomePage directory with homepage templates:
Every template stores its styles and other configuration settings in an individual folder; each file in that folder controls a different aspect of the template. For example, the file
|
IMPORTANT: Before making any changes to homepage templates, create a copy of a template folder with its contents and use only that copy for customization. We recommend that you base your customizations on the Ocean Depth (3 columns) - Default template.
Version 2021.1 or earlier
Removal of the legacy authentication option
Backward-incompatible change
To streamline the authentication process, version 2021.2 removes the legacy, undocumented authentication option that some customers could still use to access the Web App and Mobile App and urges leveraging LDAP authentication instead.
Users of a domain where the IIS server is a domain member can no longer sign in to the Web App or the Mobile App with their Windows domain credentials unless you enable LDAP authentication and set up the corresponding Domain Credentials record using the Settings App.
INFO: For instructions, see Administration Guide: Enabling LDAP authentication.
Version 2021.2 or earlier
Update PowerShell on earlier Windows versions
Backward-incompatible change
Starting with version 2021, you can use PowerShell scripts in External Command workflow operations. Since 2022, you can use PowerShell scripts in any place where Alloy workflow engine supports using SQL scripts. However, this feature requires Windows PowerShell 3.0 or later, up to 5.1. That's why your people may need to update their PowerShell on Windows 7 and Windows Server 2008 computers for a complete workflow experience.
INFO: For details, see Installation Guide: Windows PowerShell.
Removal of the legacy API authentication method that uses SQL Server accounts
Backward-incompatible change
To continue to drive improvements in security of your system, we remove the deprecated and undocumented authentication option that some customers could still use to make API calls by supplying the credentials of SQL Server accounts. Instead, we urge leveraging secure token-based authentication method that requires applications to provide their Application ID and Secret and make API calls after receiving an access token.
INFO: For details, see API User's Guide: Authenticating applications.
Version 2023.1 or earlier
Planned end of support for Microsoft SQL Server 2008 and 2008 R2
In our commitment to delivering safe, secure, and high-quality products and services, Alloy Software intends to discontinue support for Microsoft SQL Server 2008 and 2008 R2 in upcoming releases. Notably, Microsoft ceased support for SQL Server 2008 in 2019. For details, see End of support for SQL Server 2008 and SQL Server 2008 R2.
IMPORTANT: If your organization currently utilizes Microsoft SQL Server 2008, Microsoft SQL Server 2008 Express, Microsoft SQL Server 2008 R2, or Microsoft SQL Server 2008 R2 Express, we strongly advise considering migration to a more recent version of Microsoft SQL Server. For the list of supported versions, see Installation Guide: Database engine requirements.
Version 2023.2 and earlier
Retirement of classic data views and automated conversion to the new experience
During the upgrade to version 2024, Alloy Navigator Express will convert existing legacy data views to the new experience. This automated process ensures that all data views are optimized for the latest features and enhancements, allowing users to take advantage of the improved functionality and user interface without any manual intervention.
Here are several key points to consider.
Shared viewsBefore version 2024, the availability of data views was determined by user roles. Starting with version 2024, data views are now shared to user groups. Following the upgrade and conversion process, shared views will initially be accessible to all technicians, i.e. shared with " everyone". This ensures broad access initially, but it is crucial to review and adjust these sharing settings to align with your organization's collaboration preferences and data security requirements. You can manage these settings by accessing the Customize View pane and navigating to the Sharing tab. Additionally, you may choose to create new groups of technicians as needed to optimize access control. For details, see Web App Help: Customize View pane. NOTE: For users who continue to rely on the Desktop App, maintaining a separate set of shared classic data views remains an option. This ensures continuity for those who prefer or require the desktop interface, allowing them to access familiar data views while transitioning to the new user group-based sharing model for web-based users. |
|
|
Complex filtersDepending on their complexity, filtering expressions used in your classic views may be converted into advanced SQL expressions during the upgrade process. The Advanced Expression feature, tailored for advanced SQL users, enables direct input of SQL clauses to create intricate filters based on the underlying data structure. This ensures that the filters accurately reflect your intended criteria and take full advantage of the advanced capabilities offered by SQL expressions. By carefully fine-tuning these expressions you can optimize performance and ensure the most effective data retrieval for analysis within your Alloy Navigator Express environment. To access filter settings, open the Customize View pane, then navigate to the Filter tab. For details, see Web App Help: Customize View pane. |
We're committed to ensuring a smooth transition for all our users. If you have any questions or need assistance, please contact Alloy Professional Services Team. Thank you for your continued support as we evolve our products to better serve your needs!
Discontinued support for HTTP
Backward-incompatible change
As part of our ongoing commitment to security and data integrity, all communications with Alloy web applications will now require HTTPS. This change ensures that all data transmitted between browsers and servers are encrypted, protecting your sensitive information from potential interception and unauthorized access.
For on-premises customers currently using HTTP, please install an SSL/TLS certificate, configure your web server for HTTPS, and set up HTTP to HTTPS redirection to ensure all connections are secure. On-prem customers already utilizing HTTPS and cloud customers are not affected by this change.
This update is crucial for maintaining the highest standards of security and ensuring that your experience with our web apps remains safe and reliable. We appreciate your understanding and cooperation as we make this transition to a more secure and robust platform!
End of support for Microsoft SQL Server 2008 and 2008 R2
Backward-incompatible change
Starting with version 2024, we discontinue support for Microsoft SQL Server 2008 and 2008 R2. Microsoft stopped supporting SQL Server 2008 in 2019. For details, see End of support for SQL Server 2008 and SQL Server 2008 R2.
If your company currently utilizes Microsoft SQL Server 2008, Microsoft SQL Server 2008 Express, Microsoft SQL Server 2008 R2, or Microsoft SQL Server 2008 R2 Express, you will need to migrate to a more recent version of Microsoft SQL Server.
INFO: For the list of supported versions, see Installation Guide: Database engine requirements.
Version 2024.1 and earlier
Reset of advanced style customizations for the Self Service Portal
Backward-incompatible change
The Self Service Portal 2024.2 has been rebuilt with advanced technologies, unveiling a completely redesigned interface powered by new capabilities. To ensure a seamless transition, all existing functionality has been retained, along with key customizations you may have made in the previous version, such as custom homepage layout or localization changes.
However, if you’ve made advanced customizations to the portal’s styles using the config.less file, the upgrade will overwrite these changes with the new, improved design. Your customizations can still be recreated in the new version if needed.
IMPORTANT: You can back up your customized config.less file to use it as a reference. To do this, just keep the Enable backup option selected during the upgrade.
| Self Service Portal 2024.1 or earlier (old) | Self Service Portal 2024.2 (new) |
|---|---|
|
Every color theme comes with a set of configuration files that allows advanced customization of the appearance of the Self Service Portal. Here are the key files:
All these files are located in the respective theme folders inside the HomePage folder:
|
In this version, the ability to make style customizations using the To back up your customizations, ensure the Enable backup option is selected during the upgrade. All files will be saved in the backup location for reference, allowing customizations to be recreated. For example, to reapply your custom header image, go to Admin Center > Apps and Portals > SSP > Homepage Template and upload your More complex customizations made through |
Transition of Self Service Portal customizations
For a smooth transition, the new version retains all key customizations made to the Self Service Portal in the previous version. See table below for the different approaches to these customizations in both versions.
| Self Service Portal 2024.1 or earlier (old) | Self Service Portal 2024.2 (new) |
|---|---|
Homepage layout |
|
|
Every color theme comes with the
|
The new version features a single homepage template for all color themes, now in JSON format for improved customization and seamless integration. The template is stored in the database and can be easily managed through the Admin Center. For backward compatibility, your old template and HTML custom widgets are preserved and applied automatically after the upgrade. Their new location is:
We encourage transitioning your homepage to the JSON format after the upgrade to take advantage of a more flexible and modern design. To switch to the new JSON homepage template:
|
Custom JavaScript |
|
|
The Self Service Portal supports embedding custom JavaScript into the portal's JavaScript library:
|
All your custom
You may want to review your custom JavaScript to ensure external functionality works in the new version. For assistance, please contact Alloy Professional Services Team. |
Localization dictionaries |
|
|
In previous versions, language selection was available in the Web Configuration tool on the web server, and the localization dictionaries were stored as configuration files:
|
In the new version, we've moved localization dictionaries and language selection to a centralized location in the Admin Center. If you've made changes to any dictionary, your changes will be retained. Additionally, we've added 16 new languages. To select additional languages, go to Admin Center > Apps and Portals > Self Service Portal > Languages. From here, you can easily export and import languages for modifications and further localization. If you have multiple Self Service Portal instances, note that the language set is now unified across all instances. Any changes made to a dictionary in one instance will automatically reflect in the others. |