Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Deletes the currently selected model.
  2. Verifies connection to GIT Repository.
  3. Brings in the latest changes from the remote repository so your local setup is up to date.
  4. Saves the current version of your local repository.
  5. Commits the change to the remote GIT repository.
Note
titleImportant

A log file will be created and stored within the specified directory each time this workflow is executed. If there are any issues during this operation, the log file will be presented to the user for review.

Only create a “Delete Model and Commit” button within a workflow for use at the Model Version level.

Create Branch

Users will click the workflow button to create a new branch, which executes the ed3d_create_feature_branch template.

This workflow is used for the following reasons:

  1. Preparing a copy of an existing branch for a new purpose/development task/developer.

This workflow will perform the following tasks:

  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 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.
Note
titleImportant

 A log file will be created and stored within the specified directory each time this workflow is executed. If there are any issues during this operation, the log file will be presented to the user for review. 

It is recommended that a “Create Feature Branch” button be created within a workflow for use at the Category level. 

Close Branch 

Users will click the workflow button to close a branch, which executes the ed3d_close_branch template. 

This workflow is used for the following reasons: 

  1. Close and discard the branch without merging changes into another branch. 
  2. Merge the current branch into another branch (e.g. feature branch to be merged into development). 

This workflow will perform the following tasks:

  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 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. 
Note
titleImportant

A log file will be created and stored within the specified directory each time this workflow is executed. If there are any issues during this operation, the log file will be presented to the user for review.

Info

It is recommended that a “Close Branch” button be created within a workflow for use at the Category level. 

Switch Branch 

Users will click the workflow button to switch branch, which executes the ed3d_switch_branch template. 

Warning
titleWarning

Ensure that all changes are committed before switching branches, as all uncommitted changes will be discarded as part of this workflow.

This workflow is used for the following reasons:

  1. To review the code/data model of the alternative branch.
  2. Start development on a different branch.

This workflow will perform the following tasks:

  1. Verifies connection to GIT Repository.
  2. The user is prompted to select the branch to switch to.
    Image 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.

Pull from GIT

Users will click the workflow button to fetch changes from the remote GIT repository to their current local branch, which executes the ed3d_pull template.

Warning
titleWarning

Ensure that all changes are committed before making a pull request, as all uncommitted changes will be discarded as part of this workflow.

This workflow is used for the following reasons:

  1. Refresh the Developer machines WhereScape repositories with the current (commit) metadata on the remote GIT repository.
  2. Refresh and rebase the Developer machines WhereScape repositories, discarding any uncommitted changes.

This workflow will perform the following tasks:

  1. Verifies connection to GIT Repository.
  2. The “Branch” stored within the WhereScape Repository is the selected branch from which to pull.
  3. Refresh the local GIT repository with updates from the corresponding remote GIT repository.
  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.
Note
titleImportant

A log file will be created and stored within the specified directory each time this workflow is executed. If there are any issues during this operation, the log file will be presented to the user for review.

Info

It is recommended that a “Pull from GIT” button be created within a workflow for use at the Category level.

Warning
titleWarning

If WhereScape RED is open while the Pull action is in progress, the RED application may lose connection to the PostgreSQL Database Repository or may become out of sync with the metadata. You may need to refresh the Repository window within RED, to synchronize the application with the metadata.


Export to RED
To export a RED export model WhereScape RED, users will click the workflow button, which executes the ed3d_git_to_red templates.

This workflow is used for the following reasons:

  1. Deploy a new Data Model into the WhereScape RED repository.
  2. Deploy changes to an existing Data Model into the WhereScape RED repository.

This workflow will perform the following tasks:

  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. Commits the change to the remote GIT repository.
  5. You will be prompted to add a commit message:
  6. You will be prompted to update connections:
    1. You are able to select the connection and then input the username and password. When you click on apply, the command line will write the credentials to the RED metadata repository.
    2. This step will only update the credentials within the RED metadata repository. Any credentials within the RED profile file, will override the credentials in the metadata repository.
      Image Added
  7. Once you have updated the connections, click Next to continue the deployment.
  8. Deployment of the model to RED completes.
Note
titleImportant

A log file will be created and stored within the specified directory each time this workflow is executed. If there are any issues during this operation, the log file will be presented to the user for review.

Note
titleImportant

Users can create/change the workflow configuration for any category, model, or model version; however, this function requires the user to select the model version, specifically within the RED export category, to operate correctly.

Note

Only create a “RED export” button within a workflow for use at the Model Version level.

Import Model

Users will click the workflow button to import a Data Model from a selected commit ID from a branch. This workflow button executes the ed3d_import_model_from_git template.

This workflow is used for the following reasons:

  1. Import merge conflicts from a different branch.
  2. Import a historical version of a data model into the existing branch.

This workflow will perform the following tasks:

  1. Verifies connection to GIT Repository.
  2. A window opens prompting the user for the following information:
    1. Select a branch
    2. Select a commit reference you wish to import from.
      Please note: These commits are filtered only to show commits that include the selected data model version.
    3. The user can review the commit changes they have selected in the text box.
    4. The user can overwrite the selected model version OR create a new version, using the commit ID as a prefix to the current model version name.
    5. Select 'OK'
      Image Added
  3. The local GIT repository is synchronized to the selected commit.

  4. A new model version is created, and the model is imported to your local repository.

  5. The user must refresh the Repository Browser to see the imported data model.

Note
titleImportant

A log file will be created and stored within the specified directory each time this workflow is executed. If there are any issues during this operation, the log file will be presented to the user for review.

Note

It is recommended that an “Import Model Version” button be created within a workflow for use at the model version level.