Univention Bugzilla – Bug 53999
Add documentation about OX Connector app
Last modified: 2022-08-19 15:29:03 CEST
Bug #53419 just mentions the app in the manual. To provide benefit to the reader the OX Connector documentation should be enhanced more and cover the following aspects. 1. What are the requirements for installation and deployment? 2. What are the steps to check for the correct functionality of the app on the system? 3. Where are relevant logfiles? 4. How are the relevant UCR variables called and what's their purpose? What values are allowed? 5. How and where can the app be debugged? 6. What information is needed for the configuration and where can be obtained? 7. What system roles are recommended for the installation? The transfer point is the OX App Suite SOAP API. 8. Where is the documentation of the SOAP API? Provide a link in the documentation. 9. What does the Connector do? 10. What are the intended scenarios? What scenarios are supported and how are the configured?
Need for the documentation was emphasized today in a conversation with professional services.
*** Bug 54554 has been marked as a duplicate of this bug. ***
Documentation is written. Waiting for review.
QA was done by Dirk.
The document is built and deployed to public. It can be reached at https://docs.software-univention.de/ox-connector-app/2.0.0/ The latest version of the document can be reached at https://docs.software-univention.de/ox-connector-app/latest/ Furthermore, the documentation page about apps now has an entry for OX Connector, see https://docs.software-univention.de/apps_5.0.html.en.