Modules setup

This doc explains how to set up modules in Receptive. Learn more about modules.

How to set up modules:

• Decide which modules to use
• How to add a new module
• Assigning your customers to specific modules
• Assigning modules manually
• Deleting a module 

Decide which modules to use

How to add a new module

Start by heading over to your settings menu by clicking the drop-down menu in the top-right corner and selecting “Settings”.

Select "Modules" from the left navigation.

This shows a screen with the option to add a new module or edit existing modules.

Fill in the name of your new module and click the “Add module” button.

This will add a new module to your Receptive dashboard.  

Your current requests will be assigned to your initial module, named after your company. So after adding your first module, you will see two products. One will be the one you have just created, and the other will be your initial module.

Note: Every time you add a new module, you need to update the integration in order to give your customers access to them. Read on for more information.... 

Assigning your customers to specific modules

Your current end users (and any that you manually invite through your UI) will automatically be assigned to your initial module.

What this means is that your end users will only be able to view the requests associated with your first module.

To automatically assign your users to certain modules, you need to configure your Receptive javascript integration.

Simply use the key for "user.allowed_products" when creating or updating your snippet in step one here. 

"user":{
      "email":"joe@example.com",
      "id":"123",
      "full_name":"Joe Bloggs",
      "allowed_products":[{"name": 'Module 1', "id": 'reporting-module-266601e4'}]
    }

In that example above, you can see that you need to include both the name and ID of the modules you want to give your users access to. You can list as many modules here as you require.

The external ID for an existing module can be found here or go to Settings > Modules and select "Manage modules". The ID is in parenthesis to the right of the product name: 

For example, the external ID for "Module 1" is 'reporting-module-266601e4'.

Details on how the "user.allowed_products" key works: 

• Leaving out the 'allowed_products' field in the snippet will leave the module settings for each user as currently set.
• To remove module access from users, you will need to specify an empty list as their allowed_products field. (However each user will always need at least one module associated, and if set to an empty list in the snippet, then the default (first) module will be assigned to the user.)
• You can also create a new module on the fly via the integration by using a new external ID in the integration snippet.

Assigning modules manually

If you want to manually change the modules associated with a user prior to assigning access via the integration (above), you can edit the "Allowed modules" from their edit profile page:

Deleting modules

If you want to delete a module, you'll need to remove all references to that module in Receptive and your integration. 

Note: Every time you delete a module, you need to update your integration in order to remove your customers' access to the module.

Get in touch if you need help.