OfficeDev / office-js

A repo and NPM package for Office.js, corresponding to a copy of what gets published to the official "evergreen" Office.js CDN, at https://appsforoffice.microsoft.com/lib/1/hosted/office.js.
https://learn.microsoft.com/javascript/api/overview
Other
687 stars 95 forks source link

GetStarted messages do not appear to correctly pick up manifest settings #3164

Open Admiral-Skye opened 1 year ago

Admiral-Skye commented 1 year ago

Provide required information needed to triage your issue

Your Environment

Expected behavior

Information specified in the GetStarted element of the manifest should be displayed in the getting started message for a taskpane add-in.

Current behavior

Currently the Title and LearnMoreUrl appear to be ignored entirely and the description seems to make use of the Description element under the officeapp element.

NVIDIA_Share_MAXYu2uvnn

Powerpoint also appears to fail to use either description element in its callout

NVIDIA_Share_LpkxxDrzQA

Steps to reproduce

  1. Set the desciption element in a manifest to some string of text
  2. Add the GetStarted element to the DesktopFormFactor of the manifest and specify a Title, Description (different to the description element) and a LearnMoreUrl
  3. Deploy the manifest then trigger the new addin dialog, I am not entirely sure how to do this exactly.
  4. Observe that in Excel and Word the callout will have "New add-in from your admin" as the title and the value of the first "Desciption" element.
  5. In powerpoint, i observed that the desciption was also missing from the new add-in call out.
  6. Observe that there is no mention of the LearnMoreUrl in any of the callouts.

Link to live example(s)

Our current manifest exhibits this issue: https://pastebin.com/BxJM3QsQ

Provide additional details

reproduction will require replacing aspects of the manifest inside { } with appropriate values for your environment.

Context

We want to make sure our customers are provided a clear and standardised message about the new add-in deployed by their administrator and also provide them a way to find out more information about the integration from that callout.

Useful logs

Here are some screenshots of the callout that I have observed,

The title we specify is "New Feature!", the GetStarted desciption is "Ingress Enterprise Search", we specify a learn more url and our OfficeApp description element has the value "Enterprise Search"

NVIDIA_Share_MAXYu2uvnn NVIDIA_Share_LpkxxDrzQA NVIDIA_Share_39UXWDxWaX

Here is a sample of our manifest, we replace elements contained within braces before serving it via an api endpoint https://pastebin.com/BxJM3QsQ

Thank you for taking the time to report an issue. Our triage team will respond to you in less than 72 hours. Normally, response time is <10 hours Monday through Friday. We do not triage on weekends.

ghost commented 1 year ago

Thank you for letting us know about this issue. We will take a look shortly. Thanks.

Admiral-Skye commented 1 year ago

@penglongzhaochina Hi, has any progress been made? I'd also like to know what are the conditions for this popup to appear?

penglongzhaochina commented 1 year ago

Hi @Admiral-Skye Sorry for late,Our engineer is under invetigation. I will connect you once we have some progress.

MandytMSFT2 commented 1 year ago

HI @Admiral-Skye , Thanks for reporting this !

The callout is a new feature developed for newly admin deployed addins. It will only show once per user across platforms (That's saying the callout for same addin will only show once either on Office web, desktop or Mac ).

Currently the callout Title is fixed as "New Add-in for your admin" and description is honored the description field in manifest as you observed instead of the one in DesktopFormFactor since not every manifest will have DesktopFormFactor set. so the issue you are reported is by design. We have plan to improve the experience like changing the callout title to a more meaningful one or add learn more url to help customer get more information.

As for PPT callout description , Looks like it hits the fallback logic when we somehow failed to get description from manifest.

Admiral-Skye commented 1 year ago

Thanks for getting back to me @MandytMSFT2 . If this is the case could the documentation be updated for the get started element to make this clear?

I am using the same manifest for Excel, Word and Powerpoint so I am not sure what I need to change to get this to work with Powerpoint.

MandytMSFT2 commented 1 year ago

Thank you @Admiral-Skye for the feedback, We have recorded and will take into consideration in next iteration.

Ideally it should be rare case that WXP has different callout string. I am trying to deploy this addin by myself from tenant admin portal, but looks it's an invalid manifest. Would you mind sharing how you deployed ?

Admiral-Skye commented 1 year ago

@MandytMSFT2 We are making use of placeholder strings within the manifest that are replaced by secrets from our keyvault when served via an api endpoint.

These secrets are denoted using { ... } and will need to be replaced with appropriate ones from your test environment. I am then deploying the manifest via the office admin portal for all my test users in my organisation.