Page History

...

• Select the repository types: Select the product(s) you want to utilize from the check buttons, choosing RED, 3D or both. 
• Environment Type: Developer Machine or Deployment Machine to be selected from the dropdown menu 
• Environment Tag: One letter can be entered here to provide a description for what the environment is used for, For example ‘d’ for development, or ‘t’ for testing. This will be included in the Repository name. 
• On Pull Action: Drop Schema or Drop Database to be selected from the dropdown menu. 
• GIT URL 
• GIT Organization: The organization name used within GIT. 
• GIT Repository: The GIT Repository name to connect to. 
• Username: The user's Username to be used on the build.  
• Personal Access Token: The user's Personal Access Token. 
• Local GIT Repository: The location of the GIT repository created locally on the machine/virtual machine will be displayed (read-only). 
• Is this an initial Build? Select if this process starts an Initial Build. 
• RED Repository Server and Port: Add the RED PostgreSQL Server and port. 
• RED Repository Database Name: The repository database name will be calculated based on the information provided – this is read-only. This can have a max character length of 63 characters. If you would like to change the way this is configured, please consult section 'Changing the Repository Database Name'. 
• RED Repository Username and Password: Add the RED Username and Password. 
• RED Generate Files: Use the check buttons to select whether you would like to generate DDL, DML and/or JSON files. 
• RED Repository Backup: If Initial Build is set to ‘Yes’ the user will have the opportunity to select a backup file to use as a copy for their repository. 
  

  Note
  title Important
  The backup files will need to be in SQL, BAK or a Repository files format.  These files must be created using pg_dump, and the PostgreSQL version used for the backup must match the version of the target repository.

• 3D Repository Server: Add the 3D PostgreSQL Server and port.

• 3D Repository Database Name: The repository database name will be calculated based on the information provided – this is read-only. This can have a max character length of 63 characters. If you would like to change the way this is configured, please consult section 'Changing the Repository Database Name'.

• 3D Repository Username and Password: Add the 3D Username and Password.

• If Initial Build is set to ‘Yes’ the user will have the opportunity to select a backup file to use as a copy for your repository. 
  

  Note
  title Important
  The backup files will need to be in SQL, BAK or a Repository files format.   These files must be created using pg_dump, and the PostgreSQL version used for the backup must match the version of the target repository.

   

• Once the form is created click on 'OK'. If there are any issues with connecting to the GIT repository, the user will receive an error message.

• The local GIT directory will now be created.

• The user credentials for WhereScape RED and 3D repositories are created:
  • These are stored locally at this location: `%USERPROFILE%\WhereScape\GIT`. 
  • This file stores the user's credentials and configuration details which are required for the workflows to run correctly. 
    

    Note
    title Important
    Each GIT Repository will have its own profile file. If it is deleted or modified incorrectly, the workflows will stop working.

• The user will be prompted to select a branch from the remote GIT repository.
  Image Removed
   Image Added

• This action refreshes the local GIT repository with updates from the specified remote branch.

• WhereScape 3D and/or RED is rebuilt using the files within the local GIT repository. 

...

1. Verifies connection to GIT Repository.
2. Brings in the latest changes from the remote repository so your local setup is up to date.
3. Saves the current version of your local repository.
4. The user will be prompted to add their own commit message:
   Image RemovedImage Added 
   • If the user would like to link their commit to a backlog item or bug in GIT, they can use development tags in their commit message. Simply add a '#' followed by the backlog item ID. For example: '#123', will automatically associate the commit with the corresponding work item in your backlog.
5. Commits your changes to the remote GIT repository with your message.

...

1. Verifies connection to GIT Repository.
2. Brings in the latest changes from the remote repository so your local setup is up to date.
3. Saves the current version of your local repository.
4. The user will be prompted to add their own commit message:
   Image RemovedImage Added
   • If the user would like to link their commit to a backlog item or bug in GIT, they can use development tags in their commit message. Simply add a '#' followed by the backlog item ID. For example: '#123', will automatically associate the commit with the corresponding work item in your backlog.
     
     
5. Commits all your changes to the remote GIT repository with your message.

...

1. Verifies connection to GIT Repository.
2. Brings in the latest changes from the remote repository so your local setup is up to date.
3. The user will be prompted with a window and asked to provide the following information:
   1. The branch they wish to clone.
   2. The name the new branch.
   3. Click 'Create'
      Image RemovedImage Added
4. WhereScape 3D is closed.
5. The selected branch will be cloned on the remote GIT repository.
6. The new branch will be pulled onto the local\virtual machine.
7. WhereScape 3D is rebuilt using the files within the local GIT repository.
8. WhereScape RED (if using) is rebuilt using the files within the local GIT repository.
9. WhereScape 3D is reopened.

...

1. Verifies connection to GIT Repository. 
2. The user is prompted to select the branch to close. The user can close a branch and discard all changes or close and merge the branch into another branch. The user will choose a branch to switch or merge to. 
   Image RemovedImage Added
3. If the user selects to close and merge, then a GIT merge action will take place between the selected branches. If there are any issues with this merge, the user will be prompted with the files creating issues. 
4. The local GIT repository is refreshed from the selected branch on the remote GIT repository. 
5. WhereScape 3D is rebuilt using the files within the local GIT repository. 
6. WhereScape RED (if using) is rebuilt using the files within the local GIT repository. 
7. WhereScape 3D is reopened. 

...

1. Verifies connection to GIT Repository.
2. The user is prompted to select the branch to switch to.
   Image RemovedImage Added
3. Refreshes the local GIT repository from the remote GIT repository of the selected branch.
4. WhereScape 3D is rebuilt using the files within the local GIT repository.
5. WhereScape RED is rebuilt using the files within the local GIT repository.
6. WhereScape 3D is reopened.

...

To do this the user can right-click the 'All Objects' folder, and selecting 'Commit_All_to_GIT' from the workflows.

Image RemovedImage Added

This workflow is used for the following reasons:

...

1. Verifies connection to GIT Repository.
2. Brings in the latest changes from the remote repository so your local setup is up to date.
3. Reviews recent changes made within the WhereScape RED repository.
4. Extracts the current configuration & stores them within the local GIT repository folder.
5. Adjusts files to make them reusable for different developers.
6. Creates a full backup of the repository (excluding the connection details).
7. Necessary files are zipped whilst temporary files are removed.
8. The user will be prompted to add their own commit message:
   Image RemovedImage Added
   
   1. If the user would like to link their commit to a backlog item or bug in GIT, they can use development tags in their commit message. Simply add a '#' followed by the backlog item ID. For example: '#123', will automatically associate the commit with the corresponding work item in your backlog.
9. Commits the changes to the remote GIT repository.

...