Skip to main content

PayComplete™™ Help Center

Configuring a plug-in

You configure a plug-in when you want to extend Connect on-Device with custom functionality.

Task. Configure a plug-in

  1. Start Connect on-Device Studio.

  2. In the navigation pane, select Plug-ins.

  3. Select New.

  4. In the Class-Path field, select the Add button.

  5. Select the JAR file containing the plug-in implementation you want to add and select Open to add the file.

    Repeat this for all the plug-in implementations you want to add.

  6. In the Confirm dialog, select the location where you want to store the JAR file.

    • Copy — Select if you want to copy the plug-in JAR file to the default location: [installation folder]/data/plugins.

    • Keep — Select if you want to keep the plug-in JAR file in its current location.

  7. Select the files and copy them to the [installation folder]\data\plugins folder in your Connect on-Device installation folder.

  8. In the Main-Class box, enter the fully qualified name of the class implementing com.scancoin.sdk.plugin.IOJPlugin.

    • Connect on-Device Studio shows a suggestion for Main-Class based on implementations found in the added JAR files.

    • If Main-Class is already filled in or contains the correct plug-in implementation, you can skip this step.

  9. Select the second New button to add new properties with arbitrary keys.

    • Key — Enter the full name of the property key.

      Suggested prefixes are shown. The suggested prefixes are based on the fully qualified class names of configured plug-ins but the key can have any or no prefix as long as it is unique within the configuration.

    • Value — Enter the property value.

    • Comment — Enter a comment that describes the purpose or possible values of the property. Comments are optional.

  10. Select OK to save the new property.

  11. If you want to import multiple properties from an external file, select Import.

  12. Select the file you want to import and select Open.

  13. Review and, if needed, edit the property values from the selected file.

  14. Select OK to import the multiple properties into the configuration.

  15. Select Save to save the configuration changes.

If the plug-in is a service flow, that is, if it implements com.scancoin.sdk.plugin.IOJServiceFlow, it is possible to add a custom icon for the service.

Note

No further action is needed, if the plug-in implements com.scancoin.sdk.plugin.IOJServiceFlow2 and returns a valid image stream via:

InputStream IOJServiceFlow2.getIcon()