Helix Swarm Guide (2019.3)

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 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 deleted, this forces Swarm to use the module change. To clear the Swarm config cache, make the following curl request as an admin user:

curl -u "username:password" -X DELETE "https://myswarm.url/api/v10/cache/config/"

For more information on deleting the config cache, see Swarm config cache file delete.