Feedback
 
Did this article resolve your question/issue?

   

Your feedback is appreciated.

Please tell us how we can make this article more useful. Please provide us a way to contact you, should we need clarification on the feedback provided or if you need further assistance.

Characters Remaining: 1025

 


Article

How to enable Swagger for PASOE instance

« Go Back

Information

 
Article Number000093193
EnvironmentProduct: OpenEdge
Version: 11.7.4
OS: All supported platforms
Other: PASOE, Swagger
Question/Problem Description
Allowing Swagger on PASOE instance
How to enable Swagger for a PASOE instance
How to resolve Web Browser permission errors when accessing the oemanager: http://localhost:8890/oemanager -u tomcat
Steps to Reproduce
Clarifying Information
The OpenEdge Service Pack 11.7.4: New Information has a section regarding Swagger:
Manage and monitor an instance, Use Swagger UI to explore management REST APIs
This document can be found in the Product Alert: 000092839, OpenEdge Service Pack 11.7.4 Is Now Available  
Error MessageWebBrowser error:

403 forbidden
Access Denied.
Defect/Enhancement Number
Cause
For Web Browser permission errors. 
Possible cause:
Missing trailing backslash "/" at the end of the URL: http://<servername>:8890/oemanager/

 
Resolution

To enable Swagger for a PASOE instance:

1. Open a PROENV shell and navigate to the working directory.

2. Create a PASOE instance:
$   pasman create -f -p 8890 -P 8891 -s 8892 -m tomcat:tomcat -N Test <workingdirectory>/Test

Note: If running in a production server the -f will not copy the war files to the instance directory because there are no war files in $CATALINA_HOME.
Use tcman deploy command instead, war files will be copied to the instance directory properly.

3. Start the PASOE instance in order to have the oemanager directory properly created in \<workingdirectory>\<instancenamedirectory>\webapps
 
$   pasman pasoestart restart -I Test

4. Navigate to the PASOE new instance directory: \<workingdirectory>\<instancenamedirectory>\webapps\oemanager\WEB-INF
 
a. Edit the file oemgrSecurity-container.xml,
b. Uncomment the following line (around line 35):
 
<!-- Access to SwaggerUI. Disabled by default, user has to uncomment the below line to enable it -->                       
<intercept-url pattern="/doc/**" method="GET" access="hasAnyRole('ROLE_PSCAdmin','ROLE_PSCOper','ROLE_PSCUser')"/>



5. Navigate back to the working directory and then restart the PASOE instance to apply changes
 
$   pasman pasoestart -restart -I Test
 

6. Open a web browser and type:
 
http://<servername>:8890/oemanager/
  • Ensure the URL has trailing backslash / at the end.
7. User and Password (tomcat/tomcat)

8. Swagger page should be loaded. If not, please verify the steps above and then stop and restart the PASOE instance, with the OpenEdge Explorer Console or tcman stop/start.
Workaround
Notes
References to Other Documentation:

Progress Article:

000093191, Swagger on PASOE: Does work with any .war REST services  
 
Attachment 
Last Modified Date7/24/2019 7:28 PM