Disabling collaboration content within webMethods API Portal

webMethods API Portal tutorial

Often we received queries from different customers on how to safely disable the collaboration component within webMethods API Portal platform. As part of this we will explore options to disable the collaboration within API Portal.

Prerequisites

Before making below changes, please login to ACC console and stop apiportalbundle runnable.

Disabling collaboration 

Open the file located in $$SoftwareAG/API_Portal/server/bin/work/work_apiportalbundle_s/base/webapps/collaboration/WEB-INF/config/collaboration/platform/apiportal/platform.properties.

Set the property key enableECP to false

enableECP=false

Now your collaboration / activties stream pages will be blocked.

Disabling collaboration in global search

Open the file located in $$SoftwareAG/API_Portal/server/bin/work/work_apiportalbundle_s/base/webapps/ROOT/WEB-INF/config/apiportal/instances/extendedGlobalSearch/extendedGlobalSearch_default.xml.

Comment out the collaboration plugin.

     <!--plugin>
        <id>collaboration</id>
        <priority>2</priority>
        <label>base.globalSearch.plugin.collaboration.DBI</label>
    </plugin-->

Disabling collaboration in advanced search

Open the file located in $$SoftwareAG/API_Portal/server/bin/work/work_apiportalbundle_s/base/webapps/ROOT/WEB-INF/config/apiportal/instances/globalSearch/globalSearch_default.xml.

Comment out the collaboration plugin.

     <!--plugin>
        <id>collaboration</id>
        <priority>2</priority>
        <label>base.globalSearch.plugin.collaboration.DBI</label>
    </plugin-->

 

Now advanced search will not render collaboration results.

Disclaimer

  • These are file level changes and will be lost if you apply a fix. You need to reapply the changes explicitly after fix install.
  • These are file level changes and affect all the tenants in your API Portal env.

image.png

image.png