Install-ClientSDK.ps1

« Return to Notes Listing

Author:Aaron
Last Updated:June 09, 2021 10:29 AM

The below is an overview of using the Install-ClientSDK.ps1 script:

  1. Open a powershell window as Administrator (ISE or console)
  2. Change directory M:\_tpi\scripts\Install-ClientSDK.ps1
    1. Use the -ReposKeepMasterRepo $false flag to create a local repo that will not be saved to M:
  3. Enter a Client id - enter an existing client id. If you enter a client id that exists on M:, this repo will be added to that directory. If there isn't a matching client id on M:, a new directory will be created.
  4. Enter a System id - enter a syste id. In most cases, leave this as Public.
  5. Select a Starter Pack if creating a Theme, Block, or Data Module package.
  6. Enter Y to connect to an existing database (if there is a dev server) or N to created a local db.
    1. Note: it is useful to set up a local database even if you are connecting to a dev server. Even with a local db, you can always change the connection string to dev.
  7. Review settings and select Y to install. Below is an example of the scritp and settings:
PS M:\_tpi\Scripts> .\Install-ClientSDK.ps1 -ReposKeepMasterRepo $false
Enter client ID (e.g. "NWS", "MCW", "MPS", etc.): NWS
Enter system ID (leave empty for "Public"): Test
Updating Base SDK Repo to v7
0 files updated, 0 files merged, 0 files removed, 0 files unresolved
Master repo will be created: \\northwoodsoft.com\src\NWS\Titan\Test\Current
Base repo will be used: \\northwoodsoft.com\src\_tpi\ClientSDK\Current
Master repo will not be kept: \\northwoodsoft.com\src\NWS\Titan\Test\Current
Local repo will be created: C:\Src\NWS\Titan\Test\Current

Available Starter Packs
[R]eFlex Theme
[B]lock
[D]ata Module
Enter starter pack letter ([Enter] for none):
Is there an existing database that you want to use for this SDK environment? For instance, an existing dev database [Y/N]: N
Enter database instance (e.g. sql-dev-1\titanclients, localhost\mssql2016, etc.) Enter for localhost\mssql2016:
Enter database name (Enter for NWS_Titan_Test):
Database name: NWS_Titan_Test
Database restricted username: NWS_Titan_TestUser
Database restricted password: abc123
Restricted connection string: Data Source=localhost\mssql2016;Database=NWS_Titan_Test;Persist Security Info=False;User ID=NWS_Titan_TestUser;Password=abc123;Encrypt=True;TrustServerCertificate=True
Database admin username: NWS_Titan_TestAdmin
Database admin password: abc123
Admin connection string: Data Source=localhost\mssql2016;Database=NWS_Titan_Test;Persist Security Info=False;User ID=NWS_Titan_TestAdmin;Password=abc123;Encrypt=True;TrustServerCertificate=True
Database system admin username (for localhost\mssql2016. Leave empty for current user):
Master connection string: Data Source=localhost\mssql2016;Database=master;Persist Security Info=False;Encrypt=True;TrustServerCertificate=True;Integrated Security=SSPI
TPI username: TpiAdmin
TPI password: abc123
TPI Version: 1.1.1.0
Bootstrapper Version: 1.1.1.0
SDK Config File: \\northwoodsoft.com\src\_tpi\ClientSDK\Current\Deployment\SDK.config.json
Package will be installed: NWS.Titan.Base@7.1.2.0 from \\northwoodsoft.com\src\_tpi\Packages\NWS.Titan.Base\NWS.Titan.Base_7.1.2.0.zip
Ready to install
Install? [Y/N]:
top