SharePoint.BuildingBlocks.WebParts.Modern
Building blocks for managing web parts on a modern page.
Delete Text
Deletes text in the given column of the section.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Page Name | required | The name of the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Text | optional | The (HTML) text to delete in the section column. Text will be retrieved with or without HTML tags. |
| Url | optional | Specify the url of the SharePoint site. |
Delete Web Part
Deletes a web part with a certain title from a modern page.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Page Name | required | The name of the modern page. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure Activity Web Part
Ensure the Activity web part on a modern page.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Max Items | optional | The maximum amount of items that will be shown in the web part. |
| Page Name | required | The name of the modern page. |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure ADM
Ensure an Application Data Manager web part on a modern page. Views, context managers and charts can be used within this web part. The 'Ometa ADM' app is installed on the site if the app isn't deployed tenant-wide. The 'Ometa ADM' app needs to be added to the App Catalog of the tenant or site. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Core Service Url | required | Full URL on which the Core Service is available, e.g.: https://ometa-fw-server:50200. It is required to enable SSL to ensure secure network communication. The provided URL will be used for each data web part on that site collection when used with the template provisioner. |
| Core Service Url Label | optional | The friendly label for the Core Service URL. This is only used when editing the web part properties. The user sees the label instead of the URL. If left empty, the Core Service URL will be used as label. |
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Hidden When Unauthorized | optional | Makes the ADM hidden when the user is not authorised to execute the view. |
| Object | required | Specify the object containing the name of the view, context manager or chart. Make sure the proper object is typed, no check happens to see if the view exist. |
| Page Name | required | The name of the modern page. |
| Preferred Provider | optional | When multiple authentication providers are configured, the preferred provider is used by default. If empty, the user can choose for one of the configured authentication providers. The default value is idp:Windows meaning that the user is authenticated against Active Directory. E.g.: idp:Windows idp:Google idp:Facebook idp:Twitter idp:Microsoft |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Redirect Page Name | required | The name for the redirect page needed to obtain access tokens. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages. For optimal performance configure a global security pages site url in the profille. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Silent Redirect Page Name | required | The name for the silent redirect page needed to silently obtain access tokens via an iframe. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages. For optimal performance configure a global security pages site url in the profille. |
| Type | required | The type of the component. |
| Url | optional | Specify the url of the SharePoint site. |
| View | required | Specify the name of a view, context manager or chart. The ADM web part supports views, context managers and charts. If the 'Type' is set to 'Application Data Manager' a single record, multi record, create or update view must be given, if set to 'Context Manager' a context manager view must be given. Make sure the proper view is typed, no check happens to see if the view exist. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure Gantt Chart
Ensure a Gantt web part on a modern page. The 'Gantt' app is installed on the site if the app isn't deployed tenant-wide. The 'Gantt' app needs to be added to the App Catalog of the tenant or site.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Core Service Url | required | Full URL on which the Core Service is available, e.g.: https://ometa-fw-server:50200. It is required to enable SSL to ensure secure network communication. The provided URL will be used for each data web part on that site collection when used with the template provisioner. |
| Core Service Url Label | optional | The friendly label for the Core Service URL. This is only used when editing the web part properties. The user sees the label instead of the URL. If left empty, the Core Service URL will be used as label. |
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Gantt | required | Specify the name of a Gantt. Make sure the proper gantt is typed, no check happens to see if the gantt exist. |
| Hidden When Unauthorized | optional | Makes the ADM hidden when the user is not authorised to execute the view. |
| Object | required | Specify the object containing the name of the gantt chart. Make sure the proper object is typed, no check happens to see if the gantt exist. |
| Page Name | required | The name of the modern page. |
| Preferred Provider | optional | When multiple authentication providers are configured, the preferred provider is used by default. If empty, the user can choose for one of the configured authentication providers. The default value is idp:Windows meaning that the user is authenticated against Active Directory. E.g.: idp:Windows idp:Google idp:Facebook idp:Twitter idp:Microsoft |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Redirect Page Name | required | The name for the redirect page needed to obtain access tokens. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages. For optimal performance configure a global security pages site url in the profille. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Silent Redirect Page Name | required | The name for the silent redirect page needed to silently obtain access tokens via an iframe. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages. For optimal performance configure a global security pages site url in the profille. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure Link Preview
Ensures a Link Preview on a modern page.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Link | optional | Specify the link that should be previewed |
| Page Name | required | The name of the modern page. |
| Preview Mode | optional | Specify the mode in which the link should be displayed. |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure List View
Ensures a list view on a modern page.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Folder | optional | The name of the folder to display the list items from. For nested folders, type the path separated by '/'. |
| Hide Command Bar | optional | Hides the command bar (new, upload,... buttons) above the items. |
| List | required | The title of the list you want to show in the list view web part. |
| Page Name | required | The name of the modern page. |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Size | optional | The size of the web part. |
| Url | optional | Specify the url of the SharePoint site. |
| View Name | optional | Specify the name of the list view on SharePoint. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure Ometa Quick Links
Ensure an Ometa Quick Links web part on a modern page. The 'Ometa Quick Links' app needs to be added and deployed to the App Catalog of the tenant or site.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Include | optional | ;# separated titles (title property of the navigation list item) to include to limit the navigation items. |
| Layout | required | The layout on how to render the navigation items. |
| Navigation List | required | The title of the navigation list. |
| Page Name | required | The name of the modern page. |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure Smart Tiles
Ensure a Smart Tiles web part on a modern page. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Configuration Name | required | The name of the Smart Tile configuration. |
| Core Service Url | required | Full URL on which the Core Service is available, e.g.: https://ometa-fw-server:50200. It is required to enable SSL to ensure secure network communication. The provided URL will be used for each data web part on that site collection when used with the template provisioner. |
| Core Service Url Label | optional | The friendly label for the Core Service URL. This is only used when editing the web part properties. The user sees the label instead of the URL. If left empty, the Core Service URL will be used as label. |
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Hidden When Unauthorized | optional | Makes the SmartTile hidden when the user is not authorised. |
| Page Name | required | The name of the modern page. |
| Preferred Provider | optional | When multiple authentication providers are configured, the preferred provider is used by default. If empty, the user can choose for one of the configured authentication providers. The default value is idp:Windows meaning that the user is authenticated against Active Directory. E.g.: idp:Windows idp:Google idp:Facebook idp:Twitter idp:Microsoft |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Redirect Page Name | required | The name for the redirect page needed to obtain access tokens. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages. For optimal performance configure a global security pages site url in the profille. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Silent Redirect Page Name | required | The name for the silent redirect page needed to silently obtain access tokens via an iframe. When no global security pages site url is configured in the profile, the 'Ometa Security Redirect' app needs to avaible on the App Catalog on the tenant or site to create the security pages. For optimal performance configure a global security pages site url in the profille. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |
Ensure Text
Ensures text in the given column of the section.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Page Name | required | The name of the modern page. |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Text | optional | The HTML text to ensure in the section column. If no HTML tags are given, the text will be ensured as 'normal text'. Refer to the text editor interface to see which HTML elements are supported: https://support.microsoft.com/en-us/office/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801 |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
Ensure Web Part
Ensures a web part on a modern page with the JSON data. A custom client side web part can be ensured by specifying 'Client Side Web Part' in the 'Default Web Part' field, the name of the client side component should be specified.
To retrieve the web part JSON data:
- Create the web part to ensure or go to a page with the web part.
- Open the page in maintenance mode, by adding ?maintenancemode=true add the end of the URL.
- Go to the web part and click on the tab 'Data', copy the whole JSON string and paste it in the 'Web Part JSON Data' field. Make sure static links are replaced if needed.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Client Side Component Name | optional | The name of the client side component when ensuring a custom client side web part. |
| Create Section If Already Exists | optional | Specify whether a new section should be created if an existing section is found at the given index. If the old section found at the index is empty it is removed. |
| Default Web Part | required | The default web part to add the instance of. Some web parts need extra properties until they are shown. Those can be set in the 'Web Part JSON Data' field. |
| Page Name | required | The name of the modern page. |
| Publish Page | optional | Specify whether the page should be published. When working with multiple web parts on a single page it is recommended to only publish the page on the last web part building block to improve performance. |
| Recreate | optional | Specify whether an existing web part instance should be replaced with the new instance. When set to false and an existing web part instance with the provided Web Part Title exists, an error is thrown. |
| Section Background | optional | Specify the color emphasis of the backgrond of the section on the modern page. |
| Section Column Index | optional | Specify the index of the column in the section on the modern page. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. |
| Section Index | optional | Specify the index of the section on the modern page. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. |
| Section Template | optional | Specify the template that should be used when a new section is created. When a section with another template with no web parts on the index already exists the section will be recreated with the new template. Only one vertical section per page can be added. When adding a web part the vertical section counts as a column of the first section, when you have for example two columns and a vertical section you have to specify 2 in the 'Section Column Index'. Full-width sections can only be used on communication sites with image or hero web parts. |
| Url | optional | Specify the url of the SharePoint site. |
| Web Part JSON Data | optional | The JSON string of the web part data to ensure. If left empty no extra properties besides the defaults will be set. To retrieve the web part JSON data: - Create the web part to ensure or go to a page with the web part. - Open the page in maintenance mode, by adding ?maintenancemode=true add the end of the URL. - Go to the web part and click on the tab 'Data', copy the whole JSON string and paste it in this field. Make sure static links are replaced if needed. |
| Web Part Order | optional | Specify the order of the web part in the modern page column. |
| Web Part Title | required | Specify the title of the web part. On modern pages, the title is displayed in the property pane of the web part. Even though the end user doesn't see this title, it is used internally by the building blocks to detect if there's an already existing web part with the same name. |