@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/invoke-shellcommand.md

@@ -0,0 +1,144 @@
+# Invoke-ShellCommand
+
+Executes Sitecore Shell command for an item. This command used to be named Execute-ShellCommand - a matching alias added for compatibility with older scripts.
+
+## Syntax
+
+Invoke-ShellCommand \[-Item\] <Item> \[-Name\] <String> \[-Language <String\[\]>\]
+
+Invoke-ShellCommand \[-Path\] <String> \[-Name\] <String> \[-Language <String\[\]>\]
+
+Invoke-ShellCommand -Id <String> \[-Database <String>\] \[-Name\] <String> \[-Language <String\[\]>\]
+
+## Detailed Description
+
+Executes Sitecore Shell command for an item. e.g. opening dialogs or performing commands that you can find in the Content Editor ribbon or context menu.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Execute-ShellCommand 
+
+## Parameters
+
+### -Name  <String>
+
+Name of the sitecore command e.g. "item:publishingviewer"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| 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 |
+
+### -Item  <Item>
+
+The item to be sent to the command.
+
+| 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 sent to the command - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the the item to be sent to the command - 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 sent to the command - 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 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Launch Publishing Viewer for /sitecore/content/home item.
+
+```powershell
+PS master:\> Get-Item master:\content\home\ | Invoke-ShellCommand "item:publishingviewer"
+```
+
+### EXAMPLE 2
+
+Initiate /sitecore/content/home item duplication.
+
+```powershell
+PS master:\> Get-Item master:/content/home | Invoke-ShellCommand "item:duplicate"
+```
+
+### EXAMPLE 3
+
+Show properties of the /sitecore/content/home item.
+
+```powershell
+PS master:\> Get-Item master:/content/home | Invoke-ShellCommand "contenteditor:properties"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/invoke-workflow.md

@@ -0,0 +1,142 @@
+# Invoke-Workflow
+
+Executes Workflow action for an item. This command used to be named Execute-Workflow - a matching alias added for compatibility with older scripts.
+
+## Syntax
+
+Invoke-Workflow \[-Item\] <Item> \[-CommandName <String>\] \[-Comments <String>\] \[-Language <String\[\]>\]
+
+Invoke-Workflow \[-Path\] <String> \[-CommandName <String>\] \[-Comments <String>\] \[-Language <String\[\]>\]
+
+Invoke-Workflow -Id <String> \[-Database <String>\] \[-CommandName <String>\] \[-Comments <String>\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+Executes Workflow action for an item. If the workflow action could not be performed for any reason - an appropriate error will be raised.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Execute-Workflow 
+
+## Parameters
+
+### -CommandName  <String>
+
+Namer of the workflow command.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Comments  <String>
+
+Comment to be saved in the history table for the action.
+
+| 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 |
+
+### -Item  <Item>
+
+The item to have the workflow action executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to have the workflow action executed - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the the item to have the workflow action executed - 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 have the workflow action executed - 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 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Submit item to approval, item gotten from path
+
+```powershell
+PS master:\> Invoke-Workflow -Path master:/content/home -CommandName "Submit" -Comments "Automated"
+```
+
+### EXAMPLE 2
+
+Reject item, item gotten from pipeline
+
+```powershell
+PS master:\> Get-Item master:/content/home | Invoke-Workflow -CommandName "Reject" -Comments "Automated"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,157 @@
+# Lock-Item
+
+Locks the Sitecore item by the current or specified user.
+
+## Syntax
+
+Lock-Item \[-Item\] <Item> \[-Force\] \[-PassThru\] \[-Identity <AccountIdentity>\]
+
+Lock-Item \[-Path\] <String> \[-Force\] \[-PassThru\] \[-Identity <AccountIdentity>\]
+
+Lock-Item -Id <String> \[-Database <String>\] \[-Force\] \[-PassThru\] \[-Identity <AccountIdentity>\]
+
+## Detailed Description
+
+The Lock-Item command unlocks the item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Force  <SwitchParameter>
+
+Forces the item to be locked by the specified user even if it's currently locked by another user.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PassThru  <SwitchParameter>
+
+Passes the processed object back into the pipeline.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Identity  <AccountIdentity>
+
+User name including domain for which the item is to be locked. 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? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be processed.
+
+| 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 processed - 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 processed.
+
+| 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
+
+Lock the Home item providing its path
+
+```powershell
+PS master:\> Lock-Item -Path master:\content\home
+```
+
+### EXAMPLE 2
+
+Lock the Home item by providing it from the pipeline and passing it back to the pipeline. The Item is locked by the "sitecore\adam" user.
+
+```powershell
+PS master:\> Get-Item -Path master:\content\home | Lock-Item -PassThru -Identity sitecore\adam
+
+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/) 
+* [Unlock-Item](https://github.com/SitecorePowerShell/Book/tree/bfef3ab0ca500162f7287e1fd4fa14bb4f6a760b/appendix/commands/Unlock-Item.md)
+* Get-Item
+

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

@@ -0,0 +1,56 @@
+# Login-User
+
+Logs a user in and performs further script instructions in the context of the user.
+
+## Syntax
+
+Login-User \[-Identity\] <GenericIdentity> \[-Password\] <String>
+
+## Detailed Description
+
+Logs a user in and performs further script instructions in the context of the user.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <GenericIdentity>
+
+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? | false |
+| Accept Wildcard Characters? | false |
+
+### -Password  <String>
+
+Password for the account provided using the -Identity parameter.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Login-User -Identity "sitecore\admin" -Password "b"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,30 @@
+# Logout-User
+
+Logs the current user out.
+
+## Syntax
+
+## Detailed Description
+
+Logs the current user out.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Logout-User
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/merge-layout.md

@@ -0,0 +1,102 @@
+# Merge-Layout
+
+The Merge-Layout command takes all the layout information stored in the FinalLayout field and merges into the SharedLayout field. The FinalLayout field is reset after the merge completes.
+
+## Syntax
+
+```powershell
+Merge-Layout [-Item] <Item> [-Language <String[]>]
+
+Merge-Layout [-Path] <String> [-Language <String[]>]
+
+Merge-Layout -Id <String> [-Database <String>] [-Language <String[]>]
+```
+
+## Detailed Description
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -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 |
+
+## 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
+
+The following retrieves all pages under home and merges the layout.
+
+```powershell
+Get-ChildItem master:\content\Showcase\int\home -Recurse | Merge-Layout
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-Rendering](add-rendering.md)
+* [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)
+* [Reset-Layout](reset-layout.md)
+

package/dist/tools/powershell/documentation/new-domain.md

@@ -0,0 +1,72 @@
+# New-Domain
+
+Creates a new domain with the specified name.
+
+## Syntax
+
+New-Domain \[-Name\] <String> \[-LocallyManaged\]
+
+## Detailed Description
+
+The New-Domain command creates a domain if it does not exist.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+The name of the domain.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -LocallyManaged  <SwitchParameter>
+
+TODO: Provide description for this 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.
+
+* System.String
+
+  Represents the name of a domain.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None. 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> New-Domain -Name "domainName"
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-Domain](get-domain.md)
+* [Remove-Domain](remove-domain.md)
+