Page History
This section provides information on how to configure the WhereScape CICD Enablement Pack on both Developer and Deployment Machines.
...
The following technologies should be in place before following the configuration setup for all Development and Deployment machines:
Software
...
- WhereScape 3D, 9.0.56.40+
- Instructions on installation can be found at the following link: WhereScape 3D Installation Instructions.
- Includes the WhereScape MetaServer (wsmetaserver) which installs a local PostgreSQL database server used to store metadata.
- This PostgreSQL server is typically installed automatically during the WhereScape 3D setup process.
- Alternatively, users can connect to an existing PostgreSQL server if preferred.
| Note |
|---|
WhereScape 3D must be on the default install location |
- WhereScape RED, 10.45.0.1+2
- Requires a PostgreSQL database to store metadata.
- This can be hosted on the same MetaServer (wsmetaserver) installed with WhereScape 3D or on a separate PostgreSQL server, depending on your environment setup
| Note |
|---|
WhereScape RED must be on the default install location |
- GIT
- Repository – this must be created separately. Instructions to do this can be found in the GitHub Documentation here: Creating a GitHub Repository.
- Supported GIT Platforms:
- GitHub
- GitHub Enterprise
- Azure DevOps
- GIT Tools
- GIT CMD: can be installed here: GIT CMD Install
...
Ensure that the system-wide PATH environment variable includes the path to the GIT CMD executable (e.g. "C:\Program Files\Git\cmd"):
Make sure the following user-level PATH entries exist:
- %USERPROFILE%\AppData\Local\Programs\Python\Python311\
- %USERPROFILE%\AppData\Local\Programs\Python\Python311\Scripts\
- C:\Program Files\Git\cmd\
- C:\Program Files\Git\bin\
You may need to add Proxy authentication, to enable access to the API for Personal Access token authentication:
...
Port: User-specified
Database: wsred A database must already exist and be named like wsred_[Name of GIT repository][_$ENVIRONMENT$]_$DEVELOPER$ $DEVELOPER$, for example: wsred_cicdrepo_d_username
Username: User-specified
...
| Note | ||
|---|---|---|
| ||
If this folder is used, please ensure that the user profiles have read/write permissions. Failure to do this will prevent the workflow tasks from working correctly. |
WhereScape
...
3D, RED & GIT Naming Convention
When you create a repository in WhereScape 3D or RED, its name is automatically linked to the name of your GIT repository.
...
Don’t create new repositories in WhereScape 3D that point to existing ones already set up for CI/CD.
Firewall Rules and Proxy Configuration
- Your Git Repository. This can include dev.azure.com, github.com
- GitHub API: api.github.com
- For Git Enterprise users: https://[url]/api/v3/user/repos
| Note | ||
|---|---|---|
| ||
Please note, that some organisations using proxy servers, may need to run the following git command:
|
WhereScape 3D and RED Backup Files
When using the WhereScape GIT Enablement Pack, users can use a backup on the initial build of their WhereScape GIT repository. For WhereScape RED, this is mandatory.
These backup files must be in either SQL or BAK file format, and the PostgreSQL version used for the backup must match the version of the target repository.
Backups generated in WhereScape 3D or WhereScape RED are not supported by the WhereScape GIT Enablement Pack. Instead, backups must be created using PostgreSQL.
| Warning | ||
|---|---|---|
| ||
| The process of creating a backup using PostgreSQL may vary depending on the version of PostgreSQL you are using. For help on doing this, please consult the PostgreSQL help documentation. |
An example of setting up the backup using PostgreSQL 16 in pgAdmin can be found below:
As a prerequisite for creating a backup in pgAdmin using PostgreSQL 16, users must update their PostgreSQL Binary Path Preferences on their selected PosgreSQL version to the following: C:\Program Files\PostgreSQL\<PostgreSQL version number>\bin. This can be done using pgadmin as follows: 
To use your backup file, all files held in C:\Program Files\PostgreSQL\16\bin must be copied into the relevant WhereScape folder: Program Files\WhereScape\RED\tools for WhereScape RED, or Program Files\WhereScape\RED\tools for WhereScape 3D.
Next:
Getting Started with WhereScape CICD Enablement Pack
...