Latest Documentation
RecordPoint 4.0 Documentation
Records365 Documentation


Documentation for older versions
RecordPoint 3.9 Documentation
RecordPoint 3.8 Documentation


Articles in this version

Page tree
Skip to end of metadata
Go to start of metadata
 Article Contents

Introduction

The System Administrator can create one or more managed Office 365 Sites in the RecordPoint mid-tier via a web service.

Prerequisite

  • An existing RecordPoint Installation
  • An existing RecordPoint Mid-tier set up
  • An existing Office 365 SharePoint site with 365Connect/Records365 set up, deployed and installed
  • 365Connect - The script referenced below for using the API can be found in the C:\Program Files\RecordPointOnline\Scripts folder of a RecordPoint Online installation.
  • Records365 - The script referenced below for using the API and required dlls can be found in the Records365 SDK download.

Creating a RecordPoint managed Office 365 site

This process is equivalent of creating a RecordPoint managed Office 365 site under Sites in the Middle tier.

RecordPoint provides a sample script to call the API. To run the script, perform the following:

  1. In PowerShell run RecordPointOnlineAddManagedSite.ps1
    By default, this is found under C:\Program Files\RecordPointOnline\Scripts

 

Parameters
Username* - The username as entered to login to the RecordPoint Middle Tier 
Email* - The email as entered to login to the RecordPoint Middle Tier 
Password* - The password as entered to login to the RecordPoint Middle Tier 
ServiceUrl* - The Url of the RecordPoint Middle Tier.
SiteUrl* - The Url of SharePoint Online site to be managed
SubmissionType* - The type of submission performed by RecordPoint for the site to be added. Input is limited to “SubmitStub” or “Submit”.
AggregationType* - The level of aggregation for the site to be added. Input is limited to "Site", "LowestLevelSubSite", "List", "ListOrTopMostFolder", and "ListOrLowestLevelFolder"
FinaliseType* - The type of finalisation carried out when item is finalised for the site to be added. Input is limited to "Finalise" or "FinaliseArchive"
AuditLibrary - The location of the document library containing audit data for the site to be added
This API does not support editing or deleting an existing managed Site in the mid-tier.
RecordNumberField - The name of the field used for writing the Record Number back to Office 365.
SubmitMinorVersions - Specifies if minor versions should be submitted to RecordPoint
SubmitFirstMinorVersion - Specifies if the first minor version should be submitted to RecordPoint
Example
C:\PS> .\RecordPointOnlineAddManagedSite.ps1 -Username "<Username>" -Email "<EmailAddress>" -Password "<Password>" -ServiceUrl "https://<ServiceUrl>/" -SiteUrl "https://<SharePointUrl/Site/" -SubmissionType <"Submit"|"SubmitStub"> -AggregationType <"Site"|"LowestLevelSubSite"|"List"|"ListOrTopMostFolder"|"ListOrLowestLevelFolder"> -FinaliseType <"Finalise"|"FinaliseArchive"> -AuditLibrary "LibraryName" -RecordNumberField "FieldName" -SubmitMinorVersions -SubmitFirstMinorVersion 

 

Next Step: Creating Submission Rules via API

Submission Rules can only be created after the managed Site has been created. Creating a managed site can also be performed via an API, see document “API Support for adding a Submission Rule to a managed Office 365 Site in the RecordPoint mid-tier”.