Contents

Popular
Contents

Fiorano provides integration with GIT where users can perform Push, Pull, and Checkout operations for Applications, Extended Services, Group Processes, API Projects, Named Configurations and Schemas to the version control repository.

Icon

Though Fiorano provides integration with GIT, other version control tools can also be used by creating customized java class with the method below to perform major operations like PULL, PUSH and CHECKOUT:

Variables:

Icon
  • username and password are the version control username and password. 
  • The URL string is the remote URL location to perform push, pull or checkout of the commits. 
  • repoPath is the local path to the runtimedata applications, group process or API projects from where the commits happen or pull/checkout takes place. This is the place where the hidden folder containing information and configuration about the version control (.svn, .git etc) is created. 
  • The boolean push
    • if set to true, it will push the commits to the remote repository.
    • If false, it will perform the pull operation.
  • The boolean checkout
    • if set to true, will checkout the contents from the URL to the repoPath. 
Icon

Whenever the boolean checkout is set to true, the checkout operation will be performed irrespective of the boolean push.

Checkout

Push

Result

F

F

Pull

F

T

Push

T

F

Checkout

T

T

Checkout

Version Control Integration for Event Processes

In eStudio

After starting the server, open eStudio, login to the Enterprise Server and perform the following actions:

  1. Expand the EnterpriseServer node and right-click the Event Process Repository node.
  2. In the Version Control option, click Configuration.



  3. In the Version Control panel, provide the version control details.

    Icon

    Since Fiorano provides GIT integration, Class Name will be fiorano.esb.util.GitUtil by default. But a customized Class Name may be used to integrate with a preferred version control tool different than the default one.



  4. Click Finish to save the version control configuration details. After the details are saved, any operation can be performed. 
  5. Select the Commit option to push the Event Processes to the remote repository (Event Process Repository > Version Control).
    Provide the commit message in the Commit Applications popup.



  6. Similarly, to perform the Checkout operation, select the Checkout option (Event Process Repository > Version Control > Checkout ). 

  7. A warning pops up prompting to overwrite event processes.

    Icon

    Checking out from the version control leads to the loss of all Event Processes that are created locally. Click No to take a backup and click Yes after ensuring that the backup has been taken.



  8. For pulling the Event Processes from the remote repository, select the Update option.
    A warning will popup prompting to backup the Event Processes.



  9. Click Yes to sync the local repository with the remote.

  10. Select Clone to clone the applications directory from remote repository.

    Icon

    If applications directory is already present while attempting to clone, it will create a new directory called applications_cloned.

    If applications_cloned already exits while attempting to clone, then the previous applications_cloned will be overwritten with the same content currently present in the remote repository.

  11. To list all the files pushed from the applications directory to remote repository during a particular commit, use the Revision Log option. 

  12. Provide the revision number which gets printed on the server console after every successful push.

  13. To compare the files modified, added and deleted between any two commits in the applications directory, select the Compare option.

  14. Provide the old and the new revision numbers and select OK.

Using REST APIs or cURLs

  1. Start the Enterprise Server.

  2. Open a web browser and provide the URL as:

    Icon

    http://<IP address of enterprise server>:1980/swaggerui

    Example:
  3. Select the applications tab to see the REST APIs for version control.

Version Control Integration for Extended Service

In eStudio

After starting the server, open eStudio, login to the Enterprise Server and perform the following actions:

  1. Expand the EnterpriseServer node and right-click the Extended Service Repository node.
  2. In the Version Control option, click Configuration.



  3. In the Version Control panel, provide the version control details.

    Icon

    Since Fiorano provides GIT integration, Class Name will be fiorano.esb.util.GitUtil by default. But a customized Class Name may be used to integrate with a preferred version Control tool different from the default one.



  4. Click Finish to save the version control configuration details.
  5. After the details are saved, any operation can be performed. 
  6. Select the Commit option to push the Extended Services to the remote repository (Extended Service Repository > Version Control).
    Provide the commit message in the popup.


  7. Similarly, to perform the Checkout operation, select the Checkout option (Extended Service Repository > Version Control > Checkout). 

  8. A warning pops up prompting to overwrite extended services.

    Icon

    Checking out from the version control leads to loss of all extended services that are created locally. Click No to take a backup and click Yes after ensuring that the backup has been taken.



  9. For pulling the extended services from the remote repository, select the Update option.
  10. A warning pops up prompting to backup the Extended Services.



  11. Select Yes to sync the local repository with the remote.

  12. Select Clone to clone the extended service (groupprocess) directory from remote repository.

    Icon

    If groupprocess directory is already present while attempting to clone, it will create a new directory called groupprocess_cloned.

    If groupprocess_cloned already exits while attempting to clone, then the previous groupprocess_cloned will be overwritten with the same content currently present in the remote repository.

  13. To list all the files pushed from the extended service directory to remote repository during a particular commit, use the Revision Log option. 

  14. Provide the revision number which gets printed on the server console after every successful push.

  15. To compare the files modified, added and deleted between any two commits in the extended service directory, select the Compare option.

  16. Provide the old and the new revision numbers and select OK.

 

Using REST APIs or cURLs

  1. Start the Enterprise Server.

  2. Open a web browser and provide the URL as:

    Icon

    http://<IP address of enterprise server>:1980/swaggerui

    Example:
  3. Select the extendedService tab to see the REST APIs for version control.


Version Control Integration for Named Configurations

In eStudio

After starting the server, open eStudio, login to the Enterprise Server and perform the following actions:

  1. Switch to the Configurations tab located below the Server Explorer Window.
  2. Select the highlighted Version Control option dropdown and click Configuration.



  3. In the Version Control panel, provide the version control details.

    Icon

    Since Fiorano provides GIT integration, Class Name will be fiorano.esb.util.GitUtil by default. But a customized Class Name may be used to integrate with a preferred version Control tool different from the default one.



  4. Click Finish to save the version control configuration details.
  5. After the details are saved, any operation can be performed. 
  6. Select the Commit option to push the Named Configurations to the remote repository (highlighted version control dropdown as shown above).
    Provide the commit message in the popup.


  7. Similarly, to perform the Checkout operation, select the Checkout option. 

  8. A warning pops up prompting to overwrite named configurations.

    Icon

    Checking out from the version control leads to loss of all named configurations that are created locally. Click No to take a backup and click Yes after ensuring that the backup has been taken.



  9. For pulling the named configurations from the remote repository, select the Update option.
  10. A similar warning pops up prompting to backup the named configurations.
  11. Select Yes to sync the local repository with the remote.

  12. Select Clone to clone the named configurations (configurations) directory from remote repository.

    Icon

    If configurations directory is already present while attempting to clone, it will create a new directory called configurations_cloned.

    If configurations_cloned already exits while attempting to clone, then the previous configurations_cloned will automatically be overwritten with the same content currently present in the remote repository.

  13. To list all the files pushed from the extended service directory to remote repository during a particular commit, use the Revision Log option. 

  14. Provide the revision number which gets printed on the server console after every successful push.

  15. To compare the files modified, added and deleted between any two commits in the extended service directory, select the Compare option.

  16. Provide the old and the new revision numbers and select OK.

Using REST APIs or cURLs

  1. Start the Enterprise Server.

  2. Open a web browser and provide the URL as:

    Icon

    http://<IP address of enterprise server>:1980/swaggerui

    Example:
  3. Select the namedConfig tab to see the REST APIs for version control.

 

Version Control Integration for Schemas

In eStudio

After starting the server, open eStudio, login to the Enterprise Server, and perform the following actions:

  1. From the menu bar, go to Tools > Version Control > Configuration.



  2. In the Version Control panel, provide the version control details.

    Icon

    Since Fiorano provides GIT integration, Class Name will be fiorano.esb.util.GitUtil by default. But a customized Class Name may be used to integrate with a preferred version Control tool different from the default one.



  3. Click Finish to save the version control configuration details.
  4. After the details are saved, any operation can be performed. 
  5. Select the Commit option to push the Named Configurations to the remote repository (Tools > Version Control).).
    Provide the commit message in the popup.


  6. Similarly, to perform the Checkout operation, select the Checkout option. 

  7. A warning pops up prompting to overwrite the schemas.

    Icon

    Checking out from the version control leads to loss of all schemas that are created locally. Click No to take a backup and click Yes after ensuring that the backup has been taken.



  8. For pulling the schemas from the remote repository, select the Update option.
  9. A similar warning pops up prompting to backup the schemas.
  10. Select Yes to sync the local repository with the remote.

  11. Select Clone to clone the schemas directory from remote repository.

    Icon

    If schemas directory is already present while attempting to clone, it will create a new directory called schemas_cloned.

    If schemas_cloned already exist while attempting to clone, then the previous schemas_cloned will automatically be overwritten with the same content currently present in the remote repository.

  12. To list all the files pushed from the extended service directory to the remote repository during a particular commit, use the Revision Log option. 

  13. Provide the revision number which gets printed on the server console after every successful push.

  14. To compare the files modified, added, and deleted between any two commits in the extended service directory, select the Compare option.

  15. Provide the old and the new revision numbers and select OK.

Using REST APIs or cURLs

  1. Open a web browser and provide the URL as:

    Icon

    http://<IP address of enterprise server>:1980/swaggerui

    Example

  2. Select the schemas tab to see the REST APIs for version control.

Version Control Integration for API Projects

In API Management Dashboard

  1. After starting the API Management server, login to the API Management Dashboard.
  2. Click the username (admin) drop-down present at the upper-right part of the Dashboard and click Preferences.



  3. Click the Version control tab.




  4. Provide the version control details and click Save.

    Icon

    Since Fiorano provides GIT integration, Class Name will be fiorano.esb.util.GitUtil by default. But a customized Class Name may be used to integrate with a preferred version Control tool different from the default one.

  5. Once the git details are saved, any operation can be performed by navigating to the APIProjects tab and then selecting the Version Control icon as shown below:




  6. To push the files to the remote repository, select the Push option. This will prompt for a commit message for the entities to be pushed.

  7. Similarly, to perform the Checkout operation, select the Checkout option. 

  8. A warning pops up prompting to overwrite the schemas.

    Icon

    Checking out from the version control leads to loss of all schemas that are created locally. Click No to take a backup and click Yes after ensuring that the backup has been taken.

  9. For pulling the schemas from the remote repository, select the PULL option.
  10. A similar warning pops up prompting to backup the schemas.

  11. Select Yes to sync the local repository with the remote.

  12. Select Clone to clone the applications directory from remote repository.

    Icon

    If apiprojects directory is already present while attempting to clone, it will create a new directory called apiprojects_cloned.

    If apiprojects_cloned already exits while attempting to clone, then the previous apiprojects_cloned will automatically be overwritten with the same content currently present in the remote repository.

  13. To list all the files pushed from the API projects directory to remote repository during a particular commit, use the Revision Log option. 

  14. Provide the revision number which gets printed on the server console after every successful push.

  15. To compare the files modified, added and deleted between any two commits in the API projects directory, select the Compare option.

  16. Provide the old and the new revision numbers and select OK.

Using REST APIs or cURLs

  1. Start the Enterprise Server.

  2. Open a web browser and provide the URL as:

    Icon

    http://<IP address of enterprise server>:1981/swaggerui

    Example:
  3. Select the apiprojects tab to see the REST APIs for version control.

Viewing the logs

The logs can be viewed inside the jetty.log file present in <FioranoHome>/runtimedata/<serverType>/ <profile>/<mode>/run/logs.

Points to Note

  • Custom classes can be used to integrate a different version Control tool.
  • Ensure that a backup of the local repository is taken before checking out or pulling from the version control as these operations might lead to loss of any local change in Applications, Extended Services or API Projects repository.
  • While trying to sync the local repository with the remote one for the first time separately for Applications, Extended Services, and API Projects respectively, the user should select the Update option rather than Checkout. This Update is a git pull call that will first execute the git init method, create the head and point it to the correct location.
  • Once remote and local repo are synched, the Update option, which is git pull, will not perform any action until the remote repo gets modified again.
  • If any change is made to the local repository and the user wants to revert back to the previous change, the checkout operation needs to be performed.
  • If HA servers are used, a .git directory will get created on the active server. In order to sync this .git for the first time with the passive server, restart the passive server.
  • If Github is being used as the git repository then note that Github no longer accepts account passwords when authenticating Git operations on GitHub.com. Instead provide Personal Token in the password field. More about this can be found here
     

    Generate personal access-token on GitHub as follows:
    In the upper-right corner of any page, click your profile photo, then click Settings.
    In the left sidebar, click Developer settings.
    In the left sidebar, click Personal access token.

    : 
Adaptavist ThemeBuilder EngineAtlassian Confluence