Plug-in settings

The following describes the steps to apply a plug-in to Garoon.

Illustration: describing the "Plug-in details" screen

Adding Plug-Ins

You can add a plug-in by importing a plug-in file in zip format.

Steps:
  1. Prepare a plug-in file.

    You can find the plug-ins applicable to Garoon on the product site. For details, refer to Searching Products for Integration and Plug-Ins.
    This section describes the questionnaire plug-in as an example.

  2. Click the Administration menu icon (gear icon) in the header.

  3. Click Garoon System Administration.

  4. Select "Basic system administration" tab.

  5. Click Plug-in.

  6. Click Plug-in settings.

  7. On the "Plug-in settings" screen, click Add plug-in.

    Screen capture: The "Plug-in settings" screen. A button to add a plug-in is shown.

  8. In the "Add plug-in" dialog, attach a plug-in file.

    You can import a plug-in file only with the ".zip" extension.
    The maximum size of the file you can upload is 100MB.

  9. Ensure that the plug-in file in zip format is attached, and click Add.

    Once you added a plug-in, the settings are configured as below. Change the settings according to your needs.

    • Use plug-in: Disabled
    • Applied to: Login user

Configuring Plug-in Details

Configure plug-in details. The fields you need to configure depend on each plug-in.

Steps:
  1. Click the Administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Basic system administration" tab.

  4. Click Plug-in.

  5. Click Plug-in settings.

  6. On the "Plug-in settings" screen, click the plug-in to configure the detailed settings.

    Screen capture: The "Plug-in settings" screen. A plug-in to configure settings is selected.

  7. On the "Plug-in details" screen, click Configure.

    Screen capture: The "Plug-in details" screen. An action link to a screen to configure each plug-in is highlighted.

  8. On the "Advanced settings" screen, configure required fields.

Configuring Target to Apply a Plug-In

Configure users, organizations, and/or roles to apply a plug-in.

Steps:
  1. Click the Administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Basic system administration" tab.

  4. Click Plug-in.

  5. Click Plug-in settings.

  6. On the "Plug-in settings" screen, click the plug-in to configure targets.

    Screen capture: The "Plug-in settings" screen. A plug-in to configure targets is selected.

  7. On the "Plug-in details" screen, click Change.

    Screen capture: The "Plug-in details" screen. An action link to a screen to change plug-in settings is highlighted.

  8. On the "Change plug-in" screen, click Change.

    Screen capture: The "Change plug-in" screen. An action link to a dialog to select targets is highlighted.

  9. In the "Select users, organizations, or roles" dialog, select the plug-in targets and click Apply.

    Select the target from the user, organization, or role. By default, the logged-in user has been set for the target.
    The order to display the targets are set automatically. You cannot change it.
    Screen capture: Select targets to apply a plug-in.

  10. On the "Change plug-in" screen, check the settings and click Change.

Enabling Plug-Ins

If you enable a plug-in, it will be applied to the users configured as targets. You can enable up to 10 plug-ins.

Steps:
  1. Click the Administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Basic system administration" tab.

  4. Click Plug-in.

  5. Click Plug-in settings.

  6. On the "Plug-in settings" screen, click the plug-in to enable.

    Screen capture: The "Plug-in settings" screen. A plug-in to be enabled is selected.

  7. On the "Plug-in details" screen, click Change.

    Screen capture: The "Plug-in details" screen. An action link to a screen to change plug-in settings is highlighted.

  8. On the "Change plug-in" screen, select "Enable" in the "Use plug-in" field.

    Screen capture: The "Change plug-in" screen. A radio button to enable the use of the plug-in is selected.

  9. Confirm your settings and click Save.

Disabling Plug-Ins

You can disable plug-ins. Even after disabling the plug-in, "Plug-in details" and "Applied to" settings are retained.

Steps:
  1. Click the Administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Basic system administration" tab.

  4. Click Plug-in.

  5. Click Plug-in settings.

  6. On the "Plug-in settings" screen, click the plug-in to disable it.

    Screen capture: The "Plug-in settings" screen. A plug-in to disable is selected.

  7. On the "Plug-in details" screen, click Change.

    Screen capture: The "Plug-in details" screen. An action link to a screen to change plug-in settings is highlighted.

  8. On the "Change plug-in" screen, select "Disable" in the "Use plug-in" field.

    Screen capture: The "Change plug-in" screen. A radio button to disable the use of the plug-in is selected.

  9. Confirm your settings and click Save.

Updating Plug-Ins

You can update plug-ins. Even after updating the plug-in, "Plug-in details", "Use plug-in" (enable/disable), and "Applied to" settings are retained.

Steps:
  1. Click the Administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Basic system administration" tab.

  4. Click Plug-in.

  5. Click Plug-in settings.

  6. On the "Plug-in settings" screen, click the plug-in to update.

    Screen capture: The "Plug-in settings" screen. A plug-in to update is selected.

  7. On the "Plug-in details" screen, click Update.

    Screen capture: An action link for update

  8. In the "Update plug-in" dialog, attach a plug-in file.

    You can import a plug-in file only with the ".zip" extension.
    The maximum size of the file you can upload is 100MB.

  9. Ensure that the specified plug-in file is correct, and click Update.

Deleting Plug-Ins

You can delete plug-ins.

Steps:
  1. Click the Administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Basic system administration" tab.

  4. Click Plug-in.

  5. Click Plug-in settings.

  6. On the "Plug-in settings" screen, click the plug-in to delete.

    Screen capture: The "Plug-in settings" screen. A plug-in to delete is selected.

  7. On the "Plug-in details" screen, click Options and click Delete.

    Screen capture: The "Plug-in details" screen. An action link to a dialog to delete the plug-in is highlighted.

  8. In the "Delete plug-in" dialog, click Delete plug-in.