@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,89 @@
+# Enable-User
+
+Enables the specified Sitecore user.
+
+## Syntax
+
+Enable-User \[-Identity\] <AccountIdentity>
+
+Enable-User -Instance <User>
+
+## Detailed Description
+
+The Enable-User command gets a user and enables 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>
+
+Specifies the Sitecore user by providing one of the following values.
+
+```powershell
+Local Name
+    Example: michael
+Fully Qualified Name
+    Example: sitecore\michael
+```
+
+| 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 one or more users.
+
+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
+
+Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Enable-User -Identity michael
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-User -Filter * | Enable-User
+```
+
+## Related Topics
+
+* [https://michaellwest.blogspot.com](https://michaellwest.blogspot.com) 
+

package/dist/tools/powershell/documentation/expand-token.md

@@ -0,0 +1,144 @@
+# Expand-Token
+
+Expands tokens in fields for items.
+
+## Syntax
+
+Expand-Token \[-Item\] <Item> \[-Language <String\[\]>\]
+
+Expand-Token \[-Path\] <String> \[-Language <String\[\]>\]
+
+Expand-Token -Id <String> \[-Database <String>\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+The Expand-Token command expands the tokens in fields for items.
+
+Some example of tokens include:
+
+* $name
+* $time 
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Language  <String\[\]>
+
+Language that will be processed. 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 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 - 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 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 |
+
+## 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
+
+The following expands tokens in fields on the item.
+
+```powershell
+Get-Item -Path "master:\content\home" | Expand-Token
+```
+
+### EXAMPLE 2
+
+The following expands tokens in fields on the item. If the standard value of the field contains a token we modify the field to the token so the expansion will work (Sitecore API does not expand if the field is the same as Standard Values and never modified).
+
+```powershell
+$tokens = @('$name', '$id', '$parentId', '$parentname', '$date', '$time', '$now')
+
+$item = Get-Item -Path "master:\content\home"
+
+$standardValueFields = Get-ItemField -Item $item -ReturnType Field -Name "*" `
+    | Where-Object { $_.ContainsStandardValue }
+    
+$item.Editing.BeginEdit()
+
+foreach ($field in $standardValueFields) {
+    $value = $field.Value
+    
+    if ($tokens -contains $value) {
+        $item[$field.Name] = $value
+    }
+}
+
+$item.Editing.EndEdit()
+
+Expand-Token -Item $item
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [https://sitecorejunkie.com/2014/05/27/launch-powershell-scripts-in-the-item-context-menu-using-sitecore-powershell-extensions/](https://sitecorejunkie.com/2014/05/27/launch-powershell-scripts-in-the-item-context-menu-using-sitecore-powershell-extensions/) 
+* [https://sitecorejunkie.com/2014/06/02/make-bulk-item-updates-using-sitecore-powershell-extensions/](https://sitecorejunkie.com/2014/06/02/make-bulk-item-updates-using-sitecore-powershell-extensions/) 
+

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

@@ -0,0 +1,165 @@
+# Export-Item
+
+Exports \(serializes\) the Sitecore item to the filesystem.
+
+## Syntax
+
+Export-Item \[-Entry <IncludeEntry>\] \[-Recurse\] \[-ItemPathsAbsolute\] \[-Root <String>\]
+
+Export-Item \[-Item\] <Item> \[-Recurse\] \[-ItemPathsAbsolute\] \[-Root <String>\]
+
+Export-Item \[-Path\] <String> \[-Recurse\] \[-ItemPathsAbsolute\] \[-Root <String>\]
+
+Export-Item -Id <String> \[-Database <String>\] \[-Recurse\] \[-ItemPathsAbsolute\] \[-Root <String>\]
+
+## Detailed Description
+
+The Export-Item command serializes Sitecore items to the filesystem. The alias for the command is Serialize-Item. The simplest command syntax is: Export-Item -path "master:\content"
+
+or
+
+Get-Item "master:\content" \| Export-Item
+
+Both of them will serialize the content item in the master database. In first case we pass the path to the item as a parameter, in second case we serialize the items which come from the pipeline. You can send more items from the pipeline to the Export-Item command, e.g. if you need to serialize all the descendants of the home item created by sitecore\admin, you can use:
+
+Get-Childitem "master:\content\home" -recurse \| Where-Object { $\_."\_\_Created By" -eq "sitecore\admin" } \| Export-Item
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Serialize-Item 
+
+## Parameters
+
+### -Entry  <IncludeEntry>
+
+Serialization preset to be serialized. Obtain the preset through the use of Get-Preset command.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Recurse  <SwitchParameter>
+
+Process the item and all of its children - switch which decides if serialization concerns only the single item or the whole tree below the item, e.g.
+
+Export-Item -path "master:\content\articles" -recurse
+
+Root - directory where the serialized files should be saved, e.g. Export-Item -path "master:\content" -Root "c:\tmp"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ItemPathsAbsolute  <SwitchParameter>
+
+Works only with Root parameter and decides if folder structure starting from "sitecore\content" should be created, e.g. if you want to serialize articles item in directory c:\tmp\sitecore\content you can use. For example: Export-Item -Path "master:\content\articles" -ItemPathsAbsolute -Root "c:\tmp"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+Directory where the serialized files should be saved, e.g.
+
+Export-Item -Path "master:\content" -Root "c:\tmp"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| 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 |
+
+### -Path  <String>
+
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+You can pass the id of serialized item instead of path, e.g. Export-Item -id "{0DE95AE4-41AB-4D01-9EB0-67441B7C2450}"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+| 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: Marek Musielak, Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Export-Item -Path master:\content\home
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-Preset](../common/get-preset.md)
+* [Import-Item](export-item.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/export-package.md

@@ -0,0 +1,129 @@
+# Export-Package
+
+Exports a Sitecore installation package and project.
+
+## Syntax
+
+Export-Package \[\[-Path\] <String>\] \[\[-Project\] <PackageProject>\] \[-Zip\] \[-NoClobber\] \[-IncludeProject\]
+
+## Detailed Description
+
+The Export-Package command creates a Sitecore installation package as either a .zip containing all items and files or .xml with project definition.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Path  <String>
+
+Path the project should be saved under.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Project  <PackageProject>
+
+Project object created ealier with the New-Package. or Loaded with Get-Package.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Zip  <SwitchParameter>
+
+Specify this parameter to exposrt package with all its assets in a zip file. If this parameter is missing only Xml file with the package project definition will be saved.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -NoClobber  <SwitchParameter>
+
+Do not overwrite \(replace the contents\) of an existing file. By default, if a file exists in the specified path, Export-Package overwrites the file without warning.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -IncludeProject  <SwitchParameter>
+
+Specify this parameter if exporting the zip file and when you want it to contain the project definitnion xml file in it.
+
+| 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.Install.PackageProject 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+Following example creates a new package, adds content/home item to it and saves it in the Sitecore Package folder+ gives you an option to download the saved package.
+
+```powershell
+# Create package
+$package = new-package "Package for something special";
+
+# Set package metadata
+$package.Sources.Clear();
+
+$package.Metadata.Author = "Michael West";
+$package.Metadata.Publisher = "Scripting in Powerful Ways Team";
+$package.Metadata.Version = "2.7";
+$package.Metadata.Readme = 'This text will be visible to people installing your package'
+
+# Add contnet/home to the package
+$source = Get-Item 'master:\content\home' | New-ItemSource -Name 'Home Page' -InstallMode Overwrite
+$package.Sources.Add($source);
+
+# Save package
+Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
+
+# Offer the user to download the package
+Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
+```
+
+## Related Topics
+
+* [Get-Package](get-package.md)
+* Import-Package
+* [Install-UpdatePackage](install-updatepackage.md)
+* [New-ExplicitFileSource](new-explicitfilesource.md)
+* [New-ExplicitItemSource](new-explicititemsource.md)
+* [New-FileSource](new-filesource.md)
+* [New-ItemSource](new-itemsource.md)
+* [New-Package](new-package.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/](https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/) 
+* [https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae](https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae) 
+

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

@@ -0,0 +1,150 @@
+# Export-Role
+
+Exports \(serializes\) Sitecore roles to the filesystem on the server.
+
+## Syntax
+
+Export-Role \[-Identity\] <AccountIdentity> \[-Root <String>\]
+
+Export-Role \[-Identity\] <AccountIdentity> -Path <String>
+
+Export-Role -Filter <String> \[-Root <String>\]
+
+Export-Role \[-Role\] <Role> \[-Root <String>\]
+
+Export-Role \[-Role\] <Role> -Path <String>
+
+## Detailed Description
+
+The Export-Role command exports \(serializes\) Sitecore roles to the filesystem on the server.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore role 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: Export-Role -Filter \*
+
+To get all the roles in a domain use the following command: Export-Role -Filter "sitecore\*"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Role  <Role>
+
+Specifies the role to be exported
+
+| 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 saved to.
+
+| 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 saving to 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
+
+## 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
+
+```powershell
+PS master:\> Export-Role -Identity sitecore\Author
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Export-Role -Filter sitecore\*
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Export-Role -Root C:\my\Serialization\Folder\ -Filter *\*
+```
+
+### EXAMPLE 4
+
+```powershell
+PS master:\> Export-Role -Path C:\my\Serialization\Folder\Authors.role -Identity sitecore\Author
+```
+
+## Related Topics
+
+* [Import-Role](import-role.md)
+* [Export-User](export-user.md)
+* [Import-User](import-user.md)
+* [Export-Item](../packaging/export-item.md)
+* [Import-Item](export-role.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+