Adds and optionally builds an enterprise search index
Add-EnterpriseSearchIndex [[-LogFilesPath] <String>] [[-IndexName] <String>] [[-OverwriteIndex] <Boolean>] [[-TemplateName] <String>] [[-Companies] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-EpicorAppserverUri] <String>] [[-EpicorBinding] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-EpicorDatabaseName] <String>] [[-DnsIdentity] <String>] [[-BuildIndex] <Boolean>] [-CheckForBugFixes] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The location where the configuration Xml and log files will be stored at | false | false | |||
The index name to use (specify it without dashes '-') | false | false | |||
Overwrites an existing index | false | false | True | ||
The index template to use | false | false | EpicorERP | ||
The companies to filter to in the index, leave blank for all companies that the user has access to | false | false | |||
The Epicor user name to login as | false | false | |||
The Epicor user password to login as | false | false | |||
The Epicor Uri to use | false | false | |||
A valid Epicor binding to connect to with | false | false | HttpsBinaryUsernameChannel | ||
The Epicor Sql Server database server name or instance | false | false | |||
The Epicor Sql Server database user name | false | false | |||
The Epicor Sql Server database user password | false | false | |||
Set to $true if you want to use the Sql Server's integrated security option | false | false | False | ||
The Epicor database name to connect to | false | false | |||
Optional Dns identity to connect with, for use the Ssl secured Net.tcp bindings | false | false | |||
Set this option if you also want to build the newly created index in the same action | false | false | True | ||
Set this option if you want to retrieve the latest bug fixes for your version | false | false | False |
Add an enterprise search index and build it at the same time
This function uses epicor/epicor credentials to create a new ERP user
Add-ErpUser [[-EpicorAppserverUri] <String>] [[-UserName] <String>] [[-ERPUserName] <String>] [[-ERPPassword] <SecureString>] [[-Companies] <Object>] [[-CurrentCompany] <String>] [[-CurrentPlant] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Local domain for erp environment | false | false | |||
User name to be created | false | false | |||
Existing user in the erp to run the user validation | false | false | |||
Password for the existing erp user | false | false | |||
Object array that contains companies and plants that will be assigned to the user | false | false | |||
Name of the current company for the new user | false | false | |||
Name of the current plant for the new user | false | false |
Create a user with a set of companies assigned to it
Adds a task agent
Add-TaskAgent [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-TaskAgentName] <String>] [[-EpicorAppserverUri] <String>] [[-EpicorBinding] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-DnsIdentity] <String>] [[-OperationTimeout] <Int32>] [[-MaxConnectionAttempts] <Int32>] [[-MaxConcurrentTasks] <Int32>] [[-ValidateWcfCert] <Boolean>] [[-RestartDelay] <Int32>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Task Agent Agent name to use | false | false | |||
The Epicor Uri where the Task Agent will point to | false | false | |||
A valid Epicor Binding to use to connect to with the Task Agent | false | false | HttpsBinaryUsernameChannel | ||
The Epicor User name to connect the task agent as | false | false | |||
The Epicor password to connect the task agent with | false | false | |||
false | false | ||||
The amount of time to wait before a call to the server will timeout in seconds. | false | false | 86400 | ||
The maximum number of times a call will try to connect to the appserver before failing. | false | false | 10 | ||
The maximum number of simultaneous tasks that can be run. | false | false | 20 | ||
If using an SSL endpoint binding, should the SSL certificate be validated. | false | false | False | ||
Indicates the amount of time to wait before restarting when an agent fails due to an error. Minimum value is 45; maximum value is 300. |
false | false | 45 | ||
Alternate location where the task agent is installed at | false | false |
Adds a task agent
Adds a task agent whilst also setting up logging to the error log stream
Adds a tracing logger for all of the base E10 tools, allows for you to capture the Error stream of a call
Add-TracingLog [[-ToolLoggerName] <String>] [[-ToolPath] <String>] [[-ToolExeName] <String>] [[-ToolVersionNumber] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Name of the logger of the tool to trace | false | false | |||
The path to the tool if you have it | false | false | |||
Name of the exe, can include an extra path, so that you could say DBMigration\My.exe | false | false | |||
Version number to use (for ICE applications), this will be combined after the ToolPath argument then the ToolExe argument so that your string will look like: "$($ToolPath)$($ToolVersionNumber)$($ToolExeName)" |
false | false |
Adds the trace logger to the SetupEnvironmentUI.exe tool
Adds the trace logger to the SetupEnvironmentUI.exe tool, if you want the script to setup the version number for you
Builds an enterprise search index
Build-EnterpriseSearchIndex [[-LogFilesPath] <String>] [[-IndexName] <String>] [[-OverwriteIndex] <Boolean>] [[-TemplateName] <String>] [[-Companies] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-EpicorAppserverUri] <String>] [[-EpicorBinding] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-EpicorDatabaseName] <String>] [[-DnsIdentity] <String>] [-CheckForBugFixes] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The location where the configuration Xml and log files will be stored at | false | false | |||
The index name to use (specify it without dashes '-') | false | false | |||
Overwrites an existing index | false | false | True | ||
The index template to use | false | false | EpicorERP | ||
The companies to filter to in the index, leave blank for all companies that the user has access to | false | false | |||
The Epicor user name to login as | false | false | |||
The Epicor user password to login as | false | false | |||
The Epicor Uri to use | false | false | |||
A valid Epicor binding to connect to with | false | false | HttpsBinaryUsernameChannel | ||
The Epicor Sql Server database server name or instance | false | false | |||
The Epicor Sql Server database user name | false | false | |||
The Epicor Sql Server database user password | false | false | |||
Set to $true if you want to use the Sql Server's integrated security option | false | false | False | ||
The Epicor database name to connect to | false | false | |||
Optional Dns identity to connect with, for use the Ssl secured Net.tcp bindings | false | false | |||
Set this option if you want to retrieve the latest bug fixes for your version | false | false | False |
Add an enterprise search index and build it at the same time
Deserializes an HVI document from the compressed format stored in the Erp 10 database
Deserialize-HVIDocument [[-AssembliesFilePath] <String>] [[-CompanyId] <String>] [[-GroupId] <Int32>] [[-DocumentNumber] <Int32>] [[-ConnectionString] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Path to the Epicor ERP 10 server directory | false | false | |||
Company ID of the record | false | false | |||
Group ID of the record | false | false | 0 | ||
Document Number of the record | false | false | 0 | ||
Connection string to the Sql database where the record is stored at | false | false |
Deserialize-HVIDocument -AssembliesFilePath "C:\Clean\Ice\Server\" -CompanyId "EPIC03" -GroupId 2 -DocumentNumber 1 -ConnectionString "Data Source=localhost;Initial Catalog=ice3golden;User ID=sa;Password=Epicor123;Min Pool Size=2;Max Pool Size=10;MultipleActiveResultSets=True"
Disables a feature flag on an E10 instance
Disable-FeatureFlag [[-EpicorSmartClientFolder] <String>] [[-LogFilesPath] <String>] [[-SysConfigFilePath] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-FeatureToEnableOrDisable] <String>] [[-Level] <String>] [[-Target] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor Erp smart client directory | false | false | |||
The location where the configuration Xml and log files will be saved to | false | false | |||
The Sysconfig file path to login with | false | false | |||
The Epicor user name to use | false | false | |||
The Epicor user password to use | false | false | |||
Feature id to enable or disable | false | false | |||
One of System, Tenant, Company, Group or User | false | false | |||
The identifier for the level (for example, user ID). Not needed for System. | false | false |
Disables the feature flag "79479C59-021B-40C4-A8D3-2F859FD8CD6B"
Enables a feature flag on an E10 instance
Enable-FeatureFlag [[-EpicorSmartClientFolder] <String>] [[-LogFilesPath] <String>] [[-SysConfigFilePath] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-FeatureToEnableOrDisable] <String>] [[-Level] <String>] [[-Target] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor Erp smart client directory | false | false | |||
The location where the configuration Xml and log files will be saved to | false | false | |||
The Sysconfig file path to login with | false | false | |||
The Epicor user name to use | false | false | |||
The Epicor user password to use | false | false | |||
Feature id to enable or disable | false | false | |||
One of System, Tenant, Company, Group or User | false | false | |||
The identifier for the level (for example, user ID). Not needed for System. | false | false |
Enables the feature flag "79479C59-021B-40C4-A8D3-2F859FD8CD6B"
Retrieves the current E10 version from an E10 database
Get-E10VersionFromDb [[-DatabaseName] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 database to retrieve its version from | false | false | |||
The local Sql instance to use | false | false | |||
The Sql user to use | false | false | |||
The Sql password to use | false | false | |||
Set to $true if you want to use the Sql integrated security option | false | false | False |
Returns the E10 version from an E10 database
Retrieves if a minor update (10.2.200.2 to 10.2.200.3) is being performed
Get-IfAMinorUpgradeShouldBeMade [[-CurrentE10Version] <String>] [[-PreviousE10Version] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The current E10 version | false | false | |||
The previous E10 version | false | false |
The following sample should return true
Retrieves if a DB update (10.2.200 to 10.2.300) should be performed
Get-IfDbShouldBeUpdated [[-CurrentE10Version] <String>] [[-PreviousE10Version] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The current E10 version | false | false | |||
The previous E10 version | false | false |
The following sample should return false
The following sample should return true
This function uses epicor/epicor credentials to validate if a user exists on ERP
Get-IfErpUserExists [[-EpicorAppserverUri] <String>] [[-UserName] <String>] [[-ERPUserName] <String>] [[-ERPPassword] <SecureString>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Local domain for erp environment | false | false | |||
User name to be validated | false | false | |||
Existing user in the erp to run the user validation | false | false | |||
Password for the existing erp user | false | false |
Checks if a user exists
Grants permissions to the provided user to modify web config and app server config files
Grant-PermissionsToModifyErpConfig [[-UserName] <String>] [[-ServerFolder] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The user that will be processed | false | false | |||
The server path | false | false |
Grants permissions to the desired folder to a user
Imports a reports.zip file into your Ssrs report server
Import-ErpSsrsReports [[-SsrsBaseUrl] <String>] [[-E10TemporaryReportsSqlServerName] <String>] [[-E10TemporaryReportsDatabaseName] <String>] [[-ReportsImportPath] <String>] [[-ReportsRootFolder] <String>] [[-DbUser] <String>] [[-DbPassword] <String>] [[-E10Version] <String>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The web service URL from SSRS | false | false | |||
The name of the Erp temporary reports Sql Server name | false | false | |||
The name of the Erp temporary reports Sql Server database name | false | false | |||
Path where the reports.zip file is located at | false | false | |||
Root folder where the reports will be stored at Ssrs, optional | false | false | |||
User to connect to when creating the Ssrs database, omit this and DbPassword for integrated security | false | false | |||
User password to connect to when creating the Ssrs database, omit this and DbUser for integrated security | false | false | |||
E10 version | false | false | |||
Deployment directory where the SetupEnvironment.exe is located at | false | false |
Imports the "C:\Epicor\ERP10\ERP10.2.300.0\Server\reports.zip" zip file into the "MyTenant" folder inside the "http://localhost/ReportServer_SQL2016" Ssrs server
Installs a base64 encoded certificate into the current machine localmachine store and installs it into the default website As well as it changes the host name of the Default Web Site to your input
Install-CertificateFromBase64String [[-CertificateInBase64] <String>] [[-CertificateSearchString] <String>] [[-DefaultWebSiteHostName] <String>] [[-CertificatePassword] <SecureString>] [[-FolderForCertificateFile] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
A pfx certificate in the base64 format | false | false | |||
A string representation on how to search for the certificate to import | false | false | |||
The host name to set the Default Web Site | false | false | |||
The certificate password | false | false | |||
The folder where the base64 certificate will be saved into | false | false | F:\Epicor\ERP10\ISV\Common\Certificate |
Installs a certificate ito the Local Machine store
Installs an Epicor ERP release from a repository into the current machine
Install-Erp [[-E10Version] <String>] [[-installMediaDirectory] <String>] [[-e10MediaBlobUri] <String>] [[-blobContainerName] <String>] [[-e10MediaSAS] <String>] [[-udContainerName] <String>] [[-installersLocalPath] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor ERP 10 version to install | false | false | |||
The directory where to save the installation media | false | false | |||
The storage account blob uri, defaults to the ISV program data | false | false | https://e10media.blob.core.windows.net/ | ||
The storage account blob container (folder) name where the iso and/or UD.exe files are located | false | false | installers | ||
The Shared Access Signature that allows to download the specified e10 release, defaults to the ISV program data | false | false | sv=2017-07-29&ss=b&srt=o&sp=r&se=2030-03-22T22:45:08Z&st=2018-03-22T14:45:08Z&spr=https&sig=eqQo9qI0ZXnwDifAHtGHJEt7cDp4Ik%2Bmdk1%2BFT0AoBg%3D | ||
The storage account blob container (folder) name where UD.exe files are located, optional, if blank it'll default to blobContainerName |
false | false | installers | ||
A local path to where the installers .ISO and UD.exe files are located | false | false |
Downloads the Epicor ERP version 10.2.200.0 and the Update release 10.2.200.4
Downloads the Epicor ERP version 10.2.300.0
Downloads the Epicor ERP version 10.2.300.0 from a different than the default blob uri (where the access level is public)
Downloads the Epicor ERP version 10.2.300.0 from a different than the default blob uri (where the access level is public)
Downloads the Epicor ERP version 10.2.300.0 from a different than the default blob uri, when you need a SAS to access the contents
Installs the Epicor ERP version 10.2.300.0 from a folder where the files are located
Installs the Epicor ERP version 10.2.300.0 from a shared folder where the files are located
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Installs the AdminConsole.msi silently
Install-ErpAdminConsole [[-PathToAdminConsoleMsi] <String>] [[-LogFilesPath] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The location where the AdminConsole.msi is located at | false | false | |||
The location where the log files will be saved to | false | false |
Installs the adminconsole.msi from a directory
Installs an admin console update silently
Install-ErpAdminConsoleUpdater [[-AdminConsoleUpdaterExePath] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The location where the AdminConsoleUpdater.exe is located at | false | false |
Installs the update from a directory
Installs an Epicor Erp 10 instance as well as it can also upgrade an existing instance
Install-ErpAppserver [[-E10Version] <String>] [[-PreviousE10Version] <String>] [[-LogFilesPath] <String>] [[-AppserverName] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-UseApppoolIdentity] <Boolean>] [[-ApplicationPoolUserName] <String>] [[-ApplicationPoolUserPassword] <SecureString>] [[-EpicorDatabaseName] <String>] [[-HttpsBinding] <String>] [[-HttpBinding] <String>] [[-NetTcpBinding] <String>] [[-DNSIdentity] <String>] [[-ServerName] <String>] [[-CreateSsrsDatabase] <Boolean>] [[-ConfigureSsrsReports] <Boolean>] [[-SSRSImport] <Boolean>] [[-SsrsDatabaseName] <String>] [[-SsrsInstallLocation] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-SsrsSqlServer] <String>] [[-SsrsTargetSqlUser] <String>] [[-SsrsTargetSqlPassword] <SecureString>] [[-SsrsTargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-WebSiteDirectory] <String>] [[-SSRSBaseUrl] <String>] [-CheckForBugFixes] [-UpgradeSiteOnly] [-UpdateSiteProperties] [[-CorsAllowedOrigins] <String>] [[-SSRSReportDirectory] <String>] [[-SSRSRoot] <String>] [[-CustomDirectory] <String>] [[-SSLCertSubjectName] <String>] [[-CustomDirectoriesToRemove] <String>] [[-DeploymentDirectory] <String>] [[-CryptographyRegime] <String>] [[-ApplicationPoolName] <String>] [[-SetupEnvironmentPath] <String>] [-ApplyAppserverPatches] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The target E10 version to use | false | false | |||
The previous E10 version that the system is currently at (mandatory if you use -UpgradeSiteOnly when you want to upgrade an existing site) |
false | false | |||
The directory where the configuration Xml and log files will be saved to | false | false | |||
The appserver name to use | false | false | |||
The Epicor user name to login as | false | false | |||
The Epicor user password to login as | false | false | |||
$true if you want to use the IIS embeded AppPoolIdentity | false | false | False | ||
If you set -UseApppoolIdentity as $false, specify this as the user to login the application pool as | false | false | |||
If you set -UseApppoolIdentity as $false, specify this as the user password to login the application pool as | false | false | |||
The Epicor database name to use | false | false | |||
One of the valid Https bindings available to use | false | false | HttpsBinaryUsernameChannel | ||
One of the valid Http bindings available to use | false | false | |||
Specify one of the NetTcp bindings available to use | false | false | |||
Dns identity to use for Ssl secured NetTcp bindings | false | false | |||
The current machine name where the application server is installed or upgraded | false | false | |||
$true if an Epicor Temporary Ssrs database should be created | false | false | True | ||
If the Ssrs reports should be imported into the ReportServer database | false | false | True | ||
If set to true it'll import the SSRS reports | false | false | True | ||
The target Epicor Temporary Ssrs database | false | false | |||
The Ssrs installation location (i.e. Reporting Services\ReportServer directory location or Unc path) | false | false | |||
The Sql server location where the Erp database is saved, if you don't enter an -SsrsSqlServer value this parameter will be used |
false | false | |||
The Sql server user where the Erp database is saved, if you don't enter an -SsrsTargetSqlUser value this parameter will be used |
false | false | |||
The Sql server user password where the Erp database is saved, if you don't enter an -SsrsTargetSqlPassword value this parameter will be used |
false | false | |||
Specifies if the Sql connection should be made with the integrated security option, if you don't enter an -SsrsTargetSqlAuthenticationIsIntegratedSecurity value this parameter will be used |
false | false | False | ||
The Sql server location where the Erp Temporary reports database is saved | false | false | |||
The Sql server user to use where the Erp Temporary reports database is saved | false | false | |||
The Sql server user password to use where the Erp Temporary reports database is saved | false | false | |||
Specifies if the Sql connection should be made with the integrated security option to use where the Erp Temporary reports database is saved |
false | false | False | ||
The website directory where to store the Server\Assemblies and Server\Bin directories and other artifacts | false | false | C:\inetpub\wwwroot | ||
The Ssrs base Uri (i.e. the ReportServer Uri http://localhost/ReportServer_SQL2016) | false | false | http://localhost/ReportServer_SQL2016 | ||
Set if you want the installer to automatically install the latest optional patches for the current version | false | false | False | ||
Set if you want to upgrade an existing site, if set, also set the PreviousE10Version parameter | false | false | False | ||
Set if you want to only update the properties of an existing site | false | false | False | ||
Set the CORS origins that you need to have for this site | false | false | * | ||
Sets the reports directory if you need to override it, default is: c:\Epicor\ERP10\ERP<E10Version>\SupplementalInstalls\SSRS\reports |
false | false | |||
Sets the SSRSRoot folder for the individual location where your reports will be stored at, if not provided the appserver name will be used |
false | false | |||
Custom CustomDirectory argument | false | false | |||
SSL Certificate Subject Name setting | false | false | |||
Remove these custom directories from the AssemblyFileSystem appsetting upon a complete deployment, separated by semicolons |
false | false | |||
Alertante deployment directory | false | false | |||
Starting from 10.2.300.0, Cryptography Regime defines the cryptography regime to use, available options are None and FIPS-140 |
false | false | None | ||
Alternate application pool name, override if you want an application pool name other than the -AppserverName argument | false | false | |||
false | false | ||||
If you provide this argument existing patches found in the environment will be applied post-deployment of the appserver | false | false | False |
Installs a new Erp instance
Upgrades an Erp instance
Updates the properties of a site
Installs a new Erp instance whilst also setting up logging to the error log stream
Creates an Empty or Demo database as well as it can also upgrade it (only available when moving from build to build version i.e. 10.2.100 to 10.2.200)
Install-ErpDatabase [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-DatabaseName] <String>] [[-Action] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-DeploymentDirectory] <String>] [-CheckForBugFixes] [-AzureSqlSupport] [[-AzureSqlServiceObjective] <String>] [[-AzureSqlDatabaseSizeInGB] <Int32>] [[-AzureSqlMaxDOP] <Int32>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor ERP 10 version to use to create/update the database | false | false | |||
The directory where the Xml configuration and other log files will be saved into | false | false | |||
The target database name to use | false | false | |||
The action to perform, either CreateDemoDB, UpgradeDB or CreateDB (Empty database) WARNING: If you use the CreateDemoDB or CreateDB you will have to delete the target database if it already exists |
false | false | CreateDemoDB | ||
The SQL server where the database will be/is | false | false | |||
The Sql user to use to login | false | false | |||
The Sql password to use to login | false | false | |||
Set as true if the Sql connection should be performed using integrated security | false | false | False | ||
Alternate deployment directory if your E10 install isn't located at the C:\Epicor\ERP10 directory | false | false | |||
Set if you want the installer to automatically install the latest optional patches for the current version | false | false | False | ||
Adds support for deploying an Erp 10 database into Azure Sql (Please reinstall the Epicor Administration console if you'd like to remove this support) |
false | false | False | ||
Azure Sql database service objective, for more information review the SERVICE_OBJECTIVE from the following link: https://docs.microsoft.com/en-us/sql/t-sql/statements/create-database-transact-sql?view=azuresqldb-current |
false | false | S2 | ||
Size to setup your database (can be modified later through the Azure portal or through other means) in GB | false | false | 250 | ||
Max degree of parallelism used for heavy parallelized loads from the DBMigration program, allows for you to use small service objectives (like S2) |
false | false | 4 |
Creates an empty database
Creates a Demo database
Upgrades an existing database
Installs a database whilst also setting up logging to the error log stream
Installs an Epicor Erp education instance
Install-ErpEducation [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-ErpAppserverName] <String>] [[-EducationSiteName] <String>] [[-WebSiteDirectory] <String>] [[-ServerName] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [-UpgradeEducationSite] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The directory where the configuration Xml and log files will be saved to | false | false | |||
The Epicor Appserver name to connect to this instance | false | false | |||
The Epicor Erp Education site name | false | false | |||
The location where the Epicor Erp Education site will be installed to | false | false | C:\inetpub\wwwroot | ||
The name of the machine where the Education site will be installed to | false | false | |||
The Epicor user name to use to connect the Education site to the Epicor Erp site | false | false | |||
The Epicor user password to use to connect the Education site to the Epicor Erp site | false | false | |||
Set if you want an existing site to be upgraded to a newer release, it'll delete and recreate your existing site | false | false | False |
Installs a new Epicor Erp Education site
Installs a new Epicor Erp Education site while removing a previous version of it
Installs a new Epicor Erp Education site whilst also setting up logging to the error log stream
Installs an Epicor Enterprise Search instance
Install-ErpEnterpriseSearch [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-ErpAppserverName] <String>] [[-ServerName] <String>] [[-WebSiteInstallDirectory] <String>] [[-CreateDatabase] <String>] [[-ServiceAcctType] <String>] [[-ServiceUser] <String>] [[-ServiceUserPassword] <SecureString>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-DatabaseName] <String>] [-UpgradeEnterpriseSearch] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Epicor Erp server name to use | false | false | |||
The current machine name | false | false | |||
The location where to install the Enterprise Search Web mode site to | false | false | C:\inetpub\wwwroot\ | ||
Set to $true if you want to create an Enterprise search database | false | false | True | ||
A valid service account type, either LocalService/LocalSystem/NetworkService/User are valid | false | false | LocalSystem | ||
If you specify -ServiceAcctType as User enter a windows user name here | false | false | |||
If you specify -ServiceAcctType as User enter a windows user password here | false | false | |||
The database where the Enterprise Search database is located at | false | false | |||
The Sql user to login as | false | false | |||
The Sql user password to login as | false | false | |||
Set to $true if you want to use the Sql server's integrated security option | false | false | False | ||
The Enterprise Search database name | false | false | |||
Set if you want to delete a previous Enterprise Search installation and install a new one | false | false | False | ||
Alternate directory where the Enterprise Search is installed at | false | false |
Installs an Enterprise Search using a service user account
Installs an Enterprise Search using the LocalSystem account
Installs an Enterprise Search using a service user account whilst also setting up logging to the error log stream
Installs a new Epicor Erp Help instance
Install-ErpHelp [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-ErpAppserverName] <String>] [[-WebSiteDirectory] <String>] [[-HelpSiteName] <String>] [[-ServerName] <String>] [[-UseApppoolIdentity] <Boolean>] [[-ApplicationPoolUserName] <String>] [[-ApplicationPoolUserPassword] <SecureString>] [-UpgradeHelp] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Epicor Appserver name to use | false | false | |||
The location where the Help site will be saved into | false | false | C:\inetpub\wwwroot | ||
The name of the Help site | false | false | |||
The machine name where the help site will be installed to | false | false | |||
Set to $true if you want to use the built in Application Pool identity | false | false | True | ||
If -UseApppoolIdentity is set to $false, specify a windows user name to connect as | false | false | |||
If -UseApppoolIdentity is set to $false, specify a windows user password to connect as | false | false | |||
Set if you want to upgrade an existing help site by removing an old installation | false | false | False |
Installs an ERP Help site
Installs an ERP Help site whilst also setting up logging to the error log stream
Installs a license into an Erp instance
Install-ErpLicense [[-LicenseFilePath] <String>] [[-LogFilesPath] <String>] [[-E10Version] <String>] [[-AppserverUri] <String>] [[-ErpUserName] <String>] [[-ErpUserPassword] <SecureString>] [[-EndpointBinding] <String>] [[-CompaniesToLicense] <String[]>] [-ReplaceExistingLicense] [[-ErpDatabaseName] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The file path where the .lic file to install is located at | false | false | |||
The directory where the configuration Xml and log files will be stored at | false | false | |||
The E10 version to use | false | false | |||
The appserver Rest endpoint Uri of the Erp intance | false | false | |||
The Erp user name to login as | false | false | |||
The Erp user password to login as | false | false | |||
A valid endpoint binding to use to connect to E10 | false | false | |||
An array of companies to license @("CompanyA","CompanyB") | false | false | ("EPIC01", "EPIC02", "EPIC03", "EPIC04", "EPIC05", "EPIC06", "EPIC07", "GPC", "EPICPF") | ||
Set if you want to replace the current license being imported, set to true when the license to import already exists in the DB, i.e. when you upgrade it after expiration |
false | false | False | ||
The Erp database name | false | false | |||
The Sql server where the E10 database is located at | false | false | |||
The Sql user to login as | false | false | |||
The Sql user password to login as | false | false | |||
Set to $true if you want to use Sql Server's intragrated security | false | false | False | ||
Alternate deployment directory | false | false |
Installs a new license
Installs a new license but removes it first if it already exists
Installs the necessary prerequisites to install Epicor Erp 10
Install-ErpPrerequisites [<CommonParameters>]
Installs the prerequisites necessary to install an ERP instance in a Windows client OS
Installs the necessary prerequisites to install Epicor Erp 10
Install-ErpPrerequisitesForWindowsServer [<CommonParameters>]
Installs the prerequisites necessary to install an ERP instance in a Windows server OS
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
List a feature flag(s) on an E10 instance
List-FeatureFlag [[-EpicorSmartClientFolder] <String>] [[-LogFilesPath] <String>] [[-SysConfigFilePath] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-ListFeaturesForUser] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor Erp smart client directory | false | false | |||
The location where the configuration Xml and log files will be saved to | false | false | |||
The Sysconfig file path to login with | false | false | |||
The Epicor user name to use | false | false | |||
The Epicor user password to use | false | false | |||
If you specify ListFeatures you can specify a user name to list the features of a different user than the current user from EpicorUserName |
false | false |
Lists the feature flags of the current user
Lists the feature flags of an specific user
Creates a new Epicor temporary reports database
New-ErpReportDatabase [[-E10TemporaryReportsSqlServerName] <String>] [[-E10TemporaryReportsDatabaseName] <String>] [[-DbUser] <String>] [[-DbPassword] <String>] [[-E10Version] <String>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The name of the Erp temporary reports Sql Server name | false | false | |||
The name of the Erp temporary reports Sql Server database name | false | false | |||
User to connect to when creating the Ssrs database, omit this and DbPassword for integrated security | false | false | |||
User password to connect to when creating the Ssrs database, omit this and DbUser for integrated security | false | false | |||
E10 version | false | false | |||
Deployment directory where the SetupEnvironment.exe is located at | false | false |
Creates a new E10 temporary database with the name ErpTempReports
Creates a SQL Backup from a database in the current machine
New-SqlDbBackup [[-BackupLocation] <String>] [[-DatabaseToBackupName] <String>] [[-BackupDescription] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The location where to store the Sql backup | false | false | |||
The database to backup name | false | false | |||
The description to give the backup | false | false | |||
The local Sql instance to use | false | false | |||
The Sql user to use | false | false | |||
The Sql password to use | false | false | |||
Set to $true if you want to use the Sql integrated security option | false | false | False |
Creates a new Sql database backup
Removes a database from a Sql Server
Remove-Database [[-DatabaseName] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Database name to remove | false | false | |||
Sql server where the database will be removed | false | false | |||
Sql server user name to use | false | false | |||
Sql server user password to use | false | false | |||
Set to $true if you want to use Sql Server's integrated security option | false | false | False |
Removes a database from a Sql server
Removes an existing Epicor Enterprise Search installation
Remove-EnterpriseSearch [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-ErpAppserverName] <String>] [[-ServerName] <String>] [[-WebSiteInstallDirectory] <String>] [[-CreateDatabase] <String>] [[-ServiceAcctType] <String>] [[-ServiceUser] <String>] [[-ServiceUserPassword] <SecureString>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-DatabaseName] <String>] [[-SetupEnvironmentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Epicor Erp server name to use | false | false | |||
The current machine name | false | false | |||
The location where to install the Enterprise Search Web mode site to | false | false | C:\inetpub\wwwroot\ | ||
Set to $true if you want to create an Enterprise search database | false | false | True | ||
A valid service account type, either LocalService/LocalSystem/NetworkService/User are valid | false | false | LocalSystem | ||
If you specify -ServiceAcctType as User enter a windows user name here | false | false | |||
If you specify -ServiceAcctType as User enter a windows user password here | false | false | |||
The database where the Enterprise Search database is located at | false | false | |||
The Sql user to login as | false | false | |||
The Sql user password to login as | false | false | |||
Set to $true if you want to use the Sql server's integrated security option | false | false | False | ||
The Enterprise Search database name | false | false | |||
Location where the SetupEnvironmentUI.exe is located at | false | false |
Removes an Enterprise Search using a service user account
Removes an Enterprise Search using the LocalSystem account
Removes an Enterprise Search using a service user account whilst also setting up logging to the error log stream
Removes an Enterprise Search Index
Remove-EnterpriseSearchIndex [[-LogFilesPath] <String>] [[-IndexName] <String>] [-CheckForBugFixes] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Location where the configuration Xml and log files will be stored at | false | false | |||
The index name to remove | false | false | |||
Set if you want to check for the latest bug fixes to apply | false | false | False |
Remove-EnterpriseSearchIndex -LogFilesPath "C:\temp" -IndexName "E10LiveIndex" -CheckForBugFixes
Removes an existing Epicor Erp Education site
Remove-ErpEducation [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-ErpAppserverName] <String>] [[-EducationSiteName] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Epicor Erp appserver name to use | false | false | |||
The Education site name to remove | false | false |
Removes an Epicor Education site
Removes an Epicor Education site whilst also setting up logging to the error log stream
Removes an Epicor Erp Help instance
Remove-ErpHelp [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-ErpAppserverName] <String>] [[-HelpSiteName] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files are located at | false | false | |||
The Epicor Appserver to use | false | false | |||
The Help site name to remove | false | false |
Removes an ERP Help site
Removes an ERP Help site whilst also setting up logging to the error log stream
Removes an existing license from an Erp installation
Remove-ErpLicense [[-LicenseFilePath] <String>] [[-ErpDatabaseName] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-AppserverUri] <String>] [[-ErpUserName] <String>] [[-ErpUserPassword] <SecureString>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The path of the license to remove | false | false | |||
The E10 database name | false | false | |||
The Sql server name or instance where the database is located at | false | false | |||
The Sql user to use | false | false | |||
The Sql user password to use | false | false | |||
Specifies if the integrated security option should be used | false | false | False | ||
Sets the appserver Rest endpoint Uri of the existing E10 installation | false | false | |||
The user to login as to the Erp to delete the license | false | false | |||
The user password to login as to the Erp to delete the license | false | false | |||
Alternate deployment directory | false | false |
Removes a license from an Erp instance
Removes a Task Agent
Remove-TaskAgent [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-TaskAgentName] <String>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where configuration Xml files and log files are stored at | false | false | |||
The Task Agent name to remove | false | false | |||
Alternate location where the task agent is installed at | false | false |
Removes a task agent
Removes a task agent whilst also setting up logging to the error log stream
Removes a tracing logger for all of the base E10 tools, allows for you to capture the Error stream of a call
Remove-TracingLog [[-ToolLoggerName] <String>] [[-ToolPath] <String>] [[-ToolExeName] <String>] [[-ToolVersionNumber] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Name of the logger of the tool to trace | false | false | |||
The path to the tool if you have it | false | false | |||
Name of the exe, can include an extra path, so that you could say DBMigration\My.exe | false | false | |||
Version number to use (for ICE applications), this will be combined after the ToolPath argument then the ToolExe argument so that your string will look like: "$($ToolPath)$($ToolVersionNumber)$($ToolExeName)" |
false | false |
Removes the trace logger to the SetupEnvironmentUI.exe tool
Removes the trace logger to the SetupEnvironmentUI.exe tool, if you want the script to setup the version number for you
Changes Erp connection strings to use sql server authentication
Reset-ErpConnectionStrings [[-UserName] <String>] [[-Password] <SecureString>] [[-AppserverName] <String>] [[-TargetSqlServer] <String>] [[-WebConfigFullPath] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The user that will be processed | false | false | |||
The password for the provided user | false | false | |||
The name of the Appserver, this is the name of the ERP 10 databse | false | false | |||
The name of target sql server | false | false | |||
The full path of the web.config file | false | false |
Sets the connection strings of an ERP instance to the arguments passed
This function uses epicor/epicor credentials to reset an user password
Reset-ErpUserPassword [[-EpicorAppserverUri] <String>] [[-UserName] <String>] [[-ERPUserName] <String>] [[-ERPPassword] <SecureString>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Local domain for erp environment | false | false | |||
User name for password reset | false | false | |||
Existing user in the erp to run the user validation | false | false | |||
Password for the existing erp user | false | false |
Resets the password of a user
Restores a Sql database backup into the target Sql server (local server only)
Restore-DatabaseBackup [[-BackupLocation] <String>] [[-RestoredDBName] <String>] [[-TargetSqlServer] <String>] [[-TargetSqlUser] <String>] [[-TargetSqlPassword] <SecureString>] [[-TargetSqlAuthenticationIsIntegratedSecurity] <Boolean>] [[-MdfFileLocation] <String>] [[-LdfFileLocation] <String>] [-RemoteBackupRestore] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The .bak (or other backup file type) location | false | false | |||
The target name of the db after it is restored | false | false | |||
The Sql Server name or instance where the db will be restored to | false | false | |||
The Sql user to use | false | false | |||
The Sql password to use | false | false | |||
Set to $true if you want to use the Sql integrated security option | false | false | False | ||
Target location where the Mdf file will be stored at | false | false | F:\Data | ||
Target location where the Ldf file will be stored at | false | false | F:\Log | ||
Skips checks to review if the backup file exists in the current server | false | false | False |
Restores a backup using Sql authentication
Restores a backup using integrated security
Restores a backup overriding the final location of the Mdf and Ldf files
Enables/Disables/Lists a(all) feature flag(s) on an E10 instance
Run-FeatureFlag [[-EpicorSmartClientFolder] <String>] [[-LogFilesPath] <String>] [[-SysConfigFilePath] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [-EnableFeature] [-DisableFeature] [[-FeatureToEnableOrDisable] <String>] [[-Level] <String>] [[-Target] <String>] [-ListFeatures] [[-ListFeaturesForUser] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor Erp smart client directory | false | false | |||
The location where the configuration Xml and log files will be saved to | false | false | |||
The Sysconfig file path to login with | false | false | |||
The Epicor user name to use | false | false | |||
The Epicor user password to use | false | false | |||
Enables a feature | false | false | False | ||
Disables a feature | false | false | False | ||
Feature id to enable or disable | false | false | |||
One of System, Tenant, Company, Group or User | false | false | |||
The identifier for the level (for example, user ID). Not needed for System. | false | false | |||
Lists the features of the current user | false | false | False | ||
If you specify ListFeatures you can specify a user name to list the features of a different user than the current user from EpicorUserName |
false | false |
Configures the specified SSRS report server directory with the E10 specific tools in it
Set-ErpSsrsServer [[-ClientDirectory] <String>] [[-MicrosoftSsrsProgramDirectory] <String>] [[-E10Version] <String>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Erp client directory | false | false | |||
The path where your SSRS is installed at typically "C:\Program Files\Microsoft SQL Server\MSRS<SqlVersion>.<InstanceName>\Reporting Services\ReportServer\" |
false | false | |||
E10 version | false | false | |||
Deployment directory where the SetupEnvironment.exe is located at | false | false |
Configure the SqlInstance SQL 2016 SSRS directory
Enables the Identity Provider feature flag
Set-IdentityProviderFeatureFlag [[-EpicorSmartClientFolder] <String>] [[-LogFilesPath] <String>] [[-SysConfigFilePath] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-Enable] <Boolean>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor Erp smart client directory | false | false | |||
The location where the configuration Xml and log files will be saved to | false | false | |||
The Sysconfig file path to login with | false | false | |||
The Epicor user name to use | false | false | |||
The Epicor user password to use | false | false | |||
Enables or disables the Identity Provider feature flag | false | false | False |
Set-IdentityProviderFeatureFlag -EpicorSmartClientFolder "C:\agent\Idp\E10\Client" -LogFilesPath "C:\agent\Idp\Log" `
Set-IdentityProviderFeatureFlag -EpicorSmartClientFolder "C:\agent\Idp\E10\Client" -LogFilesPath "C:\agent\Idp\Log" `
Sets/updates/deletes the Identity provider configuration of an ERP 10 instance
Set-Idpconfig -E10Version <String> -LogFilesPath <String> [-DeleteConfig] -AppserverName <String> [-DeploymentDirectory <String>] -EpicorDatabaseName <String> -TargetSqlServer <String> [-TargetSqlUser <String>] [-TargetSqlPassword <SecureString>] [-TargetSqlAuthenticationIsIntegratedSecurity] [-CheckForBugFixes] [<CommonParameters>] Set-Idpconfig -E10Version <String> -LogFilesPath <String> [-UpdateConfig] -AppserverName <String> [-Endpoint <String>] [-Enabled] [-TokenValidationApiScope <String>] [-NativeClientID <String>] [-WebClientID <String>] [-ServerOnlyClientID <String>] [-ServerOnlyClientSecret <String>] [-UserExportEnabled] [-UserExportClientID <String>] [-UserExportClientSecret <String>] [-UserExportApiScope <String>] [-DeploymentDirectory <String>] -EpicorDatabaseName <String> -TargetSqlServer <String> [-TargetSqlUser <String>] [-TargetSqlPassword <SecureString>] [-TargetSqlAuthenticationIsIntegratedSecurity] [-CheckForBugFixes] [<CommonParameters>] Set-Idpconfig -E10Version <String> -LogFilesPath <String> [-CreateConfig] -AppserverName <String> [-Endpoint <String>] [-Enabled] [-TokenValidationApiScope <String>] [-NativeClientID <String>] [-WebClientID <String>] [-ServerOnlyClientID <String>] [-ServerOnlyClientSecret <String>] [-UserExportEnabled] [-UserExportClientID <String>] [-UserExportClientSecret <String>] [-UserExportApiScope <String>] [-DeploymentDirectory <String>] -EpicorDatabaseName <String> -TargetSqlServer <String> [-TargetSqlUser <String>] [-TargetSqlPassword <SecureString>] [-TargetSqlAuthenticationIsIntegratedSecurity] [-CheckForBugFixes] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor ERP 10 version to update | true | false | |||
The directory where the Xml configuration and other log files will be saved into | true | false | |||
Sets the configuration of the identity provider | true | false | False | ||
Updates the configuration of the identity provider | true | false | False | ||
Deletes the configuration of the identity provider | true | false | False | ||
The ERP 10 application to update (must be a pre-deployed application) | true | false | |||
URL where Identity Provider is installed | false | false | |||
True if Identity Provider should be enabled | false | false | False | ||
Scope for token validation in ERP 10 | false | false | |||
Application ID for the ERP 10 smart client | false | false | |||
Application ID for JavaScript client | false | false | |||
Application for inter-server communication | false | false | |||
Secret for inter-server communication | false | false | |||
True if export of Epicor users to Identity Provider is enabled | false | false | False | ||
Application ID to authenticate user export from Epicor ERP to Identity Provider | false | false | |||
Secret to authenticate user export from Epicor ERP 10 to Identity Provider | false | false | |||
Scope for user export into the Identity Provider | false | false | |||
Alternate deployment directory (defaults to "C:\Epicor\ERP10\ERP$baseErpVersion") | false | false | |||
The Epicor database name to use | true | false | |||
The Sql server location where the Erp database is stored at | true | false | |||
The Sql server user where the Erp database is stored at | false | false | |||
The Sql server user password where the Erp database is stored at | false | false | |||
Specifies if the Sql connection should be made with the integrated security option | false | false | False | ||
Set if you want the installer to automatically install the latest optional patches for the current version | false | false | False |
Set-Idpconfig -E10Version "10.2.400.0" -LogFilesPath "C:\agent\Idp\Log" -CreateConfig -AppserverName "Radio" -Endpoint "https://idp.developer.epicor.com" -Enabled -TokenValidationApiScope "" -NativeClientID "native.hybrid" -WebClientID "spa1" -ServerOnlyClientID "client" -ServerOnlyClientSecret "95f6e15b-95bc-4ddc-9c6e-ae28d1ae1859" -UserExportEnabled -UserExportClientID "scimClient" -UserExportClientSecret "de32cef4-39fa-4919-b0f3-f7772de724fd" -UserExportApiScope "" -EpicorDatabaseName "ICE3Golden" -TargetSqlServer "localhost" -TargetSqlUser "sa" -TargetSqlPassword (ConvertTo-SecureString -String "Epicor123" -AsPlainText -Force)
Set-Idpconfig -E10Version "10.2.400.0" -LogFilesPath "C:\agent\Idp\Log" -CreateConfig -AppserverName "Radio" -Endpoint "https://idp.developer.epicor.com" -Enabled -TokenValidationApiScope "" -NativeClientID "native.hybrid" -WebClientID "spa1" -ServerOnlyClientID "client" -ServerOnlyClientSecret "95f6e15b-95bc-4ddc-9c6e-ae28d1ae1859" -UserExportEnabled -UserExportClientID "scimClient" -UserExportClientSecret "de32cef4-39fa-4919-b0f3-f7772de724fd" -UserExportApiScope "" -EpicorDatabaseName "ICE3Golden" -TargetSqlServer "localhost" -TargetSqlUser "sa" -TargetSqlPassword (ConvertTo-SecureString -String "Epicor123" -AsPlainText -Force)
Set-Idpconfig -E10Version "10.2.400.0" -LogFilesPath "C:\agent\Idp\Log" -DeleteConfig -AppserverName "Radio" -EpicorDatabaseName "ICE3Golden" -TargetSqlServer "localhost" -TargetSqlUser "sa" -TargetSqlPassword (ConvertTo-SecureString -String "Epicor123" -AsPlainText -Force)
$Global:eventViewerlogName = "EpicorISVServices"
Sets user mapping between Epicor ERP users and the Identity Provider
Set-IdpUserMapping -E10Version <String> -LogFilesPath <String> -AppserverName <String> -ErpUser <String> -IdpUser <String> [-DeploymentDirectory <String>] -EpicorDatabaseName <String> -TargetSqlServer <String> [-TargetSqlUser <String>] [-TargetSqlPassword <SecureString>] [-TargetSqlAuthenticationIsIntegratedSecurity] [-CheckForBugFixes] [<CommonParameters>] Set-IdpUserMapping -E10Version <String> -LogFilesPath <String> -AppserverName <String> -UserMapping <IdpUserMap[]> [-DeploymentDirectory <String>] -EpicorDatabaseName <String> -TargetSqlServer <String> [-TargetSqlUser <String>] [-TargetSqlPassword <SecureString>] [-TargetSqlAuthenticationIsIntegratedSecurity] [-CheckForBugFixes] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The Epicor ERP 10 version to update | true | false | |||
The directory where the Xml configuration and other log files will be saved into | true | false | |||
true | false | ||||
true | false | ||||
true | false | ||||
Defines the ERP 10 user and Identity provider user to map in the target ERP 10 server | true | false | |||
Alternate deployment directory (defaults to "C:\Epicor\ERP10\ERP$baseErpVersion") | false | false | |||
The Epicor database name to use | true | false | |||
The Sql server location where the Erp database is stored at | true | false | |||
The Sql server user where the Erp database is stored at | false | false | |||
The Sql server user password where the Erp database is stored at | false | false | |||
Specifies if the Sql connection should be made with the integrated security option | false | false | False | ||
Set if you want the installer to automatically install the latest optional patches for the current version | false | false | False |
Set-IdpUserMapping -E10Version "10.2.400.0" -AppserverName "Radio" -LogFilesPath "C:\agent\idp\log" -ErpUser "manager" -IdpUser "ivaldez@epicor.com" -ErrorVariable errors -EpicorDatabaseName "ICE3Golden" -TargetSqlServer "localhost" -TargetSqlUser "sa" -TargetSqlPassword (ConvertTo-SecureString -String "Epicor123" -AsPlainText -Force)EXAMPLE 2
Set-IdpUserMapping -E10Version "10.2.400.0" -AppserverName "Radio" -LogFilesPath "C:\agent\idp\log" -UserMapping @(@{ErpUserName="manager";IdpUserName="ivaldez@epicor.com"},@{ErpUserName="epicor";IdpUserName="ivaldez@gmail.com"}) -ErrorVariable errors -EpicorDatabaseName "ICE3Golden" -TargetSqlServer "localhost" -TargetSqlUser "sa" -TargetSqlPassword (ConvertTo-SecureString -String "Epicor123" -AsPlainText -Force)
$Global:eventViewerlogName = "EpicorISVServices"
Creates a website as well as it sets a certificate in a website in IIS
Set-NewWebSite [[-WebsiteName] <String>] [[-WebsiteHostName] <String>] [[-CertificateSearchString] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Name of the website to create | false | false | |||
Name of the host to use | false | false | |||
The string to use to search the certificate to use in the new website | false | false |
Adjusts an IIS Website and points it to a host name, whilst also setting up a certificate thumbprint (non-optional) via a search string
Installs and executes the Epicor ConversionRunner program
Start-ConversionRunner [[-E10Version] <String>] [[-EpicorSmartClientFolder] <String>] [[-LogFilesPath] <String>] [[-SysConfigFilePath] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-AdditionalConversions] <Object[]>] [[-TimeoutInMinutes] <Int32>] [[-NumberOfRetries] <Int32>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to upgrade to | false | false | |||
The Epicor Erp smart client directory | false | false | |||
The location where the configuration Xml and log files will be saved to | false | false | |||
The Sysconfig file path to login with | false | false | |||
The Epicor user name to use | false | false | |||
The Epicor user password to use | false | false | |||
Additional conversions to run on demand | false | false | |||
If the timeout is hit, the current instance of the conversion runner will be halted and a new one will be started | false | false | 15 | ||
Number of retries before ending all processing | false | false | 15 |
Starts all required conversions for a database
Starts all conversions required for a database as well as also launching the cvpe0000 and cvpe0001 conversions
Runs 1 or more steps from the SetupEnvironment.exe program that the SetupEnvironmentUI.exe calls internally
Start-SetupEnvironment [[-EnabledSteps] <String[]>] [[-DisabledSteps] <String[]>] [[-Arguments] <Object>] [[-SSRSArguments] <Object>] [[-E10Version] <String>] [[-DeploymentDirectory] <String>] [-CheckForBugFixes] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Array of steps to enable | false | false | |||
Array of steps to disable | false | false | |||
Arguments for the common settings | false | false | |||
Arguments for the Ssrs settings | false | false | |||
E10 version | false | false | |||
Deployment directory where the SetupEnvironment.exe is located at | false | false | |||
Checks for new releases of the SetupEnvironment.exe tool for your E10 version | false | false | False |
Imports the "C:\Epicor\ERP10\ERP10.2.300.0\Server\reports.zip" zip file into the "MyTenant" folder inside the "http://localhost/ReportServer_SQL2016" Ssrs server
Function used to execute in parallel the solution workbench command line program
This function allows to throttle the execution that you need to run using runspaces
that is done so that you don't run many of them at the same time and to give you control over how many to run at the
same time
Use the -Verbose or -Debug arguments to view those outputs from the individual calls
Each execution creates a log file in the following format for each file, its output location cannot be controlled
{FileName}.Output.txt - The output from the Solution.exe executed
{FileName}.Error.txt - The error output from the Solution.exe executed
Start-SolutionImportRunner [-CabDirectory] <String> [-Config] <String> [-PathToSolutionExe] <String> [[-EpicorUserId] <String>] [[-EpicorUserPassword] <SecureString>] [[-DegreeOfParallelism] <Int32>] [[-RedirectOutputToConsoleInsteadOfFile]] [[-BackupExistingLogFiles]] [[-RetryCount] <Int32>] [[-RetryWaitTime] <Int32>] [[-ForceCompanyInFileName]] [[-Use102300]] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Specify the directory or directories (comma separated, including subdirectories) where the cab files reside the format of the cab files is the following in order to be used by this function tag_Company_UniqueName_exportedVersionNumber.cab If the format doesn't fall in the above format, the import will continue, if you want to prevent this behavior see the flag -ForceCompanyInFileName |
true | false | |||
Specifies the config (.SysConfig) file that will be used by the Solution.exe target | true | false | |||
Specifies the path (including the Solution.exe file name) to execute in this script | true | false | |||
Specifies the Epicor user Id to be used to login in the Solution.exe target, exclude for Windows authentication/SSO | false | false | |||
Specifies the password of the user to login into Epicor, exclude for Windows authentication/SSO Use the following sample to generate a secure string: $securedPassword = ConvertTo-SecureString -String "MySecurePassword" -Force -AsPlainText or: $securePassword = (Read-Host) | ConvertTo-SecureString -Force -AsPlainText |
false | false | [SecureString]::new() | ||
Specify the degree of parallelism that the function will use to execute Solution.exe in parallel (i.e. number of Solution.exe that you'll see in windows task manager) |
false | false | 4 | ||
Specify this argument if you need to redirect all output into the current command prompt executing this function instead of a file (default) |
false | false | False | ||
Specify this argument if you need to create a backup of the existing log files for each of the cab files, the default behavior is to overwrite them |
false | false | False | ||
Specify this argument to override the default retry count to wait until an individual job (execution of Solution.exe) is complete reducing this argument may improve completion performance of the whole operation (all files processed by Solution.exe) |
false | false | 2 | ||
Specify this argument to override the default retry time to wait until an individual job (execution of Solution.exe is complete) parameter is in seconds reducing this argument may improve completion performance of the whole operation (all files processed by Solution.exe) |
false | false | 1 | ||
Specify this parameter if you'd like for the company to be checked for it being in the file name this switch argument requires that your files match the following pattern exclusively otherwise an error will be thrown tag_Company_UniqueName_exportedVersionNumber.cab |
false | false | [switch]::Present | ||
The API to access the solution.exe program changed in the 10.2.300 version and above, this switch will enable a fix to allow that version to work |
false | false | [switch]::Present |
The following sample runs with the default settings
The following sample runs the folder found with a degree of parallelism of 20, i.e. 20 cab files can run at once
The following sample runs with the setting set to show any output from the executed Solution.exe in the host output window
The following sample runs with the setting to backup existing log files (error or output) in the same folder
The following sample runs with the settings related to the retry operation overridden
The following sample runs against a server configured with Windows Authentication/SSO enabled
The following sample runs with the setting set to show any output from the executed Solution.exe in the log files (force false redirect)
The following sample runs against a server configured with Windows Authentication/SSO enabled in a 10.2.300 or above environment
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false | |||
None | false | false |
Starts a task agent agent
Start-TaskAgent [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-TaskAgentName] <String>] [[-EpicorAppserverUri] <String>] [[-EpicorBinding] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Task Agent Agent name to use | false | false | |||
The Epicor Uri where the Task Agent will point to | false | false | |||
A valid Epicor Binding to use to connect to with the Task Agent | false | false | HttpsBinaryUsernameChannel | ||
The Epicor User name to connect the task agent as | false | false | |||
The Epicor password to connect the task agent with | false | false | |||
Alternate location where the task agent is installed at | false | false |
Starts a task agent
Starts a task agent whilst also setting up logging to the error log stream
Stops a task agent agent
Stop-TaskAgent [[-E10Version] <String>] [[-LogFilesPath] <String>] [[-TaskAgentName] <String>] [[-EpicorAppserverUri] <String>] [[-EpicorBinding] <String>] [[-EpicorUserName] <String>] [[-EpicorUserPassword] <SecureString>] [[-DeploymentDirectory] <String>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
The E10 version to use | false | false | |||
The location where the configuration Xml and log files will be stored at | false | false | |||
The Task Agent Agent name to use | false | false | |||
The Epicor Uri where the Task Agent will point to | false | false | |||
A valid Epicor Binding to use to connect to with the Task Agent | false | false | HttpsBinaryUsernameChannel | ||
The Epicor User name to connect the task agent as | false | false | |||
The Epicor password to connect the task agent with | false | false | |||
Alternate location where the task agent is installed at | false | false |
Stops a task agent
Stops a task agent whilst also setting up logging to the error log stream
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|
This function uses epicor/epicor credentials to update an user password
Update-ErpUserPassword [[-EpicorAppserverUri] <String>] [[-EpicorSmartClientFolder] <String>] [[-UserName] <String>] [[-Password] <SecureString>] [[-ERPUserName] <String>] [[-ERPPassword] <SecureString>] [<CommonParameters>]
Name | Alias | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Local domain for erp environment | false | false | |||
The Epicor Erp smart client directory | false | false | |||
User name to be updated | false | false | |||
Proposed password | false | false | |||
Existing user in the erp to run the user validation | false | false | |||
Password for the existing erp user | false | false |
Updates the password of a user