Versions Compared

Key

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

...

  • Create java class that extends flexagon.fd.model.integration.cms.api.ChangeManagementSystem. Example shown below has the methods implemented which uses properties map to retrieve the configuration values to connect to the change management system.

  • All properties defined are available in Map returned by getProperties method.

  • We are using Zendesk as a use case.

  • View file
    nameZendeskServiceIntegration.java

  • In order to compile your java class, you will need FlexDeployAPI.jar on classpath.

  • Implement all the methods described in the table in the API Implementation section.

  • For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");

  • Once you are ready with unit testing, you can prepare Jar file for your credential store java class and other utility classes. This jar file can be placed on server classpath now.

    • For Tomcat, put this jar file in apache-tomcat-flexdeploy/libext folder.

    • If you are using any third-party libraries from your Java implementation, then those jar files will also need to be added to same libext folder. Keep in mind that this can cause issues with server functioning, so be prepared to remove your additional library files.

  • To pickup changes to your API, the FlexDeploy server must be restarted.

...

  • Create a groovy class. Example shown below has the methods implemented.

  • We are using Zendesk as a use case

  • All properties defined are available as groovy binding variables. For example, properties can be accessed directly like BMC_DOMAIN_NAME, BMC_SALESFORCE_HOST_NAME or BMC_USER_NAME etc

  • View file
    nameZendeskGroovyIntegration.groovy

  • Implement all the methods described in the table in the API Implementation section

  • For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");

...