Começar a criar modelos de site e scripts de site
Você pode criar modelos de site para fornecer listas reutilizáveis, temas, layouts ou ações personalizadas para que seus usuários possam criar rapidamente novos sites do Microsoft Office SharePoint Online com os recursos de que precisam.
Este artigo descreve como criar um modelo de site simples que adiciona uma lista do SharePoint para rastrear pedidos de clientes. Você usará o modelo de site para criar um novo site do SharePoint com a lista personalizada. Você aprenderá como usar cmdlets do PowerShell do SharePoint para criar scripts e modelos de site. Você também pode usar as APIs REST para executar as mesmas ações. As chamadas REST correspondentes são mostradas para referência em cada etapa.
Criar o script de site em JSON
Um script de site é um conjunto de ações que o SharePoint executa ao criar um novo site. As ações descrevem alterações a serem aplicadas ao novo site, como criar uma nova lista ou aplicar um tema. As ações são especificadas em um script JSON, que é uma lista de todas as ações a serem aplicadas. Quando um script é executado, o SharePoint conclui cada ação na ordem listada.
Cada ação é especificada pelo valor de "verbo" no script JSON. Além disso, ações podem ter subações que também são valores de "verbo". No JSON a seguir, o script é especificado para criar uma nova lista chamada Controle de Clientes, e as subações definem a descrição e adicionam vários campos para definir a lista.
Baixe e instale o Shell de Gerenciamento do SharePoint Online. Se você já tiver uma versão anterior do shell instalada, desinstale-a primeiro e depois instale a última versão.
Siga as instruções em Conectar-se ao PowerShell do SharePoint Online para conectar-se ao seu locatário do SharePoint.
Crie e atribua o JSON que descreve o novo script para uma variável, conforme mostrado no seguinte código do PowerShell. Você pode exibir e fazer referência ao arquivo de esquema JSON mais recente: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json
$site_script = ' { "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json", "actions": [ { "verb": "createSPList", "listName": "Customer Tracking", "templateType": 100, "subactions": [ { "verb": "setDescription", "description": "List of Customers and Orders" }, { "verb": "addSPField", "fieldType": "Text", "displayName": "Customer Name", "isRequired": false, "addToDefaultView": true }, { "verb": "addSPField", "fieldType": "Number", "displayName": "Requisition Total", "addToDefaultView": true, "isRequired": true }, { "verb": "addSPField", "fieldType": "User", "displayName": "Contact", "addToDefaultView": true, "isRequired": true }, { "verb": "addSPField", "fieldType": "Note", "displayName": "Meeting Notes", "isRequired": false } ] } ] } '
O script anterior cria uma nova lista do SharePoint chamada Controle de Clientes. Ele define a descrição e adiciona quatro campos à lista. Observe que cada um deles é considerado como uma ação. Os scripts de site são limitados a 30 ações cumulativas (em um ou mais scripts que podem ser chamados em um modelo de site) se aplicados programaticamente usando o Invoke-SPOSiteDesign comando. Se eles forem aplicados pelo UI ou usando o comando Add-SPOSiteDesignTask, o limite será de 300 ações cumulativas (ou 100 mil caracteres).
Adicionar o script de site
Cada script de site deve ser registrado no SharePoint para ficar disponível para o uso. Adicione um novo design de site usando o cmdlet Add-SPOSiteScript. O exemplo a seguir mostra como adicionar o script JSON descrito anteriormente.
C:\> Add-SPOSiteScript
-Title "Create customer tracking list"
-Content $site_script
-Description "Creates list for tracking customer contact information"
Depois de executar o cmdlet, você recebe um resultado que lista a ID do script de site adicionado. Armazene essa ID em algum lugar, pois você precisará dela mais tarde ao criar o modelo de site.
A API REST para adicionar um novo script de site é CreateSiteScript.
Criar o modelo de site
Em seguida, você precisará criar o modelo do site. O modelo do site aparece em uma lista suspensa quando alguém cria um novo site de um dos modelos. Ele poderá executar um ou mais scripts de site que tiverem sido adicionados.
- Execute o cmdlet a seguir para adicionar um novo modelo de site. Substitua
<ID>pela ID do script de site de quando você adicionou o script.
C:\> Add-SPOSiteDesign
-Title "Contoso customer tracking"
-WebTemplate "64"
-SiteScripts "<ID>"
-Description "Tracks key customer data in a list"
O cmdlet anterior cria um novo modelo de site chamado Controle de clientes da Contoso.
| Parâmetro | Valor | Tipo de modelo de site |
|---|---|---|
| WebTemplate | 64 | Modelo de site da equipe |
| WebTemplate | 1 | Site de equipe (com criação de grupo desabilitada) |
| WebTemplate | 68 | Modelo de site de comunicação |
| WebTemplate | 69 | Modelo de site de canal |
A resposta JSON exibe a ID do novo modelo de site. Você poderá usá-la nos cmdlets subsequentes para atualizar ou modificar o modelo do site.
A API REST para adicionar um novo modelo de site é CreateSitemodelo.
Usar o novo modelo de site
Agora que você adicionou um script de site e um modelo de site, pode usá-lo para criar novos sites por meio da experiência de criação de sites de autoatendimento ou aplicar o modelo de site a um site existente usando o comando Invoke-SPOSiteDesign no PowerShell. Se estiver usando sites de hub, você mesmo pode associar um modelo de site a um hub, para que seja aplicado a todos os sites que farão parte.
Nova criação de site
- Acesse a home page do site do SharePoint que você está usando para desenvolvimento.
- Escolha Criar site.
- Escolha o tipo de site que você precisa usar. O Microsoft Office SharePoint Online criará um site de equipe usando o modelo de colaboração de Equipe da Microsoft ou um site de comunicação usando o modelo de Tópico da Microsoft, a menos que outro modelo de site personalizado seja definido como padrão.
- Escolha Avançar.
- Em Nome do site, insira um nome para o novo site Acompanhamento de pedidos de clientes.
- Escolha Concluir.
- Em seguida, vá para Configurações e selecione Aplicar um modelo de site.
- Selecione o modelo de site que você acabou de criar.
- Depois de aplicado, seu novo modelo será exibido na guia do visualizador de modelos intitulado De sua organização.
- Quando o novo modelo for aplicado, você verá a lista personalizada na página.
Aplicar a um conjunto de sites existente
Você também pode aplicar modelos de site publicados a sites existentes. Na home page do site, os proprietários do site podem navegar até Configurações e Aplicar um modelo de site para procurar e aplicar modelos fornecidos pela sua organização e pela Microsoft.
Você pode aplicar modelos a coleções de sites existentes em massa usando o cmdlet Invoke-SPOSiteDesign.
Modelos de site publicados podem ser aplicados a:
- Sites de equipe conectados a grupos
- Sites de equipe não conectados a um grupo do Microsoft 365
- Sites de comunicação
- Sites de canal
- Sites de equipe clássicos
- Sites de publicação clássicos
A API REST para aplicar um modelo de site a um conjunto de sites existente é ApplySiteDesign.
Associar a um site do hub
Aplique um modelo de site publicado a um site de hub novo ou existente. Em seguida, todos os sites associados herdarão o modelo e o tema do site do hub. Navegue até a home page do hub e vá Configurações e Aplique um modelo de site. Saiba mais sobre como habilitar associações de sites para seu site de hub.
Você também pode usar o cmdlet Set-SPOHubSite. Consulte o artigo cmdlets do PowerShell para sites de hub do SharePoint.
Observação
Os sites do canal são automaticamente impedidos de ingressar em um site do hub.