Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-57769

Editing a document that has special characters in the document's name fails when using the Companion App.

      Issue Summary

      In Windows, if a document's name do not contain spaces and has a "&" character and the user tries to use the Companion App to edit the document, the Companion App will return an error and will fail to launch. This has been tested on Word documents and documents with the .txt extension but we believe that the behavior is the same across all other document types.

      Environment

      • Windows

      Steps to Reproduce

      1. Create a word document. Name it a&b.docx
      2. Upload it to Confluence
      3. Attempt to Edit the document.

      Expected Results

      Companion App launches and the document can be edited using the related application.

      Actual Results

      A "Windows cannot find" the document error is is returned. (see attachment)
      In some cases, the companion app just hangs and does not return any error message.

      Tested Scenarios:

      • a&b will fail
      • a&bababa will fail
      • a & b will work
      • Financial Sample & (test) etc will work
      • FinancialSample&(test)etc.xls will fail

      Workaround

      Change the document's name by removing the "&" character.

        1. image.png
          25 kB
          Ahmad Faridi

            [CONFSERVER-57769] Editing a document that has special characters in the document's name fails when using the Companion App.

            Avik H made changes -
            Resolution New: Fixed [ 1 ]
            Status Original: Needs Triage [ 10030 ] New: Closed [ 6 ]

            Avik H added a comment -

            More pieces of Information

            In general, it looks like the problem is with IIS configuration where files that have brackets () are not allowed for some reason while it works with other special characters like $, &&. So the issue is not with the core product ( Companion App or Confluence )

            Atlassian Companion 2.1.0 edit testing with special characters mostly brackets () in the file name, browser used Chrome

            • Confluence v9.1.0 deployed on Linux with Nginx reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
            • Confluence v8.5.16 ( LTS ) deployed on Linux with Nginx reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
            • Confluence v8.5.16 ( LTS ) deployed on Linux with default reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
            • Confluence v8.9.7 deployed on Linux with default reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
            • Confluence v7.20.3 deployed on Linux with default reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
            • Confluence v7.20.3 deployed on Linux with Nginx reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
            • Confluence v7.4.4 deployed on Linux with default reverse proxy
              File editing on Mac works using the Companion App
              File editing on Windows works using the Companion App
              ----------------------------------------------------------------------
            • Confluence v7.4.4 deployed on Linux with Apache reverse proxy
              File editing on Mac does not work using the Companion App
              File editing on Windows does not work using the Companion App
            • Confluence v9.1.0 deployed on Linux with Apache reverse proxy
              File editing on Mac does not work using the Companion App
              File editing on Windows does not work using the Companion App

            Avik H added a comment - More pieces of Information In general, it looks like the problem is with IIS configuration where files that have brackets () are not allowed for some reason while it works with other special characters like $, &&. So the issue is not with the core product ( Companion App or Confluence ) Atlassian Companion 2.1.0 edit testing with special characters mostly brackets () in the file name, browser used Chrome Confluence v9.1.0 deployed on Linux with Nginx reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App Confluence v8.5.16 ( LTS ) deployed on Linux with Nginx reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App Confluence v8.5.16 ( LTS ) deployed on Linux with default reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App Confluence v8.9.7 deployed on Linux with default reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App Confluence v7.20.3 deployed on Linux with default reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App Confluence v7.20.3 deployed on Linux with Nginx reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App Confluence v7.4.4 deployed on Linux with default reverse proxy File editing on Mac works using the Companion App File editing on Windows works using the Companion App ---------------------------------------------------------------------- Confluence v7.4.4 deployed on Linux with Apache reverse proxy File editing on Mac does not work using the Companion App File editing on Windows does not work using the Companion App Confluence v9.1.0 deployed on Linux with Apache reverse proxy File editing on Mac does not work using the Companion App File editing on Windows does not work using the Companion App The KB - Atlassian Companion app fails to edit files with certain special characters and needs to be updated with the workaround on IIS hence closing this bug ticket.  
            Avik H made changes -
            Worklog Id Original: 174401 [ 174401 ]
            Remaining Estimate New: 0h [ 0 ]
            Time Spent New: 3h [ 10800 ]
            Avik H logged work - 04/Oct/2024 5:25 AM
            • Time Spent:
              3h
               
              testing

            Avik H added a comment - - edited

            The issue is not seen as tested locally on Mac on Companion v2.1.0 ( latest ), I mean without using any reverse proxy as I tested on Conf v7.41 and v8.9.4.

            So we need to modify the reverse proxy configuration for Apache & Nginix as mentioned on https://confluence.atlassian.com/confkb/atlassian-companion-app-fails-to-edit-files-with-certain-special-characters-1021222300.html as a solution but as of now, there is no update with IIS reverse proxy configuration.

            Avik H added a comment - - edited The issue is not seen as tested locally on Mac on Companion v2.1.0 ( latest ), I mean without using any reverse proxy as I tested on Conf v7.41 and v8.9.4. So we need to modify the reverse proxy configuration for Apache & Nginix as mentioned on https://confluence.atlassian.com/confkb/atlassian-companion-app-fails-to-edit-files-with-certain-special-characters-1021222300.html as a solution but as of now, there is no update with IIS reverse proxy configuration.
            SET Analytics Bot made changes -
            Support reference count Original: 18 New: 25
            SET Analytics Bot made changes -
            UIS Original: 17 New: 1
            Avik H made changes -
            Resolution Original: Fixed [ 1 ]
            Status Original: Closed [ 6 ] New: Needs Triage [ 10030 ]

            David Charkey added a comment - - edited

            I'm still having this issue with Atlassian Companion 2.1.0 (and Confluence 7.4.4 (IIS reverse proxy configuration)). When I try to edit attachments containing the '(' and ')' symbols in their filename, I get a "Download Failed, head back to Confluence to try again." error. This issue should probably be re-opened to address this.

            David Charkey added a comment - - edited I'm still having this issue with Atlassian Companion 2.1.0 (and Confluence 7.4.4 (IIS reverse proxy configuration)). When I try to edit attachments containing the '(' and ')' symbols in their filename, I get a "Download Failed, head back to Confluence to try again." error. This issue should probably be re-opened to address this.

            Additional reports in CONFSERVER-22403 (it was originally about the Edit in Office feature, but no one closed it after the feature was removed)

            Piotr Janik added a comment - Additional reports in CONFSERVER-22403 (it was originally about the Edit in Office feature, but no one closed it after the feature was removed)

              zxu2@atlassian.com Zac Xu
              afaridi Ahmad Faridi
              Affected customers:
              20 This affects my team
              Watchers:
              30 Start watching this issue

                Created:
                Updated:
                Resolved:

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 3h
                  3h