Creating the plugin role - SiPass 3.2

SiPass Plugin Guide 3.2

Applies to
SiPass 3.2
Last updated
Content type
Guides > Plugin and extension guides
Plugin and extension guides

Before you can configure and use the plugin, you must create the plugin role in Config Tool.

Before you begin

Install the plugin.


  1. From the Config Tool home page, open the Plugins task.
  2. In the Plugins task, click Add an entity (), and select Plugin.
  3. On the Specific info page, select the plugin type, the server that will host the plugin role, and the database for the plugin role, and then click Next.
    If you are not using an expansion server, the option to select a server is not displayed.
  4. On the Basic information page, do the following:
    1. Enter the name in the Entity name field.
    2. Enter the description in the Entity description field.
    3. (Optional) Select a Partition for the plugin role.
      Partitions are logical groupings used to control the visibility of entities. Only users who are members of that partition can view or modify the role.
    4. Click Next.
  5. On the Creation summary page, review the information, and then click Create, or Back to make changes.
    After the plugin is created, the following message appears: The operation was successful.
  6. Click Close.


The plugin role appears in the entity browser. The plugin role is yellow until it is connected.