Addressing Import Errors: Invalid Application/Page Name

This security measure may cause issues when importing applications that were created prior to this change. Attempting to import older apps/pages with special characters ` ^ ~ ! @ # $ % ^ & * ( ) + = | { } " ; : < > ? / , . ' [ ] \ will result in import failures as shown below. This issue also applies to imports via UI and REST API.

The import operation fails upon the very first detection of an invalid application or page name. You may also encounter other invalid names that need fixing. When an import fails, files are not modified in your existing system.

Error display in Operations Hub classic version:

Error display in Operations Hub new version:

Investigate the Log File

When you encounter import failures, follow these steps to view the log file.

1. Navigate to the site.log file.

   The location of this file may vary based on your installation. The default location is C:\ProgramData\OphubLogs\iqp-tomcat\site.log.

2. If the ProgramData folder is hidden, make it visible in File Explorer.

   In File Explorer, select View > Hidden items.

3. Open the site.log file with a text editor such as Notepad++.
4. Use the text editor's search function to look for the key terms Invalid app name or Invalid page name in the site.log file.
5. After finding the error messages, confirm that the timestamp of the message matches the time when the import action was performed. This information is usually located at the bottom of the log file. This error message will contain the invalid application or page name.

(Recommended) Rename Application/Page Names Prior to Export

In case the original Operations Hub system is accessible, follow these steps to rename the application/page with special characters, export the application again, and import the modified application to the new system.

1. Log in to the original Operations Hub system where the application/page with special characters is located.
2. Navigate to the application/page that contains special characters in its name.
3. Rename the application/page to remove any special characters.
4. Ensure that other applications/pages included in this export have names that comply with the special character restriction.
5. After renaming, export the application/page from the original system.
6. Import the modified application/page into your 2024 Operations Hub system.

Manually Modify the Export File

In case the original Operations Hub system is not accessible, follow these steps to manually modify the export .zip file by extracting all files to a folder, edit the .xml file to remove special characters from application/page names, and then compress the files back into a .zip file for import.

1. Open File Explorer and navigate to the exported application/page .zip file.
2. Extract the .zip file and locate the .xml file associated with the application/page.
3. Open the .xml file with a text editor such as Notepad++.
4. In the text editor, use the search function to find the exact application or page name that contains special characters.
5. Rename the application or page name in the .xml file to remove any special characters. Ensure to update all relevant occurrences of the application or page name in the file.
   Points to Consider:

   • Pay attention to the file naming to avoid conflicts if another application/page shares the same name after rename.
   • Before making any changes to the .xml file, take a backup of the exported application/page .zip file.
   The .xml file contains data organized in a hierarchical structure. Here's an example of the path structure with bad data highlighted. Special characters like @ and # are not allowed in application and page names. Consider using alphanumeric characters, underscores, or hyphens instead.

   <Package>
       <Apps>
           <App>
               <appName>LeanManufacturing@App</appName>
               <items>
           	   {"displayName":"Kaizen#2024"}
               </items>
           </App>
       </Apps>
       <Pages>
           <Page>
               <pageName>Kaizen#2024</pageName>
           </Page>
           <Page>
               <pageName>Performance_Metrics</pageName>
           </Page>
       </Pages>
   </Package>

6. After making the necessary changes, save the .xml file.
7. In File Explorer, compress the extracted files.

   Select all the files/folders, right-click on the selection and choose Send to > Compressed (zipped) folder.

   When creating a zip file for import into Operations Hub, ensure that you select all the files and folders inside the main folder, rather than right-clicking on the outer folder itself. This prevents the creation of a nested folder within the zip file, which can cause import failures in Operations Hub.

   
8. Import this newly created .zip file into your 2024 Operations Hub system.