Skip to content

Add new article Configure redirect behavior#10868

Open
cindylay wants to merge 4 commits into
SharePoint:mainfrom
cindylay:cindylay/urltemplate
Open

Add new article Configure redirect behavior#10868
cindylay wants to merge 4 commits into
SharePoint:mainfrom
cindylay:cindylay/urltemplate

Conversation

@cindylay
Copy link
Copy Markdown
Contributor

@cindylay cindylay commented May 29, 2026

Category

  • Content fix
  • New article

Related issues

  • Supersedes the urlTemplate content originally proposed in #10798. If this PR merges first, the URL template section in office-experience.md should be removed (or that PR retargeted).

What's in this Pull Request?

Adds a new standalone article documenting how to configure the urlTemplate setting on a
SharePoint Embedded container type. urlTemplate controls where Microsoft 365 redirects
users when they select a search result for content stored in a container — sending them to
the application's own UI instead of the default Office viewer.

This content previously lived in the Office Experiences article (PR #10798), but
urlTemplate is its own feature with its own permission model, validation rules, and
troubleshooting surface, so it's better served as a dedicated article.

Changes

  • New article: docs/embedded/development/content-experiences/configure-redirect-behavior.md
  • TOC: Added a "Configuring redirect behavior" entry under Development → Content Experiences, between Office Experiences and User Experiences.

What the article covers

  • Prerequisites — owning tenant access, the FileStorageContainerType.Manage.All delegated permission (application permissions aren't supported), and isDiscoverabilityEnabled = true.
  • How Microsoft 365 chooses a destination — the decision flow for click-throughs from search, including a file-type handling table (Office vs. PDF vs. other).
  • Configure urlTemplate — requirements, syntax, the full list of supported tokens with descriptions, an end-to-end example, a PATCH sample against Update fileStorageContainerType, and a GET to verify the value persisted.
  • What your application does when called — three-step runtime contract: authenticate the user, parse the token values, then call Microsoft Graph with driveId and itemId.
  • Troubleshooting — common symptoms (still routes to Office, value reverts to null, tokens appear literally) mapped to their causes.
  • Limitations — up-to-24-hour propagation window for setting changes; container-type scope.
  • Related content — links to the container types concept, the Update fileStorageContainerType API, the fileStorageContainerTypeSettings resource, custom container properties, and the SharePoint Embedded auth doc.

Style and editorial

  • Follows the Microsoft Learn style guide: sentence-case headings, active voice, present tense, contractions, Oxford commas, no "please / click / log in / just / simple".
  • One [!IMPORTANT] alert (within the 1–2 per article guidance).
  • All code identifiers in backticks; UI strings would be bold (none used).
  • Article description ~145 chars; H1 matches the title front-matter field.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit f2f0ebc:

✅ Validation status: passed

File Status Preview URL Details
docs/embedded/development/content-experiences/configure-redirect-behavior.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

@cindylay cindylay force-pushed the cindylay/urltemplate branch from f2f0ebc to be3dc67 Compare May 29, 2026 23:41
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit be3dc67:

✅ Validation status: passed

File Status Preview URL Details
docs/embedded/development/content-experiences/configure-redirect-behavior.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new SharePoint Embedded documentation article describing how to configure fileStorageContainerType.settings.urlTemplate so Microsoft 365 search result click-throughs can redirect to an app-defined experience, and wires the article into the docs navigation.

Changes:

  • Adds a new standalone article: Configuring redirect behavior (configure-redirect-behavior.md).
  • Updates docs/toc.yml to include the new article under Development → Content Experiences.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/toc.yml Adds a TOC entry pointing to the new redirect-behavior article.
docs/embedded/development/content-experiences/configure-redirect-behavior.md New end-to-end guidance for configuring urlTemplate, including token reference, examples, troubleshooting, and limitations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/embedded/development/content-experiences/configure-redirect-behavior.md Outdated
Comment thread docs/embedded/development/content-experiences/configure-redirect-behavior.md Outdated
Comment thread docs/embedded/development/content-experiences/configure-redirect-behavior.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit c3a5bb2:

✅ Validation status: passed

File Status Preview URL Details
docs/embedded/development/content-experiences/configure-redirect-behavior.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

cindylay and others added 2 commits May 29, 2026 17:06
…oken-table updates

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@cindylay cindylay force-pushed the cindylay/urltemplate branch from 112fe95 to 181cc82 Compare May 30, 2026 00:09
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 112fe95:

✅ Validation status: passed

File Status Preview URL Details
docs/embedded/development/content-experiences/configure-redirect-behavior.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 181cc82:

✅ Validation status: passed

File Status Preview URL Details
docs/embedded/development/content-experiences/configure-redirect-behavior.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants