Live Metadata Testing Notes
Published: 2020-06-11 by Mike.
Word 2013 testing
When testing whether the panel has updated the SharePoint metadata of the document being edited, please make sure both the document is re-saved, by actually clicking File > Save, back to SharePoint and that you’ve waited at least up to 60 seconds for SharePoint to update. Word 2013 does not have the AutoSave feature will not automatically upload the document changes to SharePoint. Live Metadata modifies the document to save the metadata so the document MUST be saved and up to date in SharePoint for the properties to be reflected correctly. The parser (which is the SharePoint code to update the metadata from the document) takes up to 60 seconds to update metadata in the SharePoint library.
Creating DOCX from SharePoint menu
When creating a DOCX document from the “+ New” menu with “Open Document in Client Applications” active (not Office Online web products), until the file is saved to SharePoint, the file ONLY exists in memory. There is NO current version of the file in SharePoint until the first time the file is saved.
This is an extremely important point, because in the Client Application, it seems as though the file exists in SharePoint, but it actually does not exist until the first File|Save.
Because there is no version until the first Save, there is no way to tell the add-in what the location of the SharePoint site is and therefore no way for the add-in to understand the SharePoint file metadata – it simply doesn’t exist yet and no editable properties.
It is not an error of the add-in to tell the user that they need to save to SharePoint first or that that document must be opened from SharePoint.
It is critical to ensure the file is saved first, to guarantee a version of the file exists in SharePoint. The add-in can only then retrieve the editable document metadata of files that exist.
Some, not all properties displayed
Please note that not all document properties and not all document metadata is editable via the add-in nor SharePoint Online. It is not necessarily an error to only see the Title field.
If no additional metadata (other than the title) is displayed, this may mean one of the following:
- The Name metadata field is actually the document filename and cannot be edited as metadata through the panel. Although Office Online products allow the renaming of the document name through the heading area, the document name is NOT editable metadata.
- There is no additional editable metadata specified in the library or content type other than the title field.
- System fields (examples listed below) are not editable metadata, these are system edited.
- Name (filename)
- ID (item id number)
- Created (date created)
- Created by (person created document)
- Modified (date last modified)
- Modified by (person last modified document)
- Version (current version of the file)
Wait at least up to 60 seconds before checking if SharePoint has been updated
When testing whether the panel has updated the SharePoint metadata of the document being edited, please make sure both the document is re-saved back to SharePoint and that you’ve waited at least up to 60 seconds for SharePoint to update. The parser (which is the SharePoint code to update the metadata from the document) takes up to 60 seconds to update metadata in the SharePoint library.
Error loading properties screen
When creating a document from “+ New” menu where NO content has been created but the document has been saved and is visible in the SharePoint Document Library, an error is displayed in Live Metadata.
Once a character is typed in to the document and the document is Saved, the Live Metadata panel should display the title field.
Document MUST be saved in Word Application for metadata to be updated in SharePoint library view
If whilst editing a document in Word Application (not Online) and AutoSave is turned off, you need to complete a Ctrl-S or File|Save for metadata changed to be reflected in SharePoint’s Library view.
After updating the metadata in the add-in panel, a File|Save MUST be completed even though the panel flashes “Saved” on every metadata edit. The flashing of “Saved” is the panel updating the document metadata, however, this does not mean that SharePoint is automatically updated, especially if AutoSave is turned off or using an older version of Word as old versions do not support AutoSave On feature.
Complete a File|Save, switch to SharePoint and refresh the library view to see the metadata changes reflected back in to SharePoint.
Scrolling right issue
When using Firefox browser with Word Online, you may experience an issue where the horizontal scrollbar causes the scrolling of the field to exceed the width of the panel. This is actually a bug with Microsoft. The issues relates to the panel area we cannot control.
If you retry this test using Edge or Chrome, you will find the issue doesn’t occur and is an issue between Microsoft and Firefox.
Again, this area of the panel is not something we have control over and is a Microsoft bug.
I cannot login to an Office Add-in in Safari on Mac
When using Qualitem Office Add-in’s in Safari on Apple Mac, Nothing happens after you login. The task pane continues to display the login button.
There are three possible solutions.
Disable the ‘Prevent cross-site tracking’ feature in Safari.
- Click the Safari App menu and select Preferences.
- Click the Privacy tab.
- Uncheck the Prevent cross-site tracking checkbox.
- Close Preferences.