@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/switch-rendering.md

@@ -0,0 +1,248 @@
+# Switch-Rendering
+
+Switches an existing rendering with an alternate one to a chosen device for the presentation of an item.
+
+## Syntax
+
+```powershell
+Switch-Rendering -NewRendering <RenderingDefinition> -Item <Item> [-DataSource <string>] [-Rendering <Item>] [-Index <int>] [-PlaceHolder <string>] [-Parameter <hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -Item <Item> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm][<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -Item <Item> -UniqueId <string> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm]  [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -Path <string> [-DataSource <string>] [-Rendering <Item>] [-Index <int>] [-PlaceHolder <string>] [-Parameter <hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -Path <string> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -Path <string> -UniqueId <string> [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm]  [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> [-Id <string>] [-Database <string>] [-DataSource <string>] [-Rendering <Item>] [-Index <int>] [-PlaceHolder <string>] [-Parameter <hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm]  [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -Instance <RenderingDefinition> [-Id <string>] [-Database <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm]  [<CommonParameters>]
+
+Switch-Rendering -NewRendering <RenderingDefinition> -UniqueId <string> [-Id <string>] [-Database <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## Detailed Description
+
+Switches an existing rendering with an alternate one to a chosen device for the presentation of an item.
+
+© 2010-2022 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Existing rendering definition to be swapped on the item
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -NewRendering  &lt;RenderingDefinition&gt;
+
+New rendering definition to be swapped on the item
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameter  &lt;Hashtable&gt;
+
+Rendering Parameters to be overriden on the Rendering that is being updated - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PlaceHolder  &lt;String&gt;
+
+Placeholder path the Rendering should be added to - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DataSource  &lt;String&gt;
+
+Data source of the Rendering - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Index  &lt;Int32&gt;
+
+Index at which the Rendering should be inserted. If not provided the rendering will be appended at the end of the list.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Device  &lt;DeviceItem&gt;
+
+Device the rendering is assigned to. If not specified - default device will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FinalLayout  &lt;SwitchParameter&gt;
+
+Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  &lt;Item&gt;
+
+The item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+Id of the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PassThru  &lt;SwitchParameter&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.Void 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Switch an old rendering for the new.
+
+```powershell
+$itemId = "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+$item = Get-Item -Path "master:" -ID $itemId
+$defaultLayout = Get-LayoutDevice "Default"
+
+$sourceRenderingId = "{37F58448-7460-4AD2-B0FB-67C85C2A49CB}"
+$targetRenderingId = "{90A9C167-5714-481F-82E4-29E394D12614}"
+
+$sourceRenderings = Get-Rendering -Item $item -Device $defaultLayout -FinalLayout |
+    Where-Object { $_.ItemID -eq $sourceRenderingId }
+$targetRendering = Get-Item -Path "master:" -ID $targetRenderingId | New-Rendering
+
+# Replace all instances of the old rendering with the new rendering
+foreach($sourceRendering in $sourceRenderings) {
+    $item | Switch-Rendering -Instance $sourceRendering -Device $defaultLayout -FinalLayout -NewRendering $targetRendering
+}
+```
+
+## Related Topics
+
+* [#1110](https://github.com/SitecorePowerShell/Console/issues/1110) Switch-Rendering added in 6.0
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)

package/dist/tools/powershell/documentation/test-account.md

@@ -0,0 +1,74 @@
+# Test-Account
+
+Determines if the Sitecore role or user account exists.
+
+## Syntax
+
+Test-Account \[-Identity\] <AccountIdentity> \[-AccountType <String>\]
+
+## Detailed Description
+
+The Test-Account command determines if a Sitecore role or user account exists.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Role or User name including domain. If no domain is specified - 'sitecore' will be used as the default value
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -AccountType  <String>
+
+Specifies which account to check existence.
+
+* All
+* Role
+* User 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.String 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* True or False 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Test-Account -Identity Michael
+
+True
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/test-basetemplate.md

@@ -0,0 +1,97 @@
+# Test-BaseTemplate
+
+## Syntax
+
+```powershell
+Test-BaseTemplate -Item <Item> -TemplateItem <TemplateItem[]>
+Test-BaseTemplate -Item <Item> -Template <String[]>
+Test-BaseTemplate -Path <String> -TemplateItem <TemplateItem[]>
+Test-BaseTemplate -Path <String> -Template <String[]>
+Test-BaseTemplate -Id <String> -TemplateItem <TemplateItem[]>
+Test-BaseTemplate -Id <String> -Template <String[]>
+Test-BaseTemplate [-Database <String>]
+```
+
+## Detailed Description
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  &lt;Item&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -TemplateItem  &lt;TemplateItem\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Template  &lt;String\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+The following example determines if the item inherits from the specified template.
+
+```powershell
+$item = Get-Item -Path "master:\content\home"
+Test-BaseTemplate -Item $item -Template "Sample/Sample Content"
+
+# Alternatively you can use the Template Id
+Test-BaseTemplate -Item $item -Template "{76036F5E-CBCE-46D1-AF0A-4143F9B557AA}"
+```

package/dist/tools/powershell/documentation/test-itemacl.md

@@ -0,0 +1,182 @@
+# Test-ItemAcl
+
+Tests a specific access right for a specified user against the provided item
+
+## Syntax
+
+Test-ItemAcl -Item <Item>
+
+Test-ItemAcl -Item <Item> -AccessRight <String> -Identity <AccountIdentity>
+
+Test-ItemAcl -Path <String>
+
+Test-ItemAcl -Path <String> -AccessRight <String> -Identity <AccountIdentity>
+
+Test-ItemAcl -Id <String>
+
+Test-ItemAcl -Id <String> \[-Database <String>\] -AccessRight <String> -Identity <AccountIdentity>
+
+## Detailed Description
+
+Checks if a user can perform an operation on an item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+The item to be tested against.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be tested against.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be tested against. Requires the Database parameter to be specified.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to be fetched with Id parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -AccessRight  <String>
+
+The access right to grand or deny. Well known rights are:
+
+* field:read - "Field Read" - controls whether an account can read a specific field on an item..
+* field:write - "Field Write" - controls whether an account can update a specific field on an item.
+* item:read - "Read" - controls whether an account can see an item in the content tree and/or on the published Web site, including all of its properties and field values.
+* item:write - "Write" - controls whether an account can update field values. The write access right requires the read access right and field read and field write access rights for individual fields \(field read and field write are allowed by default\).
+* item:rename - "Rename" - controls whether an account can change the name of an item. The rename access right requires the read access right.
+* item:create - "Create" - controls whether an account can create child items. The create access right requires the read access right.
+* item:delete - "Delete" - Delete right for items. controls whether an account can delete an item. The delete access right requires the read access right
+
+  Important!
+
+  The Delete command also deletes all child items, even if the account has been denied Delete
+
+  rights for one or more of the subitems.
+
+* item:admin - "Administer" - controls whether an account can configure access rights on an item. The administer access right requires the read and write access rights.
+* language:read - "Language Read" - controls whether a user can read a specific language version of items.
+* language:write - "Language Write" - controls whether a user can update a specific language version of items.
+* site:enter - controls whether a user can access a specific site.
+* insert:show - "Show in Insert" - Determines if the user can see the insert option
+* workflowState:delete - "Workflow State Delete" - controls whether a user can delete items which are currently associated with a specific workflow state.
+* workflowState:write - "Workflow State Write" - controls whether a user can update items which are currently associated with a specific workflow state.
+* workflowCommand:execute - "Workflow Command Execute" - — controls whether a user is shown specific workflow commands.
+* profile:customize - "Customize Profile Key Values" - The right to input out of range values of profile keys, that belong to this profile.
+* bucket:makebucket - "Create Bucket" - convert item to bucket.
+* bucket:unmake - "Revert Bucket" - convert item back from bucket.
+* remote:fieldread - "Field Remote Read" - Field Read right for remoted clients. 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Identity  <AccountIdentity>
+
+User name including domain for which the access rule is being created. If no domain is specified - 'sitecore' will be used as the default domain.
+
+Specifies the Sitecore user by providing one of the following values.
+
+```powershell
+Local Name
+    Example: adam
+Fully Qualified Name
+    Example: sitecore\adam
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.Boolea 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+Denies the "sitecore\author2" user renaming the descendants of the Home item. The security info is created prior to adding it to the item. The item is delivered to the Add-ItemAcl from the pipeline and returned to the pipeline after processing due to the -PassThru parameter.
+
+```powershell
+PS master:\> $acl = New-ItemAcl -AccessRight item:rename -PropagationType Descendants -SecurityPermission AllowAccess -Identity "sitecore\author2"
+PS master:\> Get-Item -Path master:\content\home | Set-ItemAcl -AccessRules $acl
+
+# Assuming the Home item has one child and author2 does not have rename rights granted above in the tree and is not an administrator
+PS master:\> Get-Item master:\content\home | Test-ItemAcl -Identity "sitecore\author2" -AccessRight item:rename
+False
+
+PS master:\> Get-ChildItem master:\content\home | Test-ItemAcl -Identity "sitecore\author2" -AccessRight item:rename
+True
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-ItemAcl](add-itemacl.md)
+* [Clear-ItemAcl](clear-itemacl.md)
+* [Get-ItemAcl](get-itemacl.md)
+* [New-ItemAcl](new-itemacl.md)
+* [Set-ItemAcl](set-itemacl.md)
+* [https://sdn.sitecore.net/upload/sitecore6/security\_administrators\_cookbook\_a4.pdf](https://sdn.sitecore.net/upload/sitecore6/security_administrators_cookbook_a4.pdf) 
+* [https://sdn.sitecore.net/upload/sitecore6/61/security\_reference-a4.pdf](https://sdn.sitecore.net/upload/sitecore6/61/security_reference-a4.pdf) 
+* [https://sdn.sitecore.net/upload/sitecore6/64/content\_api\_cookbook\_sc64\_and\_later-a4.pdf](https://sdn.sitecore.net/upload/sitecore6/64/content_api_cookbook_sc64_and_later-a4.pdf) 
+* [https://www.sitecore.net/learn/blogs/technical-blogs/john-west-sitecore-blog/posts/2013/01/sitecore-security-access-rights.aspx](https://www.sitecore.net/learn/blogs/technical-blogs/john-west-sitecore-blog/posts/2013/01/sitecore-security-access-rights.aspx) 
+* [https://briancaos.wordpress.com/2009/10/02/assigning-security-to-items-in-sitecore-6-programatically/](https://briancaos.wordpress.com/2009/10/02/assigning-security-to-items-in-sitecore-6-programatically/) 
+