@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/import-item-1.md

@@ -0,0 +1,180 @@
+# Import-Item
+
+Imports \(deserializes\) the specified path from the filesystem on the server as a Sitecore item.
+
+## Syntax
+
+Import-Item \[-Database <Database>\] \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+Import-Item \[-Item\] <Item> \[-Recurse\] \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+Import-Item \[-Preset\] <IncludeEntry> \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+Import-Item \[-Path\] <String> \[-Recurse\] \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+## Detailed Description
+
+The Import-Item command deserializes the specified items.
+
+The simplest syntax requires 2 parameters:
+
+* -Path : which is a path to the item on the drive but without .item extension. If the item does not exist in the Sitecore tree yet, you need to pass the parent item path.
+* -Root : the directory which is the root of serialization. Trailing slash  character is required, 
+
+e.g.:
+
+Import-Item -Path "c:\project\data\serialization\master\sitecore\content\articles" -Root "c:\project\data\serialization\"
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Deserialize-Item 
+
+## Parameters
+
+### -Database  <Database>
+
+Database to contain the item to be deserialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be serialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Preset  <IncludeEntry>
+
+Name of the preset to be deserialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item on the drive but without .item extension. If the item does not exist in the Sitecore tree yet, you need to pass the parent item path.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Recurse  <SwitchParameter>
+
+If included in the execution - dederializes both the item and all of its children.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+The directory which is the root of serialization. Trailing slash character is required. if not specified the default root will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -UseNewId  <SwitchParameter>
+
+Tells Sitecore if each of the items should be created with a newly generated ID, e.g. Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project\data\serialization\" -usenewid -recurse
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DisableEvents  <SwitchParameter>
+
+If set Sitecore will use EventDisabler during deserialization, e.g.: Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ForceUpdate  <SwitchParameter>
+
+Forces item to be updated even if it has not changed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.Void 
+
+## Notes
+
+Help Author: Marek Musielak, Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project\data\serialization\"
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project\data\serialization\" -recurse
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Export-Item](export-item.md)
+* [Get-Preset](../common/get-preset.md)
+* [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7) 
+* [https://gist.github.com/AdamNaj/6c86f61510dc3d2d8b2f](https://gist.github.com/AdamNaj/6c86f61510dc3d2d8b2f) 
+* [https://stackoverflow.com/questions/20266841/sitecore-powershell-deserialization](https://stackoverflow.com/questions/20266841/sitecore-powershell-deserialization) 
+* [https://stackoverflow.com/questions/20195718/sitecore-serialization-powershell](https://stackoverflow.com/questions/20195718/sitecore-serialization-powershell) 
+* [https://stackoverflow.com/questions/20283438/sitecore-powershell-deserialization-core-db](https://stackoverflow.com/questions/20283438/sitecore-powershell-deserialization-core-db) 
+

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

@@ -0,0 +1,180 @@
+# Import-Item
+
+Imports \(deserializes\) the specified path from the filesystem on the server as a Sitecore item.
+
+## Syntax
+
+Import-Item \[-Database <Database>\] \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+Import-Item \[-Item\] <Item> \[-Recurse\] \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+Import-Item \[-Preset\] <IncludeEntry> \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+Import-Item \[-Path\] <String> \[-Recurse\] \[-Root <String>\] \[-UseNewId\] \[-DisableEvents\] \[-ForceUpdate\]
+
+## Detailed Description
+
+The Import-Item command deserializes the specified items.
+
+The simplest syntax requires 2 parameters:
+
+* -Path : which is a path to the item on the drive but without .item extension. If the item does not exist in the Sitecore tree yet, you need to pass the parent item path.
+* -Root : the directory which is the root of serialization. Trailing slash  character is required, 
+
+e.g.:
+
+Import-Item -Path "c:\project\data\serialization\master\sitecore\content\articles" -Root "c:\project\data\serialization\"
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Deserialize-Item 
+
+## Parameters
+
+### -Database  <Database>
+
+Database to contain the item to be deserialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be serialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Preset  <IncludeEntry>
+
+Name of the preset to be deserialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item on the drive but without .item extension. If the item does not exist in the Sitecore tree yet, you need to pass the parent item path.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Recurse  <SwitchParameter>
+
+If included in the execution - dederializes both the item and all of its children.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+The directory which is the root of serialization. Trailing slash character is required. if not specified the default root will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -UseNewId  <SwitchParameter>
+
+Tells Sitecore if each of the items should be created with a newly generated ID, e.g. Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project\data\serialization\" -usenewid -recurse
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DisableEvents  <SwitchParameter>
+
+If set Sitecore will use EventDisabler during deserialization, e.g.: Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ForceUpdate  <SwitchParameter>
+
+Forces item to be updated even if it has not changed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.Void 
+
+## Notes
+
+Help Author: Marek Musielak, Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project\data\serialization\"
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Import-Item -path "c:\project\data\serialization\master\sitecore\content\articles" -root "c:\project\data\serialization\" -recurse
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Export-Item](export-item.md)
+* [Get-Preset](../common/get-preset.md)
+* [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7) 
+* [https://gist.github.com/AdamNaj/6c86f61510dc3d2d8b2f](https://gist.github.com/AdamNaj/6c86f61510dc3d2d8b2f) 
+* [https://stackoverflow.com/questions/20266841/sitecore-powershell-deserialization](https://stackoverflow.com/questions/20266841/sitecore-powershell-deserialization) 
+* [https://stackoverflow.com/questions/20195718/sitecore-serialization-powershell](https://stackoverflow.com/questions/20195718/sitecore-serialization-powershell) 
+* [https://stackoverflow.com/questions/20283438/sitecore-powershell-deserialization-core-db](https://stackoverflow.com/questions/20283438/sitecore-powershell-deserialization-core-db) 
+

package/dist/tools/powershell/documentation/import-role.md

@@ -0,0 +1,137 @@
+# Import-Role
+
+Imports \(deserializes\) Sitecore roles from the Sitecore server filesystem.
+
+## Syntax
+
+Import-Role \[-Identity\] <AccountIdentity> \[-Root <String>\]
+
+Import-Role -Filter <String> \[-Root <String>\]
+
+Import-Role \[-Role\] <User> \[-Root <String>\]
+
+Import-Role -Path <String>
+
+## Detailed Description
+
+The Import-Role command imports \(deserializes\) Sitecore roles from the Sitecore server filesystem.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore role to be deserialized by providing one of the following values.
+
+```powershell
+Local Name
+    Example: developer
+Fully Qualified Name
+    Example: sitecore\developer
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Filter  <String>
+
+Specifies a simple pattern to match Sitecore roles.
+
+Examples: The following examples show how to use the filter syntax.
+
+To get all the roles, use the asterisk wildcard: Import-Role -Filter \*
+
+To get all the roles in a domain use the following command: Import-Role -Filter "sitecore\*"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Role  <User>
+
+An existing role object to be restored to the version from disk
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the file the role should be loaded from.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+Specifies the serialization root directory. If this parameter is not specified - the default Sitecore serialization folder will be used \(unless you're reading from an explicit location with the -Path 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
+
+  Sitecore.Security.Accounts.Role
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Import-Role -Identity sitecore\Author
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Import-Role -Filter sitecore\*
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Import-Role -Root C:\my\Serialization\Folder\ -Filter *\*
+```
+
+### EXAMPLE 4
+
+```powershell
+PS master:\> Import-Role -Path C:\my\Serialization\Folder\Admins.role
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,137 @@
+# Import-User
+
+Imports \(deserializes\) Sitecore users from the Sitecore server filesystem.
+
+## Syntax
+
+Import-User \[-Identity\] <AccountIdentity> \[-Root <String>\]
+
+Import-User -Filter <String> \[-Root <String>\]
+
+Import-User \[-User\] <User> \[-Root <String>\]
+
+Import-User -Path <String>
+
+## Detailed Description
+
+The Import-User command imports \(deserializes\) Sitecore users from the Sitecore server filesystem.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore user to be deserialized by providing one of the following values.
+
+```powershell
+Local Name
+    Example: developer
+Fully Qualified Name
+    Example: sitecore\developer
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Filter  <String>
+
+Specifies a simple pattern to match Sitecore users.
+
+Examples: The following examples show how to use the filter syntax.
+
+To get all the roles, use the asterisk wildcard: Import-User -Filter \*
+
+To get all the roles in a domain use the following command: Import-User -Filter "sitecore\*"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -User  <User>
+
+User object retrieved from the Sitecore API or using the Get-User command identifying the user account to be deserialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the file the user should be loaded from.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+Specifies the serialization root directory. If this parameter is not specified - the default Sitecore serialization folder will be used \(unless you're reading from an explicit location with the -Path 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
+
+  Sitecore.Security.Accounts.User
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Import-User -Identity sitecore\Admin
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Import-User -Filter sitecore\*
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Import-User -Root C:\my\Serialization\Folder\ -Filter *\*
+```
+
+### EXAMPLE 4
+
+```powershell
+PS master:\> Import-User -Path C:\my\Serialization\Folder\Admin.user
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+