The EcoSys FMServerSetting.properties template file, has the following server settings included with the default values:
docs.baseUrl=https://docs.hexagonppm.com/
docs.suffix.gateway=search/all?query=Gateway&filters=PPMProduct~%2522EcoSys%2522
docs.suffix.api=search/all?query=API+Usage&filters=PPMProduct~%2522EcoSys%2522
The Gateway and API links are built using the logic docs.baseUrl + doc.suffix.*. This provides flexibility in configuring URLs. They can be built with :
-
a base + suffix (like above)
-
an empty base with specific suffixes per topic
-
a base only with empty suffixes
Setting these properties in the FMServerSetting.properties file will generate a link to the documentation at the top right hand side of the Published Web Service API page
-
docs.suffix.gateway – Provides a Gateway link
-
docs.suffix.api – Provides an API Usage Documentation link
If the computed URL is empty, the links will not render.