Merge pull request #61 from Laserfiche/robbie/misc-documentation-items

Robbie/misc documentation items

jekyll_files/CHANGELOG.md

@@ -5,13 +5,13 @@ nav_order: 4
 ---
 # Laserfiche SharePoint Online Integration Changelog
 
-## 1.0.0.280
+## 1.0.0.360
 
 ### Features
 
 - Initial release
-- Ability to save documents to Laserfiche from SharePoint with mapped metadata
-- Ability to view your Laserfiche repository from within SharePoint
+- Ability to save documents in a SharePoint document library to Laserfiche
+- Ability to view your Laserfiche repository from within SharePoint Online
 
 ### Known Issues
 - **488127:** Importing file from repository explorer hits a dead end when invalid metadata is entered
@@ -20,4 +20,7 @@ nav_order: 4
     - **Workaround:** To edit the configuration, click the "Sign In" button.
 - **487980:** If configured Laserfiche template is deleted, profile configuration page does not show a good error.
     - **Workaround:** Delete the profile or reconfigure the metadata of the profile.
+- **490833:** Content Type can't be determined unless column is shown
+    - **Workaround:** Display the `Content Type` column in the Documents tab of the site.
+- **492278:** Image files are saved to Laserfiche as electronic documents
 

jekyll_files/_config.yml

@@ -62,5 +62,5 @@ plugins:
 
 heading_anchors: true
 color_scheme: lf-styles
-favicon_ico: "/assets/favicon.webp"
+favicon_ico: "/assets/favicon.ico"
 

jekyll_files/docs/admin-documentation/adding-app-organization.md

@@ -1,29 +1,25 @@
-<!--Copyright (c) Laserfiche.
-Licensed under the MIT License. See LICENSE in the project root for license information.-->
-
----
-layout: default
-title: Adding App to Organization
-nav_order: 1
-parent: Laserfiche SharePoint Integration Administration Guide
----
-
-# Adding App to Organization
-
-### Prerequisites
-
-- Have a SharePoint Online account with administrator privileges for the tenant app catalog.
-- Download the latest Laserfiche SharePoint Integration [package](../assets/LaserficheSharePointOnlineIntegration.sppkg)
-
-### Steps
-
-1. Navigate to the following url: https://<b>{your-full-subdomain.and-domain.com}</b>/sites/appcatalog/AppCatalog/Forms/AllItems.aspx, where the part in curly braces is replaced by the domain and subdomain of your SharePoint-related websites.
-1. If you can see the "+New" and "Upload" buttons, then proceed to the next step. If not, ask an administrator to [add you as an admin to the SharePoint Online App Catalog](https://learn.microsoft.com/en-us/office365/customlearning/addappadmin#add-an-administrator).
-1. Click Upload and select the Laserfiche SharePoint package file (.sppkg).
-   <a href="../assets/images/uploadSolution.png"><img src="../assets/images/uploadSolution.png"></a>
-1. Click on the Deploy button when prompted to trust the solution.
-   <a href="../assets/images/trustSolution.png"><img src="../assets/images/trustSolution.png"></a>
-
-### Next Steps
-
-Follow the steps for [Adding App to SharePoint Site](./adding-app-to-sp-site)
+<!--Copyright (c) Laserfiche.
+Licensed under the MIT License. See LICENSE in the project root for license information.-->
+
+---
+layout: default
+title: Adding App to Organization
+nav_order: 1
+parent: Laserfiche SharePoint Online Integration Administration Guide
+---
+
+# Adding App to Organization
+
+
+### Prerequisites
+
+- Have a SharePoint Online account with administrator privileges.
+- If you don't wish to use the integration available in the SharePoint Store, download the latest Laserfiche SharePoint Online Integration [package](../assets/LaserficheSharePointOnlineIntegration.sppkg) and add it as a custom app.
+
+### Steps
+
+Follow Microsoft's documentation for [adding apps from the SharePoint Store](https://learn.microsoft.com/en-us/sharepoint/use-app-catalog#add-apps-from-the-sharepoint-store){:target="_blank"} or for [adding custom apps](https://learn.microsoft.com/en-us/sharepoint/use-app-catalog#add-custom-apps){:target="_blank"}.
+
+### Next Steps
+
+Follow the steps for [setting up the app in your SharePoint site](./adding-app-to-sp-site)

jekyll_files/docs/admin-documentation/adding-app-to-sp-site.md

@@ -1,53 +1,44 @@
-<!--Copyright (c) Laserfiche.
-Licensed under the MIT License. See LICENSE in the project root for license information.-->
-
----
-layout: default
-title: Adding App to SharePoint Site
-nav_order: 2
-parent: Laserfiche SharePoint Integration Administration Guide
----
-
-# Adding App to SharePoint Site
-
-### Prerequisites
-
-- Be an owner of a SharePoint site you want to add the integration to.
-- The site must exist in an organization which has the integration installed. (see [Adding App to Organization](./adding-app-organization))
-
-### Steps
-
-1. Go to the SharePoint site that you would like to install the integration on. If you do not have a SharePoint site already, you can find instructions [here](https://support.microsoft.com/en-gb/office/create-a-site-in-sharepoint-4d1e11bf-8ddc-499d-b889-2b48d10b1ce8) on how to create one.
-1. Navigate to the app catalog by clicking on the "Site contents" item in the
-   navigation bar.
-   <a href="../assets/images/sharePointSiteContents.png"><img src="../assets/images/sharePointSiteContents.png"></a>
-1. Open the "New" Dropdown menu by clicking on the "+" icon.
-   <a href="../assets/images/NewDropDown.png"><img src="../assets/images/NewDropDown.png"></a>
-1. Add the App named “Laserfiche SharePoint Online Integration”.
-   <a href="../assets/images/addTheApp.png"><img src="../assets/images/addTheApp.png"></a>
-1. Navigate to your SharePoint site. If successfully installed, the app will be listed under the “Site contents” tab.
-   <a href="../assets/images/appInstalled.png"><img src="../assets/images/appInstalled.png"></a>
-
-### The Laserfiche Sign In Page
-
-1. In your SharePoint site, select the "Pages" item in the navigation bar on the left side of the page.
-   <a href="../assets/images/newSitePage.png"><img src="../assets/images/newSitePage.png"></a>
-1. Create and open a new site page by clicking the "+ New" button and selecting "Site Page" from the dropdown.
-1. Title the page “LaserficheSignIn”.
-1. Move your cursor just below the title area to the white space beneath. This should reveal a hidden "+" button. If you hover over it, it should display the message "Add a new web part in column one”.
-   <a href="../assets/images/hiddenPlusButton.png"><img src="../assets/images/hiddenPlusButton.png"></a>
-1. Click on that button and Search for “Laserfiche Sign In".
-   <a href="../assets/images/searchRepositoryExplorer.png"><img src="../assets/images/searchRepositoryExplorer.png"></a>
-1. Click on the search result with a white L on an orange square. The Laserfiche Sign In web part should now appear on your Page. Before creating subsequent pages, make sure to click the 'Publish' button to save the page.
-
-### The Repository Explorer Page
-
-Follow the same steps as above, but title the Page whatever you wish and add the “Repository Explorer” web part.
-
-### The Admin Configuration Page
-
-Follow the same steps as above, but title the page whatever you wish and add the “Admin Configuration” web part instead of “Laserfiche Sign In".
-
-### Next Steps
-
-Before you can log in and use the web pages you just created, you will need to [Register them in the Laserfiche Developer Console](../admin-documentation/register-app-in-laserfiche). After you register your Apps, you should be able to log in and use the web parts. For Documentation on how to use the integration, reference the [User Documentation](../user-documentation/).
+<!--Copyright (c) Laserfiche.
+Licensed under the MIT License. See LICENSE in the project root for license information.-->
+---
+layout: default
+title: Adding App to SharePoint Site
+nav_order: 2
+parent: Laserfiche SharePoint Online Integration Administration Guide
+---
+
+# Adding App to SharePoint Site
+
+## Adding app via SharePoint store
+### Prerequisites
+
+- Be an owner of a SharePoint site you want to add the integration to.
+
+### Initial Steps
+
+Follow Microsoft's instructions for [adding an app to a site in SharePoint](https://support.microsoft.com/en-us/office/add-an-app-to-a-site-ef9c0dbd-7fe1-4715-a1b0-fe3bc81317cb){:target="_blank"}.
+
+
+### The Laserfiche Sign In Page
+
+1. In your SharePoint site, select the "Pages" item in the navigation bar on the left side of the page.
+   <a href="../assets/images/newSitePage.png"><img src="../assets/images/newSitePage.png"></a>
+1. Create and open a new site page by clicking the "+ New" button and selecting "Site Page" from the dropdown.
+1. Title the page “LaserficheSignIn”.
+1. Move your cursor just below the title area to the white space beneath. This should reveal a hidden "+" button. If you hover over it, it should display the message "Add a new web part in column one”.
+   <a href="../assets/images/hiddenPlusButton.png"><img src="../assets/images/hiddenPlusButton.png"></a>
+1. Click on that button and Search for “Laserfiche Sign In".
+   <a href="../assets/images/searchRepositoryExplorer.png"><img src="../assets/images/searchRepositoryExplorer.png"></a>
+1. Click on the search result with a white L on an orange square. The Laserfiche Sign In web part should now appear on your Page. Before creating subsequent pages, make sure to click the 'Publish' button to save the page.
+
+### The Repository Explorer Page
+
+Follow the same steps as above, but title the Page whatever you wish and add the “Repository Explorer” web part.
+
+### The Admin Configuration Page
+
+Follow the same steps as above, but title the page whatever you wish and add the “Admin Configuration” web part instead of “Laserfiche Sign In".
+
+### Next Steps
+
+Before you can log in and use the web pages you just created, you will need to [Register them in the Laserfiche Developer Console](../admin-documentation/register-app-in-laserfiche). After you register your Apps, you should be able to log in and use the web parts. For Documentation on how to use the integration, reference the [User Documentation](../user-documentation/).

jekyll_files/docs/admin-documentation/configuring-metadata-mappings.md

@@ -1,49 +1,49 @@
-<!--Copyright (c) Laserfiche.
-Licensed under the MIT License. See LICENSE in the project root for license information.-->
-
----
-layout: default
-title: Configuring Metadata Mappings
-nav_order: 4
-parent: Laserfiche SharePoint Integration Administration Guide
----
-
-# Configuring Metadata Mappings
-
-### Prerequisites
-
-- be a Site Owner of the SharePoint Site for which the integration will be configured
-
-## Introduction
-
-You must configure mappings for your site before you can send documents to Laserfiche. Mappings are set based on the SharePoint Content Type of the item you are trying to save. You must set up a mapping for each SharePoint Content Type you use in your site, or set a default mapping for anything not specifically mapped that you would still like to save to Laserfiche.
-
-A mapping allows you to specify options for how to save to Laserfiche for that Content Type, including a destination folder, a template with mapped metadata from SharePoint properties to Laserfiche fields, and what happens in SharePoint once you save to Laserfiche.
-
-## Steps
-
-### Create a Profile
-
-In the "Profiles" tab of the Admin Configuration web part, click on the “Add Profile” button to add a new profile. Click on the pencil icon to edit an existing profile. Either selection will open the Profile Editor View.
-<a href="../assets/images/profileTab.png"><img src="../assets/images/profileTab.png"></a>
-
-### Define the Profile in the Profile Editor
-
-- Name: this is the identifier used to associate SharePoint content types with this profile in the Profile Mapping tab.
-- Laserfiche Template: If a profile is assigned a template, then all files saved to Laserfiche through that profile will be assigned that template in Laserfiche. [Learn more about templates](https://doc.laserfiche.com/laserfiche.documentation/en-us/Content/Fields_and_Templates.html).
-- Laserfiche Destination: This option specifies the path to the folder in the Laserfiche Repository where the files associated with this profile will be saved.
-- After Import: This option specifies what to do with the SharePoint file after exporting it to Laserfiche.
-  <a href="../assets/images/profileEditor.png"><img src="../assets/images/profileEditor.png"></a>
-- Mappings from SharePoint Column to Laserfiche Field Values - This is where the actual metadata transfer is configured. - Each Field in the template can be assigned a SharePoint column, so that when files are exported from SharePoint to Laserfiche, the file in Laserfiche will have a field with the same value as the Column of the file in SharePoint. - templates with required fields MUST have columns assigned to them. - The association between SharePoint columns and Laserfiche fields should be one-to-one, i.e., you should not attempt to map multiple SharePoint columns to the same Laserfiche field.
-  <a href="../assets/images/metadataMapping.png"><img src="../assets/images/metadataMapping.png"></a>
-
-### Map Content Types to Profiles in the Profile Mapping Tab
-
-Displays a list of SharePoint Content Types and their corresponding Laserfiche Profile. If you add a content type/profile pair, then
-any SharePoint content matching that type will be assigned the corresponding profile when you attempt to save the content to Laserfiche.
-<a href="../assets/images/profileMappingTab.png"><img src="../assets/images/profileMappingTab.png"></a>
-
-### Default Profile
-
-If you attempt to save a file to Laserfiche and it does not have a SharePoint Content Type or its SharePoint Content Type is not mapped to any Laserfiche Profile, you will not be able to save that file. You must either create a mapping for each Content Type that will exist on your site or set a default mapping which will apply to any file in SharePoint that does not have a Content Type or does not have a corresponding Laserfiche Profile for its Content Type.
-<a href="../assets/images/defaultMapping.png"><img src="../assets/images/defaultMapping.png"></a>
+<!--Copyright (c) Laserfiche.
+Licensed under the MIT License. See LICENSE in the project root for license information.-->
+
+---
+layout: default
+title: Configuring Metadata Mappings
+nav_order: 4
+parent: Laserfiche SharePoint Online Integration Administration Guide
+---
+
+# Configuring Metadata Mappings
+
+### Prerequisites
+
+- be a Site Owner of the SharePoint Site for which the integration will be configured
+
+## Introduction
+
+You must configure mappings for your site before you can send documents to Laserfiche. Mappings are set based on the SharePoint Content Type of the item you are trying to save. You must set up a mapping for each SharePoint Content Type you use in your site, or set a default mapping for anything not specifically mapped that you would still like to save to Laserfiche.
+
+A mapping allows you to specify options for how to save to Laserfiche for that Content Type, including a destination folder, a template with mapped metadata from SharePoint properties to Laserfiche fields, and what happens in SharePoint once you save to Laserfiche.
+
+## Steps
+
+### Create a Profile
+
+In the "Profiles" tab of the Admin Configuration web part, click on the “Add Profile” button to add a new profile. Click on the pencil icon to edit an existing profile. Either selection will open the Profile Editor View.
+<a href="../assets/images/profileTab.png"><img src="../assets/images/profileTab.png"></a>
+
+### Define the Profile in the Profile Editor
+
+- Name: this is the identifier used to associate SharePoint content types with this profile in the Profile Mapping tab.
+- Laserfiche Template: If a profile is assigned a template, then all files saved to Laserfiche through that profile will be assigned that template in Laserfiche. [Learn more about templates](https://doc.laserfiche.com/laserfiche.documentation/en-us/Content/Fields_and_Templates.html){:target="_blank"}.
+- Laserfiche Destination: This option specifies the path to the folder in the Laserfiche Repository where the files associated with this profile will be saved.
+- After Import: This option specifies what to do with the SharePoint file after exporting it to Laserfiche.
+  <a href="../assets/images/profileEditor.png"><img src="../assets/images/profileEditor.png"></a>
+- Mappings from SharePoint Column to Laserfiche Field Values - This is where the actual metadata transfer is configured. - Each Field in the template can be assigned a SharePoint column, so that when files are exported from SharePoint to Laserfiche, the file in Laserfiche will have a field with the same value as the Column of the file in SharePoint. - templates with required fields MUST have columns assigned to them. - The association between SharePoint columns and Laserfiche fields should be one-to-one, i.e., you should not attempt to map multiple SharePoint columns to the same Laserfiche field.
+  <a href="../assets/images/metadataMapping.png"><img src="../assets/images/metadataMapping.png"></a>
+
+### Map Content Types to Profiles in the Profile Mapping Tab
+
+Displays a list of SharePoint Content Types and their corresponding Laserfiche Profile. If you add a content type/profile pair, then
+any SharePoint content matching that type will be assigned the corresponding profile when you attempt to save the content to Laserfiche.
+<a href="../assets/images/profileMappingTab.png"><img src="../assets/images/profileMappingTab.png"></a>
+
+### Default Profile
+
+If you attempt to save a file to Laserfiche and it does not have a SharePoint Content Type or its SharePoint Content Type is not mapped to any Laserfiche Profile, you will not be able to save that file. You must either create a mapping for each Content Type that will exist on your site or set a default mapping which will apply to any file in SharePoint that does not have a Content Type or does not have a corresponding Laserfiche Profile for its Content Type.
+<a href="../assets/images/defaultMapping.png"><img src="../assets/images/defaultMapping.png"></a>

jekyll_files/docs/admin-documentation/index.md

@@ -1,19 +1,20 @@
-<!--Copyright (c) Laserfiche.
-Licensed under the MIT License. See LICENSE in the project root for license information.-->
-
----
-layout: default
-title: Laserfiche SharePoint Integration Administration Guide
-nav_order: 2
-has_children: true
----
-
-# Laserfiche SharePoint Integration Administration Guide
-
-The following guides detail how to set up the Laserfiche/SharePoint integration. Unlike the user guides, the admin guides
-may require you to hold certain privileges, such as the ability to edit a page on a SharePoint site. Each guide contains important
-information to help you set up the integration. If you are setting up for the first time, we recommend starting at the top.
-
-## Important Security Notice
-
-JavaScript code running in same domain/origin as your SharePoint tenant has access to the Laserfiche Integration security token. This token must be kept secure to avoid unauthorized access to Laserfiche systems. To this end, ensure that only trusted code is allowed to run in the same domain/origin.
+<!--Copyright (c) Laserfiche.
+Licensed under the MIT License. See LICENSE in the project root for license information.-->
+---
+layout: default
+title: Laserfiche SharePoint Online Integration Administration Guide
+nav_order: 2
+has_children: true
+---
+
+# Laserfiche SharePoint Online Integration Administration Guide
+
+The following guides detail how to add the Laserfiche SharePoint Online integration. By default, you must be a tenant administrator to install the integration. Installing the integration involves the following steps:
+1. Adding the integration to your SharePoint organization.
+1. Adding the integration to a SharePoint site.
+1. Configuring authentication between the integration and your Laserfiche Cloud account.
+1. Mapping SharePoint columns and content types to Laserfiche. 
+
+## Important Security Notice
+
+JavaScript code running in same domain/origin as your SharePoint tenant has access to the Laserfiche Integration security token. This token must be kept secure to avoid unauthorized access to Laserfiche systems. To this end, ensure that only trusted code is allowed to run in the same domain/origin.