Merge pull request #709 from OfficeDev/main

AlexJerabek · web-flow · commit be1880c56c66 · 2024-01-25T16:09:21.000-08:00
[admin] Publish
diff --git a/.github/ISSUE_TEMPLATE/1_documentation-issue.md b/.github/ISSUE_TEMPLATE/1_documentation-issue.md
@@ -0,0 +1,17 @@
+---
+name: Documentation issue
+about: Tell us about a problem in the documentation
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Article URL**
+On what page did you find the problem?
+
+**Describe the problem**
+A clear and concise description of what is incorrect, unclear, or missing in the document.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
diff --git a/.github/ISSUE_TEMPLATE/2_sample-request.md b/.github/ISSUE_TEMPLATE/2_sample-request.md
@@ -0,0 +1,14 @@
+---
+name: Sample request
+about: Which features would you like to see more of?
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe your scenario**
+What is the problem to solve?
+
+**Which APIs or Excel features?**
+What should be showcased in the sample? Are there Excel features that need samples to better understand how to use them in scripts?
diff --git a/.github/ISSUE_TEMPLATE/3_customer-feedback.yml b/.github/ISSUE_TEMPLATE/3_customer-feedback.yml
@@ -0,0 +1,66 @@
+name: "📄 Feedback control template"
+title: "Feedback"
+description: >-
+  ⛔ This template is intended for use by the feedback control on the bottom of every page on the
+  live site. If you aren't using the feedback control, choose one of the other templates.⛔
+body:
+  - type: markdown
+    attributes:
+      value: "## 🎁Enter your feedback🎁"
+  - type: markdown
+    attributes:
+      value: Select the issue type, and describe the issue in the text box below. Add as much detail as needed to help us resolve the issue.
+  - type: dropdown
+    id: issue-type
+    attributes:
+      label: Type of issue
+      options:
+        - Typo
+        - Code doesn't work
+        - Missing information
+        - Outdated article
+        - Other (describe below)
+    validations:
+      required: true
+  - type: textarea
+    id: userfeedback
+    validations:
+      required: true
+    attributes:
+      label: Feedback
+      description: >-
+        If possible, please provide extended details that will add context and help the team update
+        the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
+        For technical or factual errors, please include code snippets and output to show how the
+        documentation is incorrect.
+  - type: markdown
+    attributes:
+      value: "## 🚧 Article information 🚧"
+  - type: markdown
+    attributes:
+      value: "*Don't modify the following fields*. They are automatically filled in for you. Doing so will disconnect your issue from the affected article. *Don't edit them*."
+  - type: input
+    id: pageUrl
+    validations:
+      required: true
+    attributes:
+      label: Page URL
+  - type: input
+    id: contentSourceUrl
+    validations:
+      required: true
+    attributes:
+      label: Content source URL
+  - type: input
+    id: author
+    validations:
+      required: true
+    attributes:
+      label: Author
+      description: GitHub Id of the author
+  - type: input
+    id: documentVersionIndependentId
+    validations:
+      required: true
+    attributes:
+      label: Document Id
diff --git a/Issue_Template.md b/Issue_Template.md
diff --git a/docs/develop/power-automate-integration.md b/docs/develop/power-automate-integration.md
@@ -2,7 +2,7 @@
 title: Run Office Scripts with Power Automate
 description: How to get Office Scripts for Excel working with a Power Automate workflow.
 ms.topic: integration
-ms.date: 11/29/2023
+ms.date: 01/19/2024
 ms.localizationpriority: medium
 ---
 
@@ -12,6 +12,9 @@ ms.localizationpriority: medium
 
 [!INCLUDE [Power Automate needs a business license](../includes/power-automate-needs-business.md)]
 
+> [!TIP]
+> Looking to automatically run a script without connecting to other apps? Use the [Script scheduling](../overview/excel.md#schedule-scripts-to-run-automatically) feature.
+
 ## Get started
 
 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.
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -39,7 +39,7 @@
       "uhfHeaderId": "office-scripts",
       "searchScope": ["Office Scripts"],
       "breadcrumb_path": "/office/dev/scripts/breadcrumb/toc.json",
-      "feedback_system": "GitHub",
+      "feedback_system": "OpenSource",
       "feedback_github_repo": "OfficeDev/office-scripts-docs",
       "feedback_product_url": "/answers/tags/321/office-development",
       "ms.suite": "office",
@@ -48,6 +48,10 @@
       "ms.topic": "conceptual",
       "ms.subservice": "scripts",
       "ms.service": "excel",
+      "open_source_feedback_contributorGuideUrl": "https://github.com/OfficeDev/office-scripts-docs/blob/main/Contributing.md",
+      "open_source_feedback_issueTitle": "",
+      "open_source_feedback_issueUrl": "https://github.com/OfficeDev/office-scripts-docs/issues/new?template=3_customer-feedback.yml",
+      "open_source_feedback_productName": "Office Scripts",
       "titleSuffix": "Office Scripts"
     },
     "fileMetadata": {
diff --git a/docs/images/schedule-a-script.png b/docs/images/schedule-a-script.png
diff --git a/docs/includes/platform-requirements.md b/docs/includes/platform-requirements.md
@@ -3,7 +3,6 @@ To use Office Scripts, you'll need the following.
 # [For business and education](#tab/business)
 
 1. Excel for Windows (version 2210 or higher), Excel for Mac, or Excel on the web.
-    - *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).*
 1. OneDrive for Business.
 1. Any commercial or educational Microsoft 365 license with access to the Microsoft 365 Office desktop apps, such as:
     - Office 365 Business
diff --git a/docs/overview/excel.md b/docs/overview/excel.md
@@ -2,7 +2,7 @@
 title: Office Scripts in Excel
 description: A brief introduction to the Action Recorder and Code Editor for Office Scripts.
 ms.topic: overview
-ms.date: 12/22/2023
+ms.date: 01/19/2024
 ms.localizationpriority: high
 ---
 
@@ -54,6 +54,14 @@ Add buttons that run scripts to help your colleagues discover your valuable solu
 > [!NOTE]
 > Learn more about how scripts are stored in your OneDrive in [Office Scripts file storage and ownership](script-storage.md).
 
+## Schedule scripts to run automatically
+
+Set your scripts to run every day and keep your workbook up-to-date. Once you have your script, you can set it to automatically run on the workbook at regular intervals. A behind-the-scenes Power Automate flow ensures everything happens, even when the workbook is closed.
+
+To schedule a script, open the script in the Code Editor. Open the **Script scheduling** section and complete the sign in process to Excel through Power Automate. Set how often you want the script to run and select **Create flow** to begin.
+
+:::image type="content" source="../images/schedule-a-script.png" alt-text="The Code Editor task pane that shows the recurrence interval options for scheduling a script.":::
+
 ## Connect Office Scripts to Power Automate
 
 [Power Automate](https://make.powerautomate.com/) is a service that helps you create automated workflows between multiple apps and services. Office Scripts can be used in these workflows, giving you control of your scripts outside of the workbook. You can run your scripts on a schedule, trigger them in response to emails, and much more. Visit the [Run Office Scripts with Power Automate](../tutorials/excel-power-automate-manual.md) tutorial to learn the basics of connecting these automation services.
diff --git a/docs/resources/samples/convert-csv.md b/docs/resources/samples/convert-csv.md
@@ -1,7 +1,7 @@
 ---
 title: Convert CSV files to Excel workbooks
 description: Learn how to use Office Scripts and Power Automate to create .xlsx files from .csv files.
-ms.date: 01/04/2024
+ms.date: 01/17/2024
 ms.localizationpriority: medium
 ---
 
@@ -43,25 +43,26 @@ function main(workbook: ExcelScript.Workbook, csv: string) {
   const csvMatchRegex = /(?:,|\n|^)("(?:(?:"")*[^"]*)*"|[^",\n]*|(?:\n|$))/g
   rows.forEach((value, index) => {
     if (value.length > 0) {
-        let row = value.match(csvMatchRegex);
+      let row = value.match(csvMatchRegex);
     
-        // Check for blanks at the start of the row.
-        if (row[0].charAt(0) === ',') {
-          row.unshift("");
-        }
-    
-        // Remove the preceding comma.
-        row.forEach((cell, index) => {
-          row[index] = cell.indexOf(",") === 0 ? cell.substr(1) : cell;
-        });
-    
-        // Create a 2D array with one row.
-        let data: string[][] = [];
-        data.push(row);
+      // Check for blanks at the start of the row.
+      if (row[0].charAt(0) === ',') {
+        row.unshift("");
+      }
+  
+      // Remove the preceding comma and surrounding quotation marks.
+      row.forEach((cell, index) => {
+        cell = cell.indexOf(",") === 0 ? cell.substring(1) : cell;
+        row[index] = cell.indexOf("\"") === 0 && cell.lastIndexOf("\"") === cell.length - 1 ? cell.substring(1, cell.length - 1) : cell;
+      });
     
-        // Put the data in the worksheet.
-        let range = sheet.getRangeByIndexes(index, 0, 1, data[0].length);
-        range.setValues(data);
+      // Create a 2D array with one row.
+      let data: string[][] = [];
+      data.push(row);
+  
+      // Put the data in the worksheet.
+      let range = sheet.getRangeByIndexes(index, 0, 1, data[0].length);
+      range.setValues(data);
     }
   });
 
@@ -186,3 +187,14 @@ If your file has hundreds of thousands of cells, you could reach the [Excel data
 Files with unicode-specific characters, such as accented vowels like `é`, need to be saved with the correct encoding. Power Automate's OneDrive connector file creation defaults to ANSI for .csv files. If you're creating the .csv files in Power Automate, you'll need to add the [byte order mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark) before the comma-separated values. For UTF-8, replace the file contents for the write .csv file operation with the expression `concat(uriComponentToString('%EF%BB%BF'), <CSV Input>)` (where `<CSV Input>` is your original CSV data).
 
 Note that this sample doesn't create the .csv files in the flow, so this change needs to happen in your custom part of the flow. You could also read and rewrite the .csv files with the BOM, if you don't control how those files are created.
+
+### Surrounding quotation marks
+
+This sample removes any quotation marks ("") that surround values. These are typically added to comma-separated values to prevent commas in the data from being treated as separation tokens. A .csv file that is opened in Excel, then saved as a .xlsx file, will never have the those quotation marks shown to the reader. If you wish to keep the quotation marks and have them be displayed in the final spreadsheets, replace lines 27-30 of the script with the following code.
+
+```typescript
+// Remove the preceding comma.
+row.forEach((cell, index) => {
+  row[index] = cell.indexOf(",") === 0 ? cell.substring(1) : cell;
+});
+```
diff --git a/docs/testing/troubleshooting.md b/docs/testing/troubleshooting.md
@@ -2,7 +2,7 @@
 title: Troubleshoot Office Scripts
 description: Debugging tips and techniques for Office Scripts, as well as help resources.
 ms.topic: troubleshooting-general
-ms.date: 12/22/2023
+ms.date: 01/23/2024
 ms.localizationpriority: medium
 ---
 
@@ -86,6 +86,14 @@ The following steps should help troubleshoot any problems related to the **Autom
 > [!NOTE]
 > There is a known issue that prevents scripts stored in SharePoint from always appearing in the recently used list. This occurs when your admin turns off Exchange Web Services (EWS). Your SharePoint-based scripts are still accessible and usable through the file dialog.
 
+## Problems scheduling a script
+
+Scheduling a script requires a business license for Microsoft 365. This is needed for the Power Automate flow that powers the scheduled script. Errors from this flow are shown when there are problems scheduling. You may need to manually update your flow in [Power Automate](https://make.powerautomate.com), where it will be listed under **My flows**.
+
+The following list shows common errors you might encounter.
+
+- **The access token expiry UTC time is earlier than current UTC time.**: Too much time has passed between signing into the service and scheduling the script. Reopen the script in the Code Editor or reload the workbook and try to schedule again.
+
 ## Help resources
 
 [Stack Overflow](https://stackoverflow.com/questions/tagged/office-scripts) is a community of developers willing to help with coding problems. Often, you'll be able to find the solution to your problem through a quick Stack Overflow search. If not, ask your question and tag it with the "office-scripts" tag. Be sure to mention you're creating an Office *Script*, not an Office *Add-in*.
