@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,111 @@
+# Test-Rule
+
+Tests item against a sitecore serialized rules engine rule set.
+
+## Syntax
+
+Test-Rule \[-Rule <String>\] \[-InputObject <PSObject>\] \[-RuleDatabase <String>\]
+
+## Detailed Description
+
+Tests item or a stream of items against a sitecore serialized rules engine rule set.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Rule  <String>
+
+Serialized sitecore rules engine rule. Such rules can be read from rule fields or created by user with the Read-Variable cmdlet.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InputObject  <PSObject>
+
+Item to be tested
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -RuleDatabase  <String>
+
+Name of the database from which rules are pulled.
+
+| 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.Boolea 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Specifies a rule as "items that have layout" and runs the rule againste all items under the ome Item
+
+```powershell
+$rule = '<ruleset>
+<rule uid="{9CF02118-F189-49C4-9F2B-6698D64ACF23}">
+<conditions>
+<condition id="{A45DBBAE-F74F-4EFE-BBD5-24395E0AF945}" uid="ED10990E15EB4E1E8FCFD33F441588A1" />
+</conditions>
+</rule>
+</ruleset>'
+
+Get-ChildItem master:\content\Home -Recurse | ? { Test-Rule -InputObject $_ -Rule $rule -RuleDatabase master}
+```
+
+### EXAMPLE 2
+
+Asks user for the rule and root under which items should be filtered, and lists all items fulfilling the rule under the selected path
+
+```powershell
+$rule = '<ruleset></ruleset>'
+$root = Get-Item master:\content\home\ 
+
+$result = Read-Variable -Parameters `
+@{Name="root"; title="Items under"; Tooltip="Items under the selected item will be considered for evaluation"}, `
+@{Name="rule"; Editor="rule"; title="Filter rules"; Tooltip="Only items conforming to this rule will be displayed."} `
+-Description "This dialog shows editor how a rule can be taken from an item and edited using the Read-Variable cmdlet." `
+-Title "Sample rule editing" -Width 600 -Height 600 -ShowHints
+
+if($result -eq "cancel"){
+exit;
+}
+
+Get-ChildItem $root.ProviderPath | ? { Test-Rule -InputObject $_ -Rule $rule -RuleDatabase master}
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/unlock-item.md

@@ -0,0 +1,124 @@
+# Unlock-Item
+
+Unlocks the specified Sitecore item.
+
+## Syntax
+
+Unlock-Item \[-Item\] <Item> \[-PassThru\]
+
+Unlock-Item \[-Path\] <String> \[-PassThru\]
+
+Unlock-Item -Id <String> \[-Database <String>\] \[-PassThru\]
+
+## Detailed Description
+
+The Unlock-Item command unlocks the item specified with parameters.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -PassThru  <SwitchParameter>
+
+Passes the unlocked item back into the pipeline.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be unlocked.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be unlocked - can work with Language parameter to specify the language other than current session language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be unlocked.
+
+| 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 |
+
+## 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
+
+Unlock the Home item providing its path
+
+```powershell
+PS master:\> Unlock-Item -Path master:\content\home
+```
+
+### EXAMPLE 2
+
+Unlock the Home item providing it from the pipeline and passing it back to the pipeline
+
+```powershell
+PS master:\> Get-Item -Path master:\content\home | Unlock-Item -PassThru
+
+Name   Children Languages                Id                                     TemplateName
+----   -------- ---------                --                                     ------------
+Home   False    {en, ja-JP, de-DE, da}   {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Lock-Item](https://github.com/sitecorepowershell/sitecore-powershell-extensions/tree/b6365f8ecf54966c2e1757f549f543976500aa52/appendix/commands/Lock-Item.md)
+* Get-Item
+

package/dist/tools/powershell/documentation/unlock-user.md

@@ -0,0 +1,84 @@
+# Unlock-User
+
+Unlocks a Sitecore user using the specified criteria.
+
+## Syntax
+
+Unlock-User \[-Identity\] <AccountIdentity>
+
+Unlock-User -Instance <User>
+
+## Detailed Description
+
+The Unlock-User command gets a user and unlocks the account in Sitecore.
+
+The Identity parameter specifies the Sitecore user to get. You can specify a user by its local name or fully qualified name. You can also specify user object variable, such as $<user>.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Instance  <User>
+
+Specifies the Sitecore user by providing an instance of a user.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.String
+
+  Represents the identity of a user.
+
+Sitecore.Security.Accounts.User One or more user instances.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None. 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Unlock-User -Identity michael
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-User -Filter * | Unlock-User
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-User](get-user.md)
+* [New-User](new-user.md)
+* [Remove-User](remove-user.md)
+* [Set-User](set-user.md)
+

package/dist/tools/powershell/documentation/unprotect-item.md

@@ -0,0 +1,124 @@
+# Unprotect-Item
+
+Unprotects the specified Sitecore item.
+
+## Syntax
+
+Unprotect-Item \[-Item\] <Item> \[-PassThru\]
+
+Unprotect-Item \[-Path\] <String> \[-PassThru\]
+
+Unprotect-Item -Id <String> \[-Database <String>\] \[-PassThru\]
+
+## Detailed Description
+
+The Unprotect-Item command removes protection from the item provided to it.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -PassThru  <SwitchParameter>
+
+Passes the unprotected item back into the pipeline.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be unprotected.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be unprotected - can work with Language parameter to specify the language other than current session language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be unprotected.
+
+| 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 |
+
+## 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
+
+Unprotect the Home item providing its path
+
+```powershell
+PS master:\> Unprotect-Item -Path master:\content\home
+```
+
+### EXAMPLE 2
+
+Unprotect the Home item providing it from the pipeline and passing it back to the pipeline
+
+```powershell
+PS master:\> Get-Item -Path master:\content\home | Unprotect-Item -PassThru
+
+Name   Children Languages                Id                                     TemplateName
+----   -------- ---------                --                                     ------------
+Home   False    {en, ja-JP, de-DE, da}   {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Protect-Item](protect-item.md)
+* Get-Item
+

package/dist/tools/powershell/documentation/update-itemreferrer.md

@@ -0,0 +1,234 @@
+# Update-ItemReferrer
+
+Updates references to specified item to point to a new provided in the -NewTarget or removes links to the item.
+
+## Syntax
+
+Update-ItemReferrer \[-Link\] <ItemLink> \[-NewTarget\] <Item>
+
+Update-ItemReferrer \[-Link\] <ItemLink> -RemoveLink
+
+Update-ItemReferrer \[-NewTarget\] <Item> \[-Item\] <Item>
+
+Update-ItemReferrer -NewTarget <Item> -Path <String> \[-Language <String\[\]>\]
+
+Update-ItemReferrer -NewTarget <Item> -Id <String> \[-Database <String>\] \[-Language <String\[\]>\]
+
+Update-ItemReferrer -RemoveLink \[-Item\] <Item>
+
+Update-ItemReferrer -RemoveLink -Path <String> \[-Language <String\[\]>\]
+
+Update-ItemReferrer -RemoveLink -Id <String> \[-Database <String>\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+The cmdlet manipulates link to a specific item. The target item can be provided as an Item object or through Path/ID. it does not modifies the item itself but rather other items that link to it. If the -RemoveLink parameter is used the link will be removed rather than modified. To deliver more fine grained filtering you can provide ItemLink using the -Link parameter. You can obtain ItemLinks using Get-ItemReferrer or Get-ItemReference cmdlets. Consult Examples for specific use cases of each approach.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Link  <ItemLink>
+
+ItemLink retrieved from the Link database. Use this parameter to do more granular filtering.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -NewTarget  <Item>
+
+New item the links should be pointing to
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -RemoveLink  <SwitchParameter>
+
+If provided, removes all links to the current target item.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The current item to be relinked.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the current item to be relinked - 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 |
+
+### -Id  <String>
+
+Id of the current item to be relinked - can work with Language parameter to specify the language other than current session language. 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 current item to be relinked.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  <String\[\]>
+
+If you need the current item to be relinked in specific Language You can specify it with this parameter. Globbing/wildcard supported.
+
+| 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
+
+## Examples
+
+### EXAMPLE 1
+
+This example covers global operations
+
+Assuming Sitecore PowerShell Extensions 4.2 or newer is installed Assuming your Home has an "Image" field of type "Image" Assuming you have second item next to Home called Home2 that has an "Image" field of type "Image"
+
+```powershell
+$coverImage = Get-Item 'master:\media library\Default Website\cover'
+$scLogoImage = Get-item 'master:\media library\Default Website\sc_logo'
+
+Write-Host "`nReset 'home', 'child' and 'home2' to link to 'cover'- 3 items" -Foreground Magenta
+(Get-item master:\content\home).Image = $coverImage
+(Get-item master:\content\Home\child).Image = $coverImage
+(Get-item master:\content\home2).Image = $coverImage
+
+Get-ItemReferrer -Item $coverImage            
+
+Write-Host "`nRelinking all instances of 'cover' image to  'sc_logo'" -Foreground Yellow
+$coverImage | Update-ItemReferrer -NewTarget $scLogoImage
+
+Write-Host "`n'cover' should no longer have links leading to it - 0 items " -Foreground Red
+$coverImage | Get-ItemReferrer 
+
+Write-Host "`n'sc_logo' should now be linked from all - 3 items" -Foreground Green
+$scLogoImage | Get-ItemReferrer
+
+Write-Host "`nRemoving links to 'sc_logo' from all items" -Foreground Yellow
+$scLogoImage | Update-ItemReferrer -RemoveLink
+
+Write-Host "`n'sc_logo' should have no links to it - 0 items" -Foreground Red
+$scLogoImage | Get-ItemReferrer
+```
+
+### EXAMPLE 2
+
+This example covers more fine-grained filtered approach to removing links
+
+Assuming Sitecore PowerShell Extensions 4.2 or newer is installed Assuming your Home has an "Image" field of type "Image" Assuming you have second item next to Home called Home2 that has an "Image" field of type "Image"
+
+```powershell
+$coverImage = Get-Item 'master:\media library\Default Website\cover'
+$scLogoImage = Get-item 'master:\media library\Default Website\sc_logo'
+
+Write-Host "`nReset 'home', 'child' and 'home2' to link to 'cover'- 3 items" -Foreground Magenta
+(Get-item master:\content\home).Image = $coverImage
+(Get-item master:\content\Home\child).Image = $coverImage
+(Get-item master:\content\home2).Image = $coverImage
+
+Get-ItemReferrer -Item $coverImage            
+
+Write-Host "`nRemove links to the 'cover' image from all items under 'master:\content\home'" -Foreground Yellow
+Get-ChildItem master:\content\home -WithParent -Recurse |   # get items under home
+    Get-ItemReference -ItemLink |                           # get all items that they are refering to
+    ? { $_.TargetItemID -eq $coverImage.ID } |              # filter only references to $coverImage
+    Update-ItemReferrer -RemoveLink                         # remove links
+
+Write-Host "`n'cover' should have 1 link leading from 'home2'" -Foreground Green
+$coverImage | Get-ItemReferrer
+```
+
+### EXAMPLE 3
+
+This example covers more fine-grained filtered approach to removing links
+
+Assuming Sitecore PowerShell Extensions 4.2 or newer is installed Assuming your Home has an "Image" field of type "Image" Assuming you have second item next to Home called Home2 that has an "Image" field of type "Image"
+
+```powershell
+$coverImage = Get-Item 'master:\media library\Default Website\cover'
+$scLogoImage = Get-item 'master:\media library\Default Website\sc_logo'
+
+Write-Host "`nReset 'home', 'child' and 'home2' to link to 'cover'- 3 items" -Foreground Magenta
+(Get-item master:\content\home).Image = $coverImage
+(Get-item master:\content\Home\child).Image = $coverImage
+(Get-item master:\content\home2).Image = $coverImage
+
+Get-ItemReferrer -Item $coverImage            
+
+Write-Host "`nUpdate all links to 'cover' image to point to 'sc_logo' from all immediate children of /sitecore/content" -Foreground Yellow
+Get-ChildItem master:\content |                     # get items immediately under 'under home'content'
+    Get-ItemReference -ItemLink |                   # get all items that they are refering to
+    ? { $_.TargetItemID -eq $coverImage.ID } |      # filter only references to $coverImage
+    Update-ItemReferrer -NewTarget $scLogoImage     # point them to 'sc_logo' image
+
+Write-Host "`n'cover' should have link from home2/child - 1 item" -Foreground Green
+$coverImage | Get-ItemReferrer
+
+Write-Host "`n'sc_logo' should have links leading from 'home' and 'home2' - 2 items" -Foreground Green
+$scLogoImage | Get-ItemReferrer
+```
+
+## Related Topics
+
+* [Get-ItemReferrer](get-itemreferrer.md)
+* [Get-ItemReference](get-itemreference.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+