Cora Knowledge Center

Support

PowerShell Function: Install-CoraSeQuenceApplication

V9.0

Module

CoraSeQuence

Description

Deploys a Cora SeQuence deployment package. 

It has one mandatory parameter: SourcePath, the full path to the deployment package.

This function:

  • Validates that the operating system is supported.
  • Verifies that all prerequisites are installed.
    • If any role and/or feature is missing, it installs it.
    • If the software prerequisites are not installed, it attempts to download and silently install them—requires network connection.
  • Installs the application.

Syntax

Install-CoraSeQuenceApplication -SourcePath <String> -ServiceAccount <PSCredential> [-DestinationPath <String>] [-ApplicationID <Int32>] [-SkipPreInstallScript] [-SkipPostInstallScript] [-SkipPrerequisites] [-Credentials <PSCredential>] 
[<CommonParameters>]   
Install-CoraSeQuenceApplication -SourcePath <String> [-DestinationPath <String>] [-ApplicationID <Int32>] [-SkipPreInstallScript] [-SkipPostInstallScript] [-SkipPrerequisites] [-Credentials <PSCredential>] [<CommonParameters>]

Parameters

-SourcePath <String>

Mandatory parameter. The full path to the deployment package. Can be local, network location or web location.

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

-ServiceAccount <PSCredential>

Credentials to be used as the service account (Service identity for Windows Services or Application Pool identity for sites).

Required if you use custom service accounts.

Accepts credentials in PSCredential format.

Used for credentials for the service accounts:

  • For Windows services: it will be the identity running the Windows service
  • For site: it will be the identity of the application pool.
Required?  false
Position?                    named
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-DestinationPath <String>

The path where the application files are installed.

  • If not provided, the Cora SeQuence default location is used:
    • Services: C:\Program Files\Genpact Digital\Cora SeQuence\[ServiceName] 
    • Sites: C:\inetpub\wwwroot\Cora SeQuence\[Site]).
  • If provided, but the application already exists, such as in upgrade scenarios, the parameter is ignored and the current application location is used.
Required?  false
Position?                    named
Default value          
Accept pipeline input?      false
Accept wildcard characters?  false

-ApplicationID <Int32>

Valid for services only. The numeric ID of the service instance.
Relevant for services only.
This parameter is required only if you need to install more than one instance of the same service on the same server.
It defines which service will be deployed. You can deploy several instances of a service on the same server.
For example, if the server is strong enough and your system has high volume, you can deploy several BRS instances on the same server.
To deploy an additional service, set the value accordingly: 2, 3, and so on.

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

-SkipPreInstallScript [<SwitchParameter>]

Skips execution of the PreInstall script.

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

-SkipPostInstallScript [<SwitchParameter>]

Skips execution of the PostInstall script.

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

-SkipPrerequisites [<SwitchParameter>]

Skips roles/features and software prerequisites check. 

NOTE
If this is not the first time that you are deploying the application, you can use this parameter to speed up the deployment process.

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

-Credentials <PSCredential>

Credentials to be used to access SourcePath, if needed.

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

<CommonParameters> 

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

For more information, see about_CommonParameters.  

Outputs

Returns a hash table with the following keys. 

KeyDescriptionReturned value
ApplicationTypeDisplays the type of the application that was deployed.Depending on the application the returned value can be:
  • Administration
  • Flowtime
  • BRS
  • JES
  • ADSS
RestartRequiredDetermines if a restart is required after the deployment of the application.True or False
ApplicationKindIdentifies the kind of application that was deployed.Site or Service
ApplicationObject that contains either the site or the service that was deployed.Site: Microsoft.IIS. PowerShell.Framework.ConfigurationElement
Service: Win32_Service
GUIDDisplays the GUID of the application that was deployed.If a service was installed, it returns the GUID of the service.
Sites do not have GUIDs.

Examples

 PS C:\>Install-CoraSeQuenceApplication -SourcePath "C:\Flowtime.zip"