Page History
...
- Add http_proxy: http://[ProxyAddress]:[Proxy Port]
- Add https_proxy: https://[ProxyAddress]:[Proxy Port]
Installing the WhereScape GIT Enablement Pack
- Locate the WhereScape GIT Enablement Pack MSI file.
- Double-click the .msi file to launch the installer.
- Follow the on-screen instructions to complete the installation.
- Once installed, a shortcut to the Enablement Pack should appear on your desktop:
- Shortcut name: WhereScape GIT Enablement Pack
- Location: %ProgramFiles%\WhereScape\GIT Enablement Pack
| Note | ||
|---|---|---|
| ||
If the shortcut is not created automatically, you can manually create one by navigating to the installation directory and right-clicking the executable. |
| Note | ||
|---|---|---|
| ||
You may need administrator rights to complete the installation. |
Developer Machine Configuration
This section describes how the workflow should be configured on the Development machine.
Machine Configuration
All developer machines must have the same configuration and installation steps in the Prerequisite section. These processes have been deployed and tested on the following Development machine types:
- Microsoft Virtual Machines
- Citrix Machines
- Desktop machines
WhereScape 3D and RED - Additional Installation Steps
Downloads for the latest versions of WhereScape 3D & RED, along with installation guides, can be found here: https://www1.wherescape.com/support/software-downloads-documentation/
WhereScape 3D and RED Repository (PostgresSQL)
With WhereScape 3D and RED, the metadata is stored in a repository within a PostgreSQL database. The installation process will check and update the PostgreSQL database structure, ensuring that the structure matches the software update requirements.
| Note | ||
|---|---|---|
| ||
If there are any updates to WhereScape 3D or RED in the future, please follow the installation instructions. Update the software to ALL Developer Machines and the shared repository outside of business hours to remove the risk of corrupting the repository. Always back up the repository before you start the software update. |
WhereScape RED Only
Ensure that the Azkaban service has been installed and started. This can be found in the services of the Virtual Machine.
WhereScape RED Repository Connection Details
Server: User-specified
Port: User-specified
Database: wsred_[Name of GIT repository][_$ENVIRONMENT$]_$DEVELOPER$
Username: User-specified
Password: User-specified
| Note | ||
|---|---|---|
| ||
It is a prerequisite of the GIT Enablement Pack that the user has already set up an ODBC connection for both source and target databases. The naming conventions for the ODBCs need to be consistent across all users. Please note, if the user would like to explore the local PostgreSQL server, they will need to connect pgAdmin UI to the local wsMetaServer (WhereScape’s PostgreSQL server installed as part of WhereScape 3d). Use the Server details above to achieve this. |
GIT Repository Settings
Each end user will require access to the shared GIT repository. The end user’s credentials are used when pushing commits (during the WhereScape 3D & RED workflows).
Repository Name: User-supplied
Repository local path: %USERPROFILE%\Git\[Name of Repo]
| Note | ||
|---|---|---|
| ||
The location of the local GIT repository can be changed within the User Config file. The workflow is designed to push individual files to the repository. However, if there are any errors when pushing to Git, please use a GIT GUI to manage conflicts. |
Deployment Machine Configuration
This section describes how to setup a deployment machine that can be used to create a CICD workflow to publish changes into a selected target database.
This enablement pack will trigger the WST deployment process via the command line. For further information on this, please refer to the WhereScape RED help guide.
Machine Configuration
All deployment machines must have the same configuration and installation steps in the prerequisites section.
Configure Target Environment Runners
To deploy the application to target environments, the below link provides instructions to configure a self-hosted runner as a service.
For more information consult the documentation here: GitHub - Hosting your Own Runners