Contents x
      365|2CM User Manual 2.1.16
      • 23 Feb 2023
      • 13 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      365|2CM User Manual 2.1.16

      • Updated on 23 Feb 2023
      • 13 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      AUTHENTICATION AND ACCESS

      The 365|2CM application uses Azure AD authentication to validate the user’s credentials. Users will be required to enter their Microsoft 365 login details to sign into the application. The user's 365 login will need to be populated on their Content Manager profile so that the authenticated user can connect to Content Manager, this is done using the alternate login field.

      Note

      Only Content Manager Administrators, Record Managers and users added to the basic access list in the admin console can access 365|2CM. This excludes the Teams Chat area which is open to all users as it's user-specific.

      image.png

      LAUNCHING THE APP

      Note

      If this is your first time launching the application your browser may be blocking the sign-in pop-up. Check for this icon in the top right of your browser and allow the pop-up.
      2022-05-03_17-04-57.jpg

      1. Open a web browser and navigate to the 365|2CM address
      2. Sign in using your Microsoft Account. This account must belong to the Microsoft Tenant used during the installation of FYB 365|2CM
        2021-08-10_12-32-43.jpg
      3. After a successful sign in, the app will load
        2023-02-16_10-53-45.png

      DROP-DOWN MENU

      The drop-down menu allows you to navigate to different areas of the application, each navigation item is explained below. Further detail can be found under the corresponding heading throughout this document.
      2023-02-16_10-55-11.png

      • Home – Displays a list of all current connections
      • Activities – Displays a list of documents that have been recently transferred
      • Sites – Displays all sites on SharePoint/Teams/OneDrive the user has access to
      • Network Share - Allows configuration of network shares
      • Teams Chats - Displays a list of your Teams Chats and allows for archiving of Teams Chats
      • Sign out - Sign out of the application

      HOME

      The home screen displays a list of connected document libraries. Initially, this screen will be blank as there are no connected libraries.
      2023-02-16_10-53-45.png

      The action icons allow you to perform a certain function on each document library, details of each action are explained below.

      FILTERING

      Connections can be filtered by the following:

      Using the Search Bar to filter connections by their Display Name
      image.png

      Created Date
      2022-12-15_16-16-43.png

      Connection Type (either connections made by you or all connections)
      2022-12-15_16-18-09.png

      Source
      2022-12-15_16-19-10.png

      Use the Clear Filters button to clear the currently set filters.

      Connections can also be sorted by clicking on the Column headings.

      INSTANT ARCHIVE

      If there is ever a need to instantly process all documents outside of the scheduled period the instant process button can be used.
      image.png

      DELETE CONNECTION

      You can remove a connection by pressing the bin icon, once deleted the document library will no longer be processed by the background schedular.
      image.png

      CONFIGURE

      The configure action allows you to quickly adjust the current settings.
      image.png

      CONTENT MANAGER FOLDER

      The CM folder action allows you to view the connected CM folder.
      image.png

      NAVIGATING TO THE DOCUMENT LIBRARY

      You can navigate to the desired document library on SharePoint by clicking on the name of the library, this will launch an external browser window that takes you to the document library itself.
      2022-01-31_14-03-32.png

      STATUS

      The status column determines whether the document library should be processed by the background service. The status can be updated via the settings screen.
      2022-01-31_14-04-29.png

      ACTIVITIES

      The activities screen displays all transactions recorded by the background process over time with the most recent transaction appearing at the top. You will find information on each transaction such as the document origin (where it came from on SharePoint), the date it was processed, and whether the document was a new revision or a new record that was created.
      2023-02-16_10-58-56.png

      SEARCH BAR

      The search bar will allow you to quickly search for transactions based on the search criteria such as Extension, Record Number, Title and Site.
      2022-03-18_14-36-03.png

      DATES FILTERING

      Use the Date filters Dropdown to search for Activities within a certain Date Range.
      2023-02-16_11-01-00.png

      SITES

      The sites screen displays all SharePoint/Teams sites for the organization that the logged in user has access to.
      2022-03-18_14-36-58.png

      SEARCH BAR

      The search bar allows you to search for specific sites.
      2022-03-18_14-39-58.png

      In addition to searching, you can view all favourite sites by clicking on the favourite icon.

      FAVOURITE SITE

      Any site can be added to your favourite list by clicking on the star icon and to unfavourite simply click the icon again.
      2022-03-18_14-39-58.png

      CONNECTING A DOCUMENT LIBRARY

      To connect a document library to Content Manager please follow the steps below:

      1. Click on the arrow icon on the desired site
        2022-01-28_17-10-02.png

      2. This will display all document libraries associated with the site
        2023-02-16_11-04-32.png

      3. Select the desired document library you wish to connect by clicking on the plug icon
        image.png

      4. You will be redirected to the configuration screen
        2022-01-31_14-09-39.png

      5. Provide the record number for the CM container you wish to connect to, this can be searched for by number, title or URI
        2022-01-31_14-16-52.png

      Alternatively, you can create a new folder by pressing on the New Container button, this will redirect you to the create a new container screen.
      image.png

      1. Select the desired document record type from the drop-down menu
        2022-01-31_14-24-33.png
      Warning

      365|2CM does not support record types that have a mandatory additional field with the search clause value "DocumentType". This is because of a conflict with the Content Manager SDK.

      1. Enable or Disable Create Folder Structure. This will replicate the folder structure found in the SharePoint Library. If this option is not enabled, folders will not be created and all documents will be uploaded to the root container selected in step 5
        2022-01-28_17-24-03.png

      2. Enable or Disable Select Folders
        2022-01-28_17-25-50.png

      Enabling Select Folders will allow you to specify which folders you would like to archive during the archive process by selecting the adjacent checkboxes. Clicking on a folder will display its child folders (if any).

      image.png

      1. Select the document inactivity period from the drop-down menu. This is how long a document must be inactive before the connector will move it to CM
      Note

      If none is selected, the inactivity period is ignored

      2022-08-31_15-50-15.png

      1. Select the run frequency from the drop-down menu. This is function determines how often the background process will run and transfer documents
        2023-02-16_11-05-47.png
      NAMEDESCRIPTION
      HourlyThe connection will archive documents every hour.
      DailyThe connection will archive documents daily at 7:00 AM.
      WeeklyThe connection will archive documents once a week on Monday at 7:00 AM.
      MonthlyThe connection will archive documents on the first day of every month at 7:00 AM.

      1. Enable or disable the** Delete Document **option to remove documents from the source after the transfer has completed.
        2022-01-31_12-05-58.png

      2. Enable or disable the** Leave TR5** option (This option will only appear if the delete option is enabled). The Leave TR5 option allows you to leave a Content Manager reference file after deleting the document from the document library
        2022-01-31_12-07-54.png

      3. Enable or disable the Finalize Record option (This option will only appear if the delete option is enabled). The Finalize Record option allows you to finalize the record after deleting the document from the document library
        2022-01-31_12-08-25.png

      4. Enable or disable the Background Processing option this allows the background service to automatically archive the library periodically without user intervention
        2022-01-31_12-09-04.png

      5. The Restrict File Types section allows you to enter any file types that you do not want to migrate to Content Manager. For example, if you do not want mp4 and text files to be migrated, enter a comma-separated list of these extensions: .mp4,.txt
        2022-01-31_14-27-37.png

      6. The Configure Columns section allows you to map SharePoint fields to Content Manager fields and push across the data
        2022-01-31_14-32-52.png

      7. Once you’re happy with the configuration, click the Save button at the bottom to save the connection
        image.png

      8. You will notice on the home screen that the document library is now registered, and it’s now possible to perform various actions with the connected document library.
        2022-12-15_16-08-17.png

      SPECIFYING A RECORD TYPE FOR SUBFOLDERS

      To specify a different Container Record Type for creating subfolders, follow the steps below:

      1. Enable the Create Folder Structure option
        2022-01-31_14-34-32.png

      2. Enable the Choose Subfolder Record Type option
        2022-01-31_14-35-37.png

      3. Select a Record Type
        2022-01-31_14-36-16.png

      4. Selecting a Record Type will display the mandatory fields required for that Record Type
        2022-01-31_14-37-34.png

      5. Enabling the Alternatively Contain Subfolders will create alternatively contained relationships between the subfolders. If this is disabled, then sub containers will be contained within each other

      SUGGESTED CLASSIFICATIONS

      If the ENABLE CLASSIFICATION SUGGESTIONS admin option is enabled, 365|2CM will suggest a list of classifications to use based on the names of Files and Folders in a Sharepoint Document Library.

      1. In the Configuration Page of a Sharepoint Connection, click on the New Container button
        2023-01-09_10-17-00.png

      2. Select a Record Type
        2023-02-16_11-11-53.png

      3. If the selected Record Type has a classification field, 365|2CM will generate a list of Classifications based on the File and Folder names within the Document Library
        2023-01-09_10-18-19.png

      4. Select a classification and click the Ok button
        2023-01-09_10-20-33.png

      5. The Classification field will be populated with the selected Classification
        2023-01-09_10-23-11.png

      ONE-TO-ONE CONNECTIONS

      Connections can also be made directly to Sharepoint Folders within a Site Library

      1. Click on the Name or Display Name of a site library
        2022-12-15_16-33-00.png

      2. Here, you can either create a connection to any of the displayed folders or click on the Name or Display Name of any of the folders to display its subfolders
        2022-12-15_16-37-41.png
        2022-12-15_16-38-26.png

      CONNECTING A NETWORK SHARE

      1. Navigate to the Network Share option in the left menu
        2022-01-28_17-36-17.png

      2. Search for a shared folder using the UNC shared path e.g. \server-name\fyb\my shared folder$
        2022-04-29_9-55-37.png

      Note

      Ensure the account running the app pool has full permission to the shared drive

      1. All folders at the network share path will be displayed
      2. Click on any listed folder and configure the connection. The configuration steps are identical to those listed in the CONNECTING A DOCUMENT LIBRARY section of this guide

      CAPTURING TEAMS CHANNEL POSTS

      Note

      Sites that originate from Microsoft Teams have an additional option to capture Teams channel posts.

      1. Navigate to the SITES page and search for a site that is associated with a Microsoft Team, click on this site
        2022-01-28_17-46-32.png

      2. Select the documents drive
        2022-01-28_17-49-50.png

      3. Enable the ARCHIVE TEAMS CHANNEL POSTS option. This option is only available for drives associated with a Microsoft Team
        2022-01-28_17-50-54.png

      CONFIGURATION

      2022-01-28_17-54-13.png

      To capture Teams Posts from the channel as PDF Records, the following settings will need to be configured.

      NAMEDESCRIPTION
      TITLE PLACE HOLDERSpecify placeholders for the title that will be used when creating Records from Teams Posts, see the TITLE PLACEHOLDERS section for more information.
      PDF TEMPLATESpecify the record number of the word template to be used when capturing Teams posts. See the PDF WORD TEMPLATE section for more information.
      SELECT CHANNELSIf enabled, you can select which channels to archive posts from. If disabled, all posts from all channels are archived.

      TITLE PLACEHOLDERS

      The following placeholders can be used in the Title Placeholder field. This will be replaced with the actual data coming from the Teams Post when creating the Record.

      PlaceholderData
      {TEAM_NAME}Name of the Team
      {CHANNEL_NAME}Name of the Teams Channel
      {SUBJECT}The Teams Post subject
      {ID}The Teams Post Id

      TEAMS POST TEMPLATE

      A Microsoft Word template is required for generating PDFs for Teams Posts. The following placeholders can be used to capture data coming from the Teams Posts. The template must be stored in Content Manager.

      PlaceholderData
      {TEAM_NAME}Name of the Team
      {CHANNEL_NAME}Name of the Teams Channel
      {SUBJECT}The Teams Post subject
      {BODY}The body content of the Teams Post
      {DATE_CREATED}The date created of the Teams post
      {DATE_MODIFIED}The date last modified of the Teams Post
      {AUTHOR}The display name of the author of the Teams Post
      {REACTIONS_COUNT}The number of reactions that the Teams Post received
      {ID}The Id of the Teams Post
      {REPLIES}All replies to the Teams Post
      {ATTACHMENTS}All image/gif attachments of the Teams Posts
      {POST_URL}Url to the post in Teams. This will be rendered as a hyperlink labelled "View Post"
      {NUMBER_OF_MEMBERS}The number of members in the Team
      {DATE_EDITED}The date the post was last edited
      {DATE_DELETED}The date the post was deleted on
      {REPLY_ID}The ID of the parent message/post
      {ETAG}Version number of the chat message
      {SUMMARY}Summary text of the chat message
      {MENTIONS}A comma separated list of mentions in the post
      {IMPORTANCE}The importance of the post. The possible values are: normal, high, urgent
      {LOCALE}Locale of the post set by the client. Always set to en-us.
      {CHANNEL_ID}The Id of the Channel
      {TEAM_ID}The Id of the Team
      {REACTIONS}Comma separated list of reactions on the post

      An example Word Template:
      2023-02-16_11-15-14.png

      CAPTURING TEAMS CHAT MESSAGES

      This feature is open to all users and allows each user to archive their personal Teams Chats as PDFs to Content Manager. The Teams Chats page can be navigated to by clicking on Teams Chats.
      2023-01-06_9-34-09.png

      2023-02-16_11-16-02.png

      NAMEDESCRIPTION
      Chat Display Name2023-01-06_9-37-33.png
      The Name of the Teams chat, clicking on the Display name will open the Chat in Teams
      Last UpdatedThe date that the Teams Chat was last updated
      Last ArchivedThe date that the Teams Chat was last Archived to Content Manager
      Chat TypeThe type of the Teams chat
      StatusThe background scheduler status (either On, Off or Not Configured)
      2023-01-06_9-42-32.pngConfigure a connection to a Teams Chat to enable archiving
      image.pngInstant archiving - Instantly archive a Teams chat within a given date range as a PDF to Content Manager.
      image.pngDelete Configuration - Deletes the configuration to a Teams Chat
      image.pngConfigure - Adjust the current configuration settings for the Teams Chat
      image.pngThe CM folder action allows you to view the connected CM folder

      CONFIGURATION

      To configure a new connection to a Teams Chat:

      1. Click on the plug Icon
        2023-01-06_9-52-20.png

      2. You will be redirected to the configuration screen
        2023-01-06_9-54-02.png

      3. Provide the record number for the CM container you wish to store that chat within, this can be searched for by number, title or URI

      2022-01-31_14-16-52.png
      Alternatively, you can create a new folder by pressing on the New Container button, this will redirect you to the create a new container screen.
      image.png

      1. Select the desired document record type from the drop-down menu
        2022-01-31_14-24-33.png

      2. Select a template Record for creating PDFs. This record must be a Word document. See the Teams Chat Template for more information
        2023-01-06_10-00-42.png

      3. Specify placeholders for the title that will be used when creating Records from Teams Chats. The following placeholders can be used in the Title:

      PLACEHOLDERDESCRIPTION
      {CHAT_ID}The ID of the Teams Chat
      {RECIPIENT}The recipient's name in the Chat
      {DATE_CREATED}The Chat's creation date
      {DATE_LAST_UPDATED}The Chat's last updated date
      1. Specify if automated archiving of the Teams Chat should be enabled (Optional)
      Note

      If this option is enabled then the user must upload the 365|2CM Teams Chat Capture app package to their instance of Teams - See AUTOMATED TEAMS CHAT ARCHIVING for more details.

      2023-01-06_10-17-32.png

      1. If BACKGROUND PROCESSING is enabled, then the archiving frequency must be selected
        2023-01-06_10-01-33.png
      NAMEDESCRIPTION
      HourlyThe connection will archive chats hourly. Only chats made in the last hour will be captured.
      DailyThe connection will archive chats daily at 7:00AM. Only Chats made in the past 24 hours will be captured
      WeeklyThe connection will archive chats once a week on Monday at 7:00AM. Only chats made in the past week will be captured.
      MonthlyThe connection will archive chats on the first day of every month at 7:00AM. Only chats made in the past month will be captured.

      1. Toggle the Include Source In Notes (Optional). If enabled, the URL of the Teams chat is added to the Record's notes
        2023-01-06_10-20-18.png

      2. Once all the settings have been configured, click on the Save button
        2023-01-06_10-21-59.png

      TEAMS CHAT TEMPLATE

      A Microsoft Word template is required for generating PDFs for Teams Chats. The following placeholders can be used to capture data coming from the Teams Posts. The template must be stored in Content Manager.

      PlaceholderData
      {CHAT_ID}The ID of the Teams Chat
      {RECIPIENT}The recipient's name in the Chat
      {LINK}A hyperlink to the Chat in Teams
      {DATE_CREATED}The Chat's creation date
      {DATE_LAST_UPDATED}The Chat's last updated date
      {CONVERSATION}The conversation between members in the Teams Chat

      AUTOMATED TEAMS CHAT ARCHIVING (OPTIONAL)

      Note

      At this stage, the 365|2CM Teams app can only be run in the Teams Web app in the browser of your choice

      For Teams Chats to be automatically archived, 365|2CM must be created as a Teams Personal Tab App and uploaded to Teams. This is because the user's access token is required to archive their chats without user interaction and without 365|2CM needing to be open in a browser.

      1. Obtain a copy of the 365|2CM Teams Chat app package from your IT Teams administrator

      2. Open Microsoft Teams

      3. Click on Apps then click Manage Your Apps
        2023-01-06_11-18-35.png

      4. Click on Upload an app
        2023-01-06_11-23-02.png

      5. Click Upload a custom app
        2023-01-06_11-24-12.png

      6. Locate the 365|2CM Teams Chat app package and click Open
        2023-01-06_11-25-09.png

      7. Click Add
        2023-01-06_11-27-42.png

      8. 365|2CM will be added as a Personal Tab App
        2023-01-06_11-29-29.png

      9. Any background processing (automated) teams chats that you have set up will now function

      Was this article helpful?
      What's Next