Modules

You can design and implement your own custom Swarm modules to modify the behavior of Swarm. This section covers the design and implementation of Swarm custom modules.

Important

The My Dashboard, Reviews list, Project settings, and Review display pages are written in React.These pages cannot be customized. If you already have custom modules for these pages and you upgrade Swarm, the custom modules will not work.

If you have custom modules for any of these pages, you can send them to the Swarm team to see if there is enough demand to productize them and include them in a future release. Submit a Support request to request productization of a custom module.

Important

The operation and testing of custom modules is the responsibility of the module creator.  Perforce Software, Inc. is not responsible for the operation of your custom modules, nor does Perforce Software, Inc. make any representations or warranties regarding the interoperability of your custom modules with Helix Swarm.

Tip

You must test your custom modules on a test system before transferring them to your production system. This avoids any negative impact on the operation of your production system. If you have more than one custom module, the modules should all be tested at the same time on the same test system as this ensures that the modules operate correctly with each other and with Helix Swarm.

Tip

If you add or edit a module, Swarm will not use that change until the config cache has been reloaded, this forces Swarm to use the module change. You must be an admin or super user to reload the Swarm config cache. Navigate to the User id dropdown menu, select System Information, click the Cache Info tab, and click the Reload Configuration button.