This canvas app is used to create a definition and a deployment package.

A definition contains all included SharePoint objects and their properties.

A deployment package contains SharePoint objects, their properties and their object action. Possible object actions are:

  • Create
  • Update
    • This object action in on the backlog: CR-2024-5
    • This object type is already available as a command in command bars in this canvas app but ignored on the export screen when creating a deployment package.
  • Delete

Object actions are always related to a previous version. If no previous version exists, all objects in the definition will also be in the deployment package with the object action “Create”.

Both the definition and the deployment package are a JSON record. The deployment package is used as input in the canvas app “SPOT – Deployment” and the definition is used as input in this canvas app and the canvas app “SPOT – Validation”.

Below, an example screenshot of the homepage is shown.

Home page

The homepage consists of 3 areas:

  • The header
  • The command bar
  • The details list

Header

The header contains a help icon which can be clicked on and will redirect you to this page.

Command bar

The command bar contains commands which will navigate you to a screen for that object type/topic.

Object type
Topic
Description
Document librariesNavigate to the object type screen for document libraries.
GroupsNavigate to the object type screen for groups.
ListsNavigate to the object type screen for lists.
Permission levelsNavigate to the object type screen for permission levels.
Import definitionNavigate to the screen where a previous definition can be imported.
ExportNavigate to the screen which shows the definition (JSON record) and deployment package (JSON record).

Details list

The details list shows a summary of all the objects in the definition.

Object type screen

An object type screen can be related to a main object type or a sub object type: Main-object types and sub-object types

An object type screen consists of 3 areas:

  • The header
  • The command bar
  • The details list

Header

The header contains a back icon which can be clicked on and will redirect you to the homepage or the screen of its related main-object type in case of a sub-object type.

Command bar

The command bar contains commands related to an object action (Create, Update, Delete) or will navigate you to a screen for that sub-object type.

TopicDescription
CreateCreate an object.
UpdateUpdate the in the details list selected object.
DeleteDelete the in the details list selected object.
A sub-object typeNavigate to the object type screen of the related sub-object type. An object must be selected in the details list first.

Details list

The details list shows all the objects for the related object type.

An object can be selected (checkbox) which updates the commands in the command bar.

An object can be clicked on which shows a panel containing all properties of the clicked on object. The panel contains the action the update or delete the clicked on object.

Object actions

Create

The related object type form is shown containing the default values for the properties.

Update

The related object type form is shown containing the property values in the definition.

Delete

A dialog is shown to confirm the deletion of the object.

Import definition

This screen is used to import a previous version of the definition.

When the schema has been updated and the imported definition contains an old schema, the schema will be updated automatically. A procedure must be following in case of a schema change: How-to act on a schema change

Export

This screen displays the definition and the deployment package.

The deployment package is related to the imported definition and the latest state of objects. Meaning that if an object has for instance been updated 3 times after the definition was imported, only the values of the last update are used.

Object actions are always related to a previous version. If no previous version exists, all objects in the definition will also be in the deployment package with the object action “Create”.

Below, a screenshot of the export screen is shown. Is contains a definition and deployment package.