Genpact Cora Knowledge Center

Support

PowerShell Function: Install-CoraSeQuenceDatabase

V9.5

Module

CoraSeQuence.Database

Description

Deploys a Cora SeQuence database package.

NOTE
Run this function to deploy Cora SeQuence databases only.

Syntax    

Install-CoraSeQuenceDatabase [-DatabasePackagePath] <String> [-SQLServer] <String> [-Database] <String> [[-SQLCredentials] <PSCredential>] [[-Credentials] <PSCredential>] [-CRMConnector] [-HotOperations] [-ElasticSearch] [-InstallType] <String> 
    [-Diagnostics] [[-Parameters] <Hashtable>] [[-Properties] <Hashtable>] [<CommonParameters>]

Parameters

-DatabasePackagePath <String>

The path to the database package. 

Required?                    true
Position?                    1
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

 -SQLServer <String>

The name of the SQL server used for hosting the Cora SeQuence database.
SQL server setup should follow Microsoft SQL standards, and include instance name and port.

Required?                    true
Position?                    2
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Database <String>

Determines the name of the deployed database.

Required?                    true
Position?                    3
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-SQLCredentials <PSCredential>

The credentials to be used to connect to the SQL server, if needed. If not provided, the current user credentials are used with Windows Authentication.

Required?                    false
Position?                    4
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Credentials <PSCredential>

The credentials to be used to access DatabasePackagePath, if needed.

Required?                    false
Position?                    5
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-CRMConnector [<SwitchParameter>]

Installs or upgrades the CRMConnector database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-HotOperations [<SwitchParameter>]

Installs or upgrades the HotOperations database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-ElasticSearch [<SwitchParameter>]

Installs or upgrades the ElasticSearch database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-InstallType [<String>]

Determines if this is an upgrade or installation of a new database. Value can be either NewDatabase or Upgrade.

  • NewDatabase: Drops the existing database and creates a new Cora SeQuence database.
  • Upgrade: Upgrades the existing database.

NOTE
You can only upgrade from V9.x databases.

Required?                    true
Position?                    6
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Diagnostics [<SwitchParameter>]

Enables diagnostics for the database deployment. After deployment, a log file is created in the same location of the deployment files, under a temporary folder. 

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-Parameters <Hashtable>

Adds additional parameters to the sqlpackage as specified here

Required?                    false
Position?                    7
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Properties <Hashtable>

Adds additional properties to the sqlpackage as specified here

Required?                    false
Position?                    8
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

<CommonParameters>

This function supports these common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. 

For more information, see about_CommonParameters

Examples 

Without credentials: 

PS C:\>Install-CoraSeQuenceDatabase -DatabasePackagePath "C:\PNMsoft.Sequence.SqlDatabase_9.2.0.0.dacpac" -SQLServer "MySQLServer" -Database "CoraSeQuence" -InstallType NewDatabase

With credentials:

PS C:\>Install-CoraSeQuenceDatabase -DatabasePackagePath "C:\PNMsoft.Sequence.SqlDatabase_9.2.0.0.dacpac" -SQLServer "MySQLServer" -Database "CoraSeQuence" -SQLCredentials (Get-Credential) -HotOperations -InstallType NewDatabase


V9.4

Module

CoraSeQuence.Database

Description

Deploys a Cora SeQuence database package.

NOTE
Run this function to deploy Cora SeQuence databases only.

Syntax    

Install-CoraSeQuenceDatabase [-DatabasePackagePath] <String> [-SQLServer] <String> [-Database] <String> [[-SQLCredentials] <PSCredential>] [[-Credentials] <PSCredential>] [-CRMConnector] [-HotOperations] [-ElasticSearch] [-InstallType] <String> 
    [-Diagnostics] [<CommonParameters>]

Parameters

-DatabasePackagePath <String>

The path to the database package. 

Required?                    true
Position?                    1
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

 -SQLServer <String>

The name of the SQL server used for hosting the Cora SeQuence database.
SQL server setup should follow Microsoft SQL standards.

Required?                    true
Position?                    2
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Database <String>

Determines the name of the deployed database.

Required?                    true
Position?                    3
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-SQLCredentials <PSCredential>

The credentials to be used to connect to the SQL server, if needed. If not provided, the current user is used with Windows Authentication.

Required?                    false
Position?                    4
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Credentials <PSCredential>

The credentials to be used to access DatabasePackagePath, if needed.

Required?                    false
Position?                    5
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-CRMConnector [<SwitchParameter>]

Installs or upgrades the CRMConnector database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-HotOperations [<SwitchParameter>]

Installs or upgrades the Hot Operations database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-ElasticSearch [<SwitchParameter>]

Installs or upgrades the ElasticSearch database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-InstallType [<SwitchParameter>]

Determines if this is an upgrade or a new database. Value can be either NewDatabase or Upgrade.

  • NewDatabase: Drops the existing database and creates a new Cora SeQuence database.
  • Upgrade: Upgrades the existing database.

NOTE
You can only upgrade from V9.x databases.

Required?                    true
Position?                    6
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Diagnostics [<SwitchParameter>]

Enables diagnostics for the database deployment. After deployment, a log file is created in the same location of the deployment files, under a temporary folder. 

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false


<CommonParameters>

This function supports these common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. 

For more information, see about_CommonParameters

Examples 

Without credentials: 

PS C:\>Install-CoraSeQuenceDatabase -DatabasePackagePath "C:\PNMsoft.Sequence.SqlDatabase_9.2.0.0.dacpac" -SQLServer "MySQLServer" -Database "CoraSeQuence" -InstallType NewDatabase

With credentials:

PS C:\>Install-CoraSeQuenceDatabase -DatabasePackagePath "C:\PNMsoft.Sequence.SqlDatabase_9.2.0.0.dacpac" -SQLServer "MySQLServer" -Database "CoraSeQuence" -SQLCredentials (Get-Credential) -HotOperations -InstallType NewDatabase


V9.2

Module

CoraSeQuence.Database

Description

Deploys a Cora SeQuence database package.

NOTE
Run this function to deploy Cora SeQuence databases only.

Syntax    

Install-CoraSeQuenceDatabase [-DatabasePackagePath] <String> [-SQLServer] <String> [-Database] <String> [[-SQLCredentials] <PSCredential>] [[-Credentials] <PSCredential>] [-CRMConnector] [-HotOperations] [-InstallType] <String> [-Diagnostics]  [<CommonParameters>]

Parameters

-DatabasePackagePath <String>

The path to the database package. 

Required?                    true
Position?                    1
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

 -SQLServer <String>

The name of the SQL server used for hosting the Cora SeQuence database.
SQL server setup should follow Microsoft SQL standards.

Required?                    true
Position?                    2
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Database <String>

Determines the name of the deployed database.

Required?                    true
Position?                    3
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-SQLCredentials <PSCredential>

The credentials to be used to connect to the SQL server, if needed. If not provided, the current user is used with Windows Authentication.

Required?                    false
Position?                    4
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Credentials <PSCredential>

The credentials to be used to access DatabasePackagePath, if needed.

Required?                    false
Position?                    5
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-CRMConnector [<SwitchParameter>]

Installs or upgrades the CRMConnector database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-HotOperations [<SwitchParameter>]

Installs or upgrades the Hot Operations database components.

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false

-InstallType [<SwitchParameter>]

Determines if this is an upgrade or a new database. Value can be either NewDatabase or Upgrade.

  • NewDatabase: Drops the existing database and creates a new Cora SeQuence database.
  • Upgrade: Upgrades the existing database.

NOTE
You can only upgrade from V9.x databases.

Required?                    true
Position?                    6
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-Diagnostics [<SwitchParameter>]

Enables diagnostics for the database deployment. After deployment, a log file is created in the same location of the deployment files, under a temporary folder. 

Required?                    false
Position?                    named
Default value          False
Accept pipeline input?      false
Accept wildcard characters?  false


<CommonParameters>

This function supports these common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. 

For more information, see about_CommonParameters

Examples 

Without credentials: 

PS C:\>Install-CoraSeQuenceDatabase -DatabasePackagePath "C:\PNMsoft.Sequence.SqlDatabase_9.2.0.0.dacpac" -SQLServer "MySQLServer" -Database "CoraSeQuence" -InstallType NewDatabase

With credentials:

 PS C:\>Install-CoraSeQuenceDatabase -DatabasePackagePath "C:\PNMsoft.Sequence.SqlDatabase_9.2.0.0.dacpac" -SQLServer "MySQLServer" -Database "CoraSeQuence" -SQLCredentials (Get-Credential) -HotOperations -InstallType NewDatabase