Skip to content

Commit a1dc222

Browse files
authored
[excel] (Platform) Update for preview on family/home editions (#699)
* First draft of consumer docs * Correct storage information * Add tab group ender * PR feedback * Fix typo * PR feedback * Typo
1 parent 25bcbe4 commit a1dc222

File tree

8 files changed

+75
-15
lines changed

8 files changed

+75
-15
lines changed

docs/develop/power-automate-integration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ ms.localizationpriority: medium
1010

1111
[Power Automate](https://make.powerautomate.com) lets you add Office Scripts to a larger, automated workflow. You can use Power Automate to do things like add the contents of an email to a worksheet's table or create actions in your project management tools based on workbook comments.
1212

13+
[!INCLUDE [Power Automate needs a business license](../includes/power-automate-needs-business.md)]
14+
1315
## Get started
1416

1517
If you are new to Power Automate, we recommend visiting [Get started with Power Automate](/power-automate/getting-started). There, you can learn more about all the automation possibilities available to you. The documents here focus on how Office Scripts work with Power Automate and how that can help improve your Excel experience.

docs/includes/platform-requirements.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
To use Office Scripts, you'll need the following.
22

3+
# [For business and education](#tab/business)
4+
35
1. Excel for Windows (version 2210 or higher), Excel for Mac, or Excel on the web.
46
- *The [Action Recorder](../overview/excel.md#action-recorder) is not yet available in the [Semi-Annual Enterprise Channel](/deployoffice/updates/overview-update-channels#semi-annual-enterprise-channel-overview).*
57
1. OneDrive for Business.
@@ -14,5 +16,12 @@ To use Office Scripts, you'll need the following.
1416
- Office 365 A5
1517
1. Internet connectivity with [connected experiences](/deployoffice/privacy/connected-experiences) enabled.
1618

17-
> [!NOTE]
18-
> If you meet these requirements and are still not seeing the **Automate** tab, it's possible that your admin has disabled the feature or there's some other problem with your environment. Please follow the steps under [Automate tab not appearing or Office Scripts unavailable](../testing/troubleshooting.md#automate-tab-not-appearing-or-office-scripts-unavailable) to start using Office Scripts.
19+
# [For personal and family](#tab/home)
20+
21+
> [!IMPORTANT]
22+
> Office Scripts is in preview for personal and family Microsoft 365 subscriptions. If you encounter any issues, please report them through the Feedback button in Excel.
23+
24+
1. Excel for Microsoft 365 or Excel on the web.
25+
1. Internet connectivity with [connected experiences](/deployoffice/privacy/connected-experiences) enabled.
26+
27+
---
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!IMPORTANT]
2+
> To use Office Scripts in [Power Automate](https://make.powerautomate.com), you must have a [business license of Microsoft 365](../testing/platform-limits.md?tabs=business).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
You'll need access to Office Scripts for this tutorial. Please review the [Platform support](/office/dev/scripts/testing/platform-limits#platform-support) if the Automate tab doesn't appear.
1+
You'll need access to Office Scripts for this tutorial. Please review the [Platform support](/office/dev/scripts/testing/platform-limits#platform-support) if the Automate tab doesn't appear.

docs/overview/excel.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ This series of documents teaches you how to use these tools. You'll find a wealt
1616

1717
> [!VIDEO https://www.microsoft.com/videoplayer/embed/RE4qdFF]
1818
19-
> [!NOTE]
20-
> Office Scripts requires a commercial or educational Microsoft 365 license. The complete requirement list is described under [Platform support](../testing/platform-limits.md#platform-support).
21-
2219
## When to use Office Scripts
2320

2421
Scripts allow you to record and replay your Excel actions on different workbooks and worksheets. If you find yourself doing the same things over and over again, you can turn all that work into an easy-to-run Office Script. Run your script with a button in Excel or combine it with Power Automate to streamline your entire workflow.
@@ -48,7 +45,7 @@ Our [tutorials](../tutorials/excel-tutorial.md) provide a guided and structured
4845

4946
## Share Office Scripts
5047

51-
Office Scripts can be shared with other users of an Excel workbook. When you share a script in a shared workbook, everyone with access to the workbook can also view and run your script. For more details about sharing and unsharing scripts, see [Sharing Office Scripts in Excel](https://support.microsoft.com/office/226eddbc-3a44-4540-acfe-fccda3d1122b).
48+
Office Scripts can be shared with other users in your organization. When you share a script in a shared workbook, team members with access to the workbook can also view and run your script. For more details about sharing and unsharing scripts, see [Sharing Office Scripts in Excel](https://support.microsoft.com/office/226eddbc-3a44-4540-acfe-fccda3d1122b).
5249

5350
Add buttons that run scripts to help your colleagues discover your valuable solutions and let them run scripts straight from the workbook. Learn more about script buttons in [Run Office Scripts with buttons](../develop/script-buttons.md).
5451

docs/overview/script-storage.md

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
---
22
title: Office Scripts file storage and ownership
33
description: Information about how Office Scripts are stored in Microsoft OneDrive and transferred between owners.
4-
ms.date: 09/08/2023
4+
ms.date: 01/10/2024
55
ms.localizationpriority: medium
66
---
77

88
# Office Scripts file storage and ownership
99

10-
Office Scripts are stored as **.osts** files in your Microsoft OneDrive or a SharePoint folder. They are stored separately from a workbook. To give users who are outside of the SharePoint site access to the script, [share the script with an Excel workbook](excel.md#share-office-scripts). This means you're linking the script with the file, not attaching it. Whoever has access to the Excel file will also be able to view, run, or make a copy of the script.
10+
The details of how scripts are stored and shared depend on your Microsoft 365 subscription. Select the relevant tab to learn more.
1111

12-
Excel only recognizes and runs a script if it's in your OneDrive folder, a Sharepoint folder, or shared with the workbook. This means Excel needs internet connectivity to access Office Scripts.
12+
> [!IMPORTANT]
13+
> Office Scripts is in preview for personal and family Microsoft 365 subscriptions. If you encounter any issues, please report them through the Feedback button in Excel.
1314
14-
> [!NOTE]
15-
> Admin settings for Conditional Access in OneDrive and SharePoint affect Office Scripts. For more information, see the [Conditional Access section of Platform limits and requirements with Office Scripts](../testing/platform-limits.md#conditional-access).
15+
## File storage
16+
17+
# [For business and education](#tab/business)
1618

17-
## OneDrive
19+
Office Scripts are stored in your OneDrive by default. The **.osts** files are found in the **/Documents/Office Scripts/** folder. Any edits made to these **.osts** files, such as renaming or deleting files, will be reflected in the Code Editor and Script Gallery. Excel only recognizes and runs a script if it's in your OneDrive folder, a Sharepoint folder, or shared with the workbook. This means Excel needs internet connectivity to access Office Scripts.
1820

19-
The default behavior is that Office Scripts are stored in your OneDrive. The **.osts** files are found in the **/Documents/Office Scripts/** folder. Any edits made to these **.osts** files, such as renaming or deleting files, will be reflected in the Code Editor and Script Gallery.
21+
### OneDrive
2022

2123
Scripts that are shared with one of your workbooks remain in the script creator's OneDrive. They are not copied to any of your local or OneDrive folders when you run the shared script in Excel. The **Move** button shown when renaming a script moves the script to a new location. The **Make a Copy** button of the Code Editor saves a separate copy of the script in your OneDrive. Changes to the copy don't affect the original script.
2224

2325
Unless you share your personal scripts, no one else can access them. Your OneDrive settings control the shared access and permissions for all script **.osts** files, independent of any Excel settings. Scripts can't be linked from a local disk or custom cloud locations.
2426

25-
## SharePoint
27+
### SharePoint
2628

2729
Office Scripts that are saved to a SharePoint site are owned by your team. You and members of your organization with the appropriate access can run and edit scripts from SharePoint. You'll also see these scripts appear in the **Automate** tab's Script Gallery.
2830

@@ -38,20 +40,61 @@ To save a copy of a script to SharePoint, go to the **More options (…)** menu
3840
> [!NOTE]
3941
> Power Automate supports running scripts stored on SharePoint with the **Run script from SharePoint library (Preview)** action. This action is currently in preview and is subject to change based on feedback. If you encounter any issues with this action, please report them through the **Help** > **Give Feedback** option in Power Automate.
4042
43+
# [For personal and family](#tab/home)
44+
45+
Scripts are stored in your local Office cache. The cache is in the following folder.
46+
47+
```
48+
%LOCALAPPDATA%\Microsoft\Office\16.0\Wef\
49+
```
50+
51+
---
52+
53+
## Share scripts
54+
55+
# [For business and education](#tab/business)
56+
57+
To give users who are outside of the SharePoint site access to the script, [share the script with an Excel workbook](excel.md#share-office-scripts). This means you're linking the script with the file, not attaching it. Whoever has access to the Excel file will also be able to view, run, or make a copy of the script.
58+
59+
> [!NOTE]
60+
> Admin settings for Conditional Access in OneDrive and SharePoint affect Office Scripts. For more information, see the [Conditional Access section of Platform limits and requirements with Office Scripts](../testing/platform-limits.md#conditional-access).
61+
62+
# [For personal and family](#tab/home)
63+
64+
Scripts can't be shared through workbooks with a home or family account. You can manually share the code, but it's not possible to share a script in Excel or receive notifications when it has been changed or updated.
65+
66+
---
67+
4168
## Restore deleted scripts
4269

70+
# [For business and education](#tab/business)
71+
4372
When you delete a script in Excel, it goes to your OneDrive or SharePoint recycle bin. To restore a deleted script, follow the steps listed in [How to recover missing, deleted or corrupted items in SharePoint and OneDrive for work or school](https://support.microsoft.com/office/3d748edf-c072-46c9-81a4-4989056ebc87). Restoring an **.osts** file returns it to the **All scripts** list.
4473

4574
A deleted script is unshared with the workbook. When you restore a script, it does **not** retain its script access. You will need to share the script again.
4675

4776
Restored scripts still work as expected with Power Automate flows. You don't need to recreate the flow connector.
4877

78+
# [For personal and family](#tab/home)
79+
80+
Office Scripts are deleted permanently when removed in Excel. This behavior will change before the feature leaves the preview phase.
81+
82+
---
83+
4984
## File ownership and retention
5085

86+
# [For business and education](#tab/business)
87+
5188
Office Scripts follow the retention and deletion policies specified by Microsoft OneDrive and Microsoft SharePoint. To learn how to handle scripts that were created and shared by a user being removed from your organization, see [Learn about retention for SharePoint and OneDrive](/microsoft-365/compliance/retention-policies-sharepoint?view=o365-worldwide&preserve-view=true).
5289

5390
During editing, files are temporarily stored in the browser. You must save the script before closing the Excel window to save it to the OneDrive location. Don't forget to save the file after edits, or else those edits will only be in the browser's version of the file.
5491

92+
# [For personal and family](#tab/home)
93+
94+
Clearing the Office cache will remove all your scripts. Be sure to manually save your scripts elsewhere if the cache needs to be cleared.
95+
96+
---
97+
5598
## Audit Office Scripts usage at the admin level
5699

57100
Discover who is using Office Scripts in your organization with the compliance center audit log. Details about the audit log are found in [Search the audit log in the Security & Compliance Center](/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance?view=o365-worldwide&preserve-view=true#search-the-audit-log).

docs/testing/platform-limits.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ There are some platform limitations of which you should be aware when developing
1414

1515
[!INCLUDE [Platform requirements](../includes/platform-requirements.md)]
1616

17+
> [!NOTE]
18+
> If you meet these requirements and are still not seeing the **Automate** tab, it's possible that your admin has disabled the feature or there's some other problem with your environment. Please follow the steps under [Automate tab not appearing or Office Scripts unavailable](../testing/troubleshooting.md#automate-tab-not-appearing-or-office-scripts-unavailable) to start using Office Scripts.
19+
20+
To use Office Scripts in [Power Automate](https://make.powerautomate.com), you must have a business license of Microsoft 365.
21+
1722
## Data limits
1823

1924
There are limits on how much Excel data can be transferred at once and how many individual Power Automate transactions can be conducted.

docs/testing/power-automate-troubleshooting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Power Automate runs scripts on your behalf in independent Excel sessions. This c
1313
> [!TIP]
1414
> If you're just starting to use Office Scripts with Power Automate, please start with [Run Office Scripts with Power Automate](../develop/power-automate-integration.md) to learn about the platforms.
1515
16+
[!INCLUDE [Power Automate needs a business license](../includes/power-automate-needs-business.md)]
17+
1618
## Avoid relative references
1719

1820
Power Automate runs your script in the chosen Excel workbook on your behalf. The workbook might be closed when this happens. Any API that relies on the user's current state, such as `Workbook.getActiveWorksheet`, may behave differently in Power Automate. This is because the APIs are based on a relative position of the user's view or cursor and that reference doesn't exist in a Power Automate flow.

0 commit comments

Comments
 (0)