This is an old revision of the document!
HPE / Microfocus Octane AddOn Configuration
Octane Addon communicates with Octane - Micro Focus/HPE using REST API. Configuration settings are defined in config.properties file located in /www/config/ folder.
You may use any text editor to add/update settings.
Minimum Configuration
First pick a unique name for your Octane system, e.g. MYOCTANE, The name must be in uppercase.
Copy and paste following settings into config.properties and adjust the values to yours:
ADDON.MYOCTANE.AUTH.PASSWORD=password/access token ADDON.MYOCTANE.AUTH.USERNAME=userid ADDON.MYOCTANE.BUG.ENABLED=true ADDON.MYOCTANE.CLASS=com.webmbt.alm.addon.AddOnOctane ADDON.MYOCTANE.REQ.ENABLED=true ADDON.MYOCTANE.URL=https://myco.saas.hpe.com
You may supply following to replace USERNAME/PASSSWORD to login with client id/secrete:
- ADDON.MYOCTANE.AUTH.CLIENT_ID=clientId
- ADDON.MYOCTANE.AUTH.CLIENT_SECRET=clientSecret
Enable Octane AddOn for Models
Each model that needs to access Octane for requirement or defects must also be configured:
- Enable ALM Plugin in the model using Model Property.
- Select 'MYTFS' as the requirement and/or defect system using ALM Config.
Requirements Setting
- SHARED_SPACE=shared space id, required
- WORKSPACE=workspace id, required
- REQ_QUERY=additional query clause to filter requirements
Defect Setting
- SHARED_SPACE=shared space id, required
- WORKSPACE=workspace id, required
- BUG_QUERY=additional query clause to filter defects
AddOn Settings
AddOn Settings are defined in file www/config/config.properties:
- ADDON.MYOCTANE.AUTH.USERNAME=userid, use USERNAME/PASSWORD or CLIENT_ID/CLIENT_SECRETE
- ADDON.MYOCTANE.AUTH.PASSWORD=password/access token
- ADDON.MYOCTANE.AUTH.CLIENT_ID=clientId
- ADDON.MYOCTANE.AUTH.CLIENT_SECRET=clientSecret
- ADDON.MYOCTANE.BUG.ENABLED=true
- ADDON.MYOCTANE.CLASS=com.webmbt.alm.addon.AddOnOctane
- ADDON.MYOCTANE.REQ.ENABLED=true
- ADDON.MYOCTANE.URL=url pointing to your Octane hosted server
- ADDON.MYOCTANE.REQ_QUERY=additional query clause to filter requirements, overridden by model setting
- ADDON.MYOCTANE.BUG_QUERY=additional query clause to filter defects, overridden by model setting