@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,168 @@
+# Get-ItemAcl
+
+Retrieves security access rules from an item.
+
+## Syntax
+
+Get-ItemAcl -Identity <AccountIdentity> -Path <String>
+
+Get-ItemAcl -Identity <AccountIdentity> -Id <String> \[-Database <String>\]
+
+Get-ItemAcl -Identity <AccountIdentity> -Item <Item>
+
+Get-ItemAcl -Filter <String> -Path <String>
+
+Get-ItemAcl -Filter <String> -Id <String> \[-Database <String>\]
+
+Get-ItemAcl -Filter <String> -Item <Item>
+
+Get-ItemAcl -Item <Item>
+
+Get-ItemAcl -Path <String>
+
+Get-ItemAcl -Id <String>
+
+## Detailed Description
+
+Retrieves security access rules from an item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -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 |
+
+### -Filter  <String>
+
+Specifies a simple pattern to match Sitecore roles & users.
+
+Examples: The following examples show how to use the filter syntax.
+
+To get security for all roles, use the asterisk wildcard: Get-ItemAcl -Filter \*
+
+To security got all roles in a domain use the following command: Get-ItemAcl -Filter "sitecore\*"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item from which the security rules should be taken.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item from which the security rules should be taken.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item from which the security rules should be taken.
+
+| 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 containing the security rules that should be returned.
+
+| 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.
+
+* Sitecore.Security.AccessControl.AccessRule 
+
+## 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
+
+Take the security information from the Home item and add it to the access rules on the Settings item
+
+```powershell
+$acl = Get-ItemAcl -Path master:\content\home
+Add-ItemAcl -Path master:\content\Settings -AccessRules $acl -PassThru
+```
+
+## Related Topics
+
+* [Add-ItemAcl](add-itemacl.md)
+* [Clear-ItemAcl](clear-itemacl.md)
+* [Set-ItemAcl](set-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/get-itemclone.md

@@ -0,0 +1,100 @@
+# Get-ItemClone
+
+Returns all the clones for the specified item.
+
+## Syntax
+
+Get-ItemClone \[-Item\] <Item>
+
+Get-ItemClone \[-Path\] <String>
+
+Get-ItemClone -Id <String> \[-Database <String>\]
+
+## Detailed Description
+
+The Get-ItemClone command returns all the clones for the specified item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+The item to be analysed for clones presence.
+
+| 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 analysed for clones presence.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be analysed for clones presence.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to be processed - if item is being provided through 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 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Get-ItemClone -Path master:\content\home
+```
+
+## Related Topics
+
+* [New-ItemClone](new-itemclone.md)
+* [ConvertFrom-ItemClone](convertfrom-itemclone.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [https://github.com/SitecorePowerShell/Console/issues/218](https://github.com/SitecorePowerShell/Console/issues/218) 
+* Get-Item
+

package/dist/tools/powershell/documentation/get-itemclonenotification.md

@@ -0,0 +1,95 @@
+# Get-ItemCloneNotification
+
+## Syntax
+
+```powershell
+Get-ItemCloneNotification [-Item] <Item> [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+Get-ItemCloneNotification [-Path] <String> [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+Get-ItemCloneNotification -Id <String> [-Database <String>] [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+```
+
+## Detailed Description
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -NotificationType  &lt;NotificationType&gt;
+
+| 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;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| 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 |
+
+### -Database  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Examples
+
+### EXAMPLE 1
+
+The following gets the cloned `Item` and returns the available notifications.
+
+```powershell
+$clonedItem = Get-Item -Path "master:" -ID "{9F158637-52C2-4005-8329-21527685CB71}"
+Get-ItemCloneNotification -Item $clonedItem
+```
+
+### EXAMPLE 2
+
+The following gets the cloned `Item` based on the specified type of notification.
+
+```powershell
+$clonedItem = Get-Item -Path "master:" -ID "{9F158637-52C2-4005-8329-21527685CB71}"
+$clonedItem | Get-ItemCloneNotification -NotificationType ItemMovedChildRemovedNotification
+```

package/dist/tools/powershell/documentation/get-itemfield.md

@@ -0,0 +1,182 @@
+# Get-ItemField
+
+Retrieves item fields as either names or fields or template fields.
+
+## Syntax
+
+Get-ItemField \[-Item\] <Item> \[-IncludeStandardFields\] \[-ReturnType <Name \| Field \| TemplateField>\] \[-Name <String\[\]>\] \[-Language <String\[\]>\]
+
+Get-ItemField \[-Path\] <String> \[-IncludeStandardFields\] \[-ReturnType <Name \| Field \| TemplateField>\] \[-Name <String\[\]>\] \[-Language <String\[\]>\]
+
+Get-ItemField -Id <String> \[-Database <String>\] \[-IncludeStandardFields\] \[-ReturnType <Name \| Field \| TemplateField>\] \[-Name <String\[\]>\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+Retrieves item fields as either names or fields or template fields.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -IncludeStandardFields  <SwitchParameter>
+
+Includes fields that are defined on "Standard template"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ReturnType  <ReturnValue>
+
+Determines type returned. The possible values include:
+
+* Name - strings with field names.
+* Field - fields on the item
+* TemplateField - template fields. 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String\[\]>
+
+Array of names to include - supports wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  <String\[\]>
+
+Language that will be analysed. If not specified the current user language will be used. Globbing/wildcard supported.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be analysed.
+
+| 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 analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to be analysed - 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 |
+
+## 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.
+
+* Sitecore.Data.Items.Item
+
+  Sitecore.Data.Templates.TemplateField
+
+  Sitecore.Data.Fields.Field
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Get list of names of non standard fields from /sitecore/content/home item
+
+```powershell
+PS master:\> Get-ItemField -Path master:\content\home
+
+Text
+Title
+Image
+```
+
+### EXAMPLE 2
+
+Get list of fields including standard fields from /sitecore/content/home item and list their Name, DisplayName, SectionDisplayName and Description in a table.
+
+```powershell
+PS master:\> Get-Item master:\content\home | Get-ItemField -IncludeStandardFields -ReturnType Field -Name "*" | ft Name, DisplayName, SectionDisplayName, Description -auto
+
+Name                                DisplayName                        SectionDisplayName Description
+----                                -----------                        ------------------ -----------
+__Revision                          Revision                           Statistics
+__Standard values                   __Standard values                  Advanced
+__Updated by                        Updated by                         Statistics
+__Validate Button Validation Rules  Validation Button Validation Rules Validation Rules
+__Created                           Created                            Statistics
+__Thumbnail                         Thumbnail                          Appearance
+__Insert Rules                      Insert Rules                       Insert Options
+__Short description                 Short description                  Help
+__Created by                        Created by                         Statistics
+__Presets                           Presets                            Layout
+Text                                Text                               Data               The text is the main content of the document.
+```
+
+## Related Topics
+
+* [Get-ItemTemplate](get-itemtemplate.md)
+* [Reset-ItemField](reset-itemfield.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/get-itemreference.md

@@ -0,0 +1,152 @@
+# Get-ItemReference
+
+Returns all the items linked to the specified item..
+
+## Syntax
+
+Get-ItemReference -Item <Item>
+
+Get-ItemReference -Item <Item> -ItemLink
+
+Get-ItemReference -Path <String> \[-Language <String\[\]>\]
+
+Get-ItemReference -Path <String> \[-Language <String\[\]>\] -ItemLink
+
+Get-ItemReference -Id <String> \[-Database <String>\] \[-Language <String\[\]>\]
+
+Get-ItemReference -Id <String> \[-Database <String>\] \[-Language <String\[\]>\] -ItemLink
+
+## Detailed Description
+
+The Get-ItemReference command returns all items linked to the specified item. If -ItemLink parameter is used the command will return links rather than items.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+The item to be analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be processed - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the the item to be processed - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+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 |
+
+### -Language  <String\[\]>
+
+Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ItemLink  <SwitchParameter>
+
+Return ItemLink that define both source and target of a link rather than items that are being linked to from the specified item.
+
+| 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.
+
+* Sitecore.Data.Items.Item
+
+  Sitecore.Links.ItemLink
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\>Get-ItemReference -Path master:\content\home
+
+Name                             Children Languages                Id                                     TemplateName
+----                             -------- ---------                --                                     ------------
+Home                             True     {en, de-DE, es-ES, pt... {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+Home                             True     {en, de-DE, es-ES, pt... {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\>Get-Item master:\content\home | Get-ItemReference -ItemLink
+
+SourceItemLanguage : en
+SourceItemVersion  : 1
+TargetItemLanguage :
+TargetItemVersion  : 0
+SourceDatabaseName : master
+SourceFieldID      : {F685964D-02E1-4DB6-A0A2-BFA59F5F9806}
+SourceItemID       : {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}
+TargetDatabaseName : master
+TargetItemID       : {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}
+TargetPath         : /sitecore/content/Home
+```
+
+## Related Topics
+
+* [Get-ItemReferrer](get-itemreferrer.md)
+* [Update-ItemReferrer](update-itemreferrer.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+