@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/send-file.md

@@ -0,0 +1,160 @@
+# Send-File
+
+Allows users to download files from server and file items from media library.
+
+## Syntax
+
+Send-File \[-Path\] <String> \[-Message <String>\] \[-NoDialog\] \[-ShowFullPath\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+Send-File \[-Item\] <Item> \[-Message <String>\] \[-NoDialog\] \[-ShowFullPath\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+Executing this command with file path on the server provides script users with means to download a file to their computer. Executing it for an Item located in Sitecore Media library allows the user to download the blob stored in that item. If the file has been downloaded the dialog returns "downloaded" string, otherwise "cancelled" is returned.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Download-File 
+
+## Parameters
+
+### -Path  <String>
+
+Path to the file to be downloaded. The file has to exist in the Data folder. Files from outside the Data folder are not downloadable.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Message  <String>
+
+Message to show the user in the download dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be downloaded.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -NoDialog  <SwitchParameter>
+
+If this parameter is used the Dialog will not be shown but instead the file download will begin immediately.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ShowFullPath  <SwitchParameter>
+
+If this parameter is used the Dialog will display full path to the file downloaded in the dialog, otherwise only the file name will be shown.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Download dialog title.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Download dialog width.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Download dialog height.
+
+| 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.String 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Download File from server disk drive
+
+```powershell
+PS master:\> Send-File -Path "C:\Projects\ZenGarden\Data\packages\Sitecore PowerShell Extensions-6.0.zip"
+```
+
+### EXAMPLE 2
+
+Download item from media library
+
+```powershell
+PS master:\> Get-Item "master:/media library/Showcase/awesome_logo" | Send-File -Message "Awesome Logo"
+```
+
+## Related Topics
+
+* [Receive-File](receive-file.md)
+* [Out-Download](out-download.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/send-sheermessage.md

@@ -0,0 +1,66 @@
+# Send-SheerMessage
+
+Sends a sheer message to the app in which context the script is executing.
+
+## Syntax
+
+Send-SheerMessage \[-Name\] <String> \[-GetResult\] \[-Parameters <Hashtable>\]
+
+## Detailed Description
+
+Sends a sheer message to the app in which context the script is executing.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Name of the Sheer message to execute.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -GetResult  <SwitchParameter>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameters  <Hashtable>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+If you execute the following script in the PowerShell ISE the Save dialog will popup
+
+```powershell
+Send-SheerMessage -Name 'ise:save'
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/set-hostproperty.md

@@ -0,0 +1,90 @@
+# Set-HostProperty
+
+Sets the current host property.
+
+## Syntax
+
+Set-HostProperty \[-ForegroundColor <Black \| DarkBlue \| DarkGreen \| DarkCyan \| DarkRed \| DarkMagenta \| DarkYellow \| Gray \| DarkGray \| Blue \| Green \| Cyan \| Red \| Magenta \| Yellow \| White>\] \[-BackgroundColor <Black \| DarkBlue \| DarkGreen \| DarkCyan \| DarkRed \| DarkMagenta \| DarkYellow \| Gray \| DarkGray \| Blue \| Green \| Cyan \| Red \| Magenta \| Yellow \| White>\] \[-HostWidth <Int32>\] \[-Persist\]
+
+## Detailed Description
+
+Sets the current host property and perssits them for the future if used with -Persist parameter.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -ForegroundColor  <ConsoleColor>
+
+Color of the console text.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -BackgroundColor  <ConsoleColor>
+
+Color of the console background.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -HostWidth  <Int32>
+
+Width of the text buffer \(texts longer than the number provided will wrap to the next line.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Persist  <SwitchParameter>
+
+Persist the console setting provided
+
+| 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
+
+Set width of the console buffer to 80 and persist it for the future instances
+
+```powershell
+PS master:\> Set-HostProperty -HostWidth 80 -Persist
+```
+
+### EXAMPLE 2
+
+Set color of the console text to cyan. Next instance of the console will revert to default \(white\).
+
+```powershell
+PS master:\> Set-HostProperty -ForegroundColor Cyan
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,158 @@
+# Set-ItemAcl
+
+Sets new security information on an item overwriting the previous settings.
+
+## Syntax
+
+```powershell
+Set-ItemAcl -AccessRules <AccessRuleCollection> [-Path] <String> [-PassThru]
+Set-ItemAcl -AccessRules <AccessRuleCollection> -Id <String> [-Database <String>] [-PassThru]
+Set-ItemAcl -AccessRules <AccessRuleCollection> [-Item] <Item> [-PassThru]
+```
+
+## Detailed Description
+
+Sets new security information on an item. The new rules will overwrite the existing security descriptors on the item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -AccessRules  &lt;AccessRuleCollection&gt;
+
+A single or multiple access rules created e.g. through the New-ItemAcl or obtained from other item using the Get-ItemAcl cmdlet. This information will overwrite the existing security descriptors on the item.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PassThru  &lt;SwitchParameter&gt;
+
+Passes the processed object back into the pipeline.
+
+| 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.
+
+| 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. Requires the Database parameter to be specified.
+
+| 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 fetched with Id parameter.
+
+| 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.
+
+* can be piped from another cmdlet\* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Only if -PassThru is used\* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Take the security information from the Home item and apply it to the Settings item
+
+```powershell
+$acl = Get-ItemAcl -Path master:\content\home
+Set-ItemAcl -Path master:\content\Settings -AccessRules $acl -PassThru
+```
+
+### EXAMPLE 2
+
+Allows the "sitecore\adam" user to delete the Home item and all of its children. Denies the "sitecore\mikey" user reading the descendants of the Home item. ;P The security info is created prior to setting it to the item. The item is delivered to the Set-ItemAcl from the pipeline and returned to the pipeline after processing due to the -PassThru parameter. Any previuous security information on the item is removed.
+
+```powershell
+$acl1 = New-ItemAcl -AccessRight item:delete -PropagationType Any -SecurityPermission AllowAccess -Identity "sitecore\adam"
+$acl2 = New-ItemAcl -AccessRight item:read -PropagationType Descendants -SecurityPermission DenyAccess -Identity "sitecore\mikey"
+Get-Item -Path master:\content\home | Set-ItemAcl -AccessRules $acl1, $acl2 -PassThru
+
+Name   Children Languages                Id                                     TemplateName
+----   -------- ---------                --                                     ------------
+Home   False    {en, ja-JP, de-DE, da}   {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+```
+
+### EXAMPLE 3
+
+The following applies a new set of AccessRule to an item using `Set-ItemAcl` and `New-ItemAcl` when the PropogationType and SecurityPermission are the same.
+
+```powershell
+$role = "sitecore\yourrole"
+$rights = @("item:create", "item:write", "item:rename", "item:delete")
+
+Get-Item -Path master:\content\youritem | Set-ItemAcl -AccessRules ($rights | ForEach-Object { New-ItemAcl -AccessRight $_ -PropagationType Any -SecurityPermission AllowAccess -Identity $role })
+```
+
+## 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)
+* [Test-ItemAcl](test-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/) 
+

package/dist/tools/powershell/documentation/set-itemtemplate.md

@@ -0,0 +1,156 @@
+# Set-ItemTemplate
+
+Sets the item template.
+
+## Syntax
+
+```powershell
+Set-ItemTemplate -Item <Item> -TemplateItem <TemplateItem> [-FieldsToCopy <Hashtable>]
+Set-ItemTemplate -Item <Item> -Template <String> [-FieldsToCopy <Hashtable>]
+Set-ItemTemplate -Path <String> -TemplateItem <TemplateItem> [-FieldsToCopy <Hashtable>]
+Set-ItemTemplate -Path <String> -Template <String> [-FieldsToCopy <Hashtable>]
+Set-ItemTemplate -Id <String> -TemplateItem <TemplateItem> [-FieldsToCopy <Hashtable>]
+Set-ItemTemplate -Id <String> -Template <String> [-FieldsToCopy <Hashtable>]
+Set-ItemTemplate [-Database <String>] [-FieldsToCopy <Hashtable>]
+```
+
+## Detailed Description
+
+The Set-ItemTemplate command sets the template for an item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  &lt;Item&gt;
+
+The item to set the template for.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+Path to the item to set the template for.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+Id of the item to set the template for.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -TemplateItem  &lt;TemplateItem&gt;
+
+Sitecore item representing the template.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Template  &lt;String&gt;
+
+Path representing the template item. This must be of the same database as the item to be altered.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FieldsToCopy  &lt;Hashtable&gt;
+
+Hashtable of key value pairs mapping the old template field to a new template field.
+
+@{"Title"="Headline";"Text"="Copy"}
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+Database containing the item to set the template for - required if item is specified with Id.
+
+| 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 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West, Alex Washtell
+
+## Examples
+
+### EXAMPLE 1
+
+Set template of /sitecore/content/home item using a Template path.
+
+```powershell
+Set-ItemTemplate -Path master:/sitecore/content/home -Template "/sitecore/templates/User Defined/Page"
+```
+
+### EXAMPLE 2
+
+Set template of /sitecore/content/home item using a TemplateItem.
+
+```powershell
+$template = Get-ItemTemplate -Path master:\content\home\page1
+Set-ItemTemplate -Path master:\content\home\page2 -TemplateItem $template
+```
+
+### EXAMPLE 3
+
+Set the template and remap fields to their new name.
+
+```powershell
+Set-ItemTemplate -Path "master:\content\home\Page1" `
+    -Template "User Defined/Target" `
+    -FieldsToCopy @{Field1="Field4"; Field2="Field5"; Field3="Field6"}
+```
+
+## Related Topics
+
+* [Get-ItemTemplate](get-itemtemplate.md)
+* [Add-BaseTemplate](add-basetemplate.md)
+* [Remove-BaseTemplate](remove-basetemplate.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+