@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,87 @@
+# Initialize-Item
+
+Initializes items with the PowerShell automatic properties for each field.
+
+## Syntax
+
+Initialize-Item -Item <Item>
+
+Initialize-Item -SearchResultItem <SearchResultItem>
+
+## Detailed Description
+
+The Initialize-Item command wraps Sitecore item with PowerShell property equivalents of fields for easy assignment of values to fields and automatic saving. This command can also be used to translate the the "Sitecore.ContentSearch.SearchTypes.SearchResultItem" items obtained from the Find-Item command into full Sitecore Items. The alias for the command is Wrap-Item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Wrap-Item 
+
+## Parameters
+
+### -Item  <Item>
+
+The item to be wrapped/initialized.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -SearchResultItem  <SearchResultItem>
+
+The item obtained from Find-Item command to be translated into a sitecore item.
+
+| 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.
+
+* Sitecore.Data.Items.Item
+
+  Sitecore.ContentSearch.SearchTypes.SearchResultItem
+
+## 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
+
+Initialize the item obtained directly through the Sitecore API with additional PowerShell properties
+
+```powershell
+$item = [Sitecore.Configuration.Factory]::GetDatabase("master").GetItem("/sitecore/content/home");
+#So far the item does not have PowerShell instrumentation wrapped around it yet - the following like wraps $item in those additional properties
+$item = Initialize-Item -Item $item
+# The following line will assign text to the field named MyCustomeTextField and persist the item into the database automatically using the added PowerShell property.
+$item.Title = "New Title"
+```
+
+## Related Topics
+
+* [Find-Item](find-item.md)
+* Get-Item
+* Get-ChildItem
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/initialize-searchindex.md

@@ -0,0 +1,116 @@
+# Initialize-SearchIndex
+
+Rebuilds the Sitecore index.
+
+## Syntax
+
+```powershell
+Initialize-SearchIndex -Index <ISearchIndex> [-IncludeRemoteIndex] [-AsJob]
+Initialize-SearchIndex [-IncludeRemoteIndex] [-Name <String>] [-AsJob]
+Initialize-SearchIndex [-Name <String>] [-AsJob]
+```
+
+## Detailed Description
+
+The Rebuild-SearchIndex command rebuilds Sitecore index. This command is an alias for Initialize-SearchIndex.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Rebuild-SearchIndex 
+
+## Parameters
+
+### -Index  &lt;ISearchIndex&gt;
+
+The index instance.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -IncludeRemoteIndex  &lt;SwitchParameter&gt;
+
+The remote indexing should be triggered.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -AsJob  &lt;SwitchParameter&gt;
+
+The job created for rebuilding the index should be returned as output.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  &lt;String&gt;
+
+The name of the index to resume.
+
+| 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.
+
+* None or Sitecore.Jobs.Job 
+
+## 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
+The following rebuilds the index.
+
+Initialize-SearchIndex -Name sitecore_master_index
+```
+
+### EXAMPLE 2
+
+```powershell
+The following rebuilds the index.
+
+Get-SearchIndex -Name sitecore_master_index | Initialize-SearchIndex
+```
+
+## Related Topics
+
+* [Resume-SearchIndex](resume-searchindex.md)
+* [Suspend-SearchIndex](suspend-searchindex.md)
+* [Stop-SearchIndex](stop-searchindex.md)
+* [Get-SearchIndex](get-searchindex.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/initialize-searchindexitem.md

@@ -0,0 +1,85 @@
+# Initialize-SearchIndexItem
+
+## Syntax
+
+```powershell
+Initialize-SearchIndexItem -Item <Item> [-Name <String>] [-AsJob]
+Initialize-SearchIndexItem -Item <Item> [-Name <String>] [-AsJob]
+Initialize-SearchIndexItem -SearchResultItem <SearchResultItem> [-AsJob]
+```
+
+## Detailed Description
+
+Rebuilds the index for a given tree with the specified root item and index name. Supports wildcard filtering for the index name.
+
+© 2010-2020 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Rebuild-SearchIndexItem 
+
+## Parameters
+
+### -Item  &lt;Item&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -SearchResultItem  &lt;SearchResultItem&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -AsJob  &lt;SwitchParameter&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Examples
+
+### EXAMPLE 1
+
+The following rebuilds the index for a given tree with the specified root node and index name.
+
+```powershell
+$item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+$indexName = "sitecore_master_index"
+Initialize-SearchIndexItem -Item $item -Name $indexName
+```
+
+### EXAMPLE 2
+
+The following rebuilds the indexes matching the wildcard pattern for a given tree with the specified root node and index name.
+
+```powershell
+$item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+$indexName = "sitecore_*_index"
+Initialize-SearchIndexItem -Item $item -Name $indexName
+```

package/dist/tools/powershell/documentation/install-package.md

@@ -0,0 +1,95 @@
+# Install-Package
+
+Installs a Sitecore package from the specified path.
+
+## Syntax
+
+Install-Package \[\[-Path\] <String>\] \[-InstallMode <Undefined \| Overwrite \| Merge \| Skip \| SideBySide>\] \[-MergeMode <Undefined \| Clear \| Append \| Merge>\] \[-DisableIndexing\]
+
+## Detailed Description
+
+Installs Sitecore package with the ability to provide default responses for merge and overwrite actions. The alias for the command is Import-Package.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Import-Package 
+
+## Parameters
+
+### -Path  <String>
+
+Path to the package file.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InstallMode  <InstallMode>
+
+Undefined, Overwrite, Merge, Skip, SideBySide
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -MergeMode  <MergeMode>
+
+Undefined, Clear, Append, Merge
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DisableIndexing  <SwitchParameter>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Install-Package -Path SitecorePowerShellConsole.zip -InstallMode Merge -MergeMode Merge
+```
+
+## Related Topics
+
+* [Export-Package](export-package.md)
+* [Get-Package](get-package.md)
+* [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) 
+* [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7) 
+

package/dist/tools/powershell/documentation/install-updatepackage.md

@@ -0,0 +1,90 @@
+# Install-UpdatePackage
+
+Installs a Sitecore update package from the specified path.
+
+## Syntax
+
+Install-UpdatePackage \[-Path\] <String> \[\[-RollbackPackagePath\] <String>\] -UpgradeAction <Preview \| Upgrade> -InstallMode <Install \| Update>
+
+## Detailed Description
+
+The Install-UpdatePackage command installs update packages that are used created by Sitecore CMS updates, TDS, and Courier.
+
+Install-UpdatePackage. Install-UpdatePackage -Path "C:\Projects\LaunchSitecore.TDSMaster.update" -UpgradeAction {Preview or Upgrade} -InstallMode {Install or Update}
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Path  <String>
+
+Path to the .update package on the Sitecore server disk drive.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -RollbackPackagePath  <String>
+
+Specify Rollback Package Path - for rolling back if the installation was not functioning as expected.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -UpgradeAction  <UpgradeAction>
+
+Preview / Upgrade
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InstallMode  <InstallMode>
+
+Install / Update
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| 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.
+
+* Sitecore.Update.Installer.ContingencyEntry 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Install-UpdatePackage -Path "C:\Projects\LaunchSitecore.TDSMaster.update" -UpgradeAction Preview -InstallMode Install
+```
+
+## Related Topics
+
+* [Export-UpdatePackage](export-updatepackage.md)
+* [Get-UpdatePackageDiff](get-updatepackagediff.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,22 @@
+# Invoke-JavaScript
+
+## Syntax
+
+Invoke-JavaScript \[-Script\] <String>
+
+## Detailed Description
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Script  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+

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

@@ -0,0 +1,111 @@
+# Invoke-Script
+
+Executes a script from Sitecore PowerShell Extensions Script Library. This command used to be named Execute-Script - a matching alias added for compatibility with older scripts.
+
+## Syntax
+
+Invoke-Script \[-Item\] <Item> \[-ArgumentList <Object\[\]>\]
+
+Invoke-Script \[-Path\] <String> \[-ArgumentList <Object\[\]>\]
+
+## Detailed Description
+
+Executes a script from Sitecore PowerShell Extensions Script Library.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Aliases
+
+The following abbreviations are aliases for this cmdlet:
+
+* Execute-Script 
+
+## Parameters
+
+### -Item  <Item>
+
+The script item to be executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the script item to be executed. Path can be absolute or Relavie to Script library root. e.g. the following two commands are equivalent:
+
+PS master:\> Invoke-Script 'master:\system\Modules\PowerShell\Script Library\Examples\Script Testing\Long Running Script with Progress Demo' PS master:\> Invoke-Script 'Examples\Script Testing\Long Running Script with Progress Demo'
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ArgumentList  <Object\[\]>
+
+| 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.Object 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+Invoke-Script 'Examples\Script Testing\Long Running Script with Progress Demo'
+```
+
+### EXAMPLE 2
+
+Run a script with arguments passed in.
+
+```powershell
+$scriptItem = Get-Item -Path "master:" -ID "{35311878-54EF-4E7A-9B95-3B63F5DEE97D}"
+
+$arguments = @{
+    TemplateId = "{76036F5E-CBCE-46D1-AF0A-4143F9B557AA}"
+}
+$scriptItem | Invoke-Script -ArgumentList $arguments
+```
+
+The arguments are passed and used in the called script like below:
+
+```powershell
+param($params)
+$templateId = $params.templateId
+
+Get-ItemReferrer -ID $templateId
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Import-Function](import-function.md)
+