Plugins

The purpose of this wiki is to show how some plugins are configured to work with ComponentDB.

Plugins:

• Org Links
• Traveler

Updating Plugin Configuration

1. cd into CDB installation directory.
2. cd into etc/plugins-(deployment-name)
3. Two approaches
   1. rm -rf (plugin-name)
   2. cd (plugin-name) and edit configuration files.
4. Redeploy the plugin
   1. cd into CDB distribution directory.
   2. run source setup.sh
   3. run make deploy-cdb-plugin
      1. If the plugin config was removed you will be prompted to configure it again.
      2. Otherwise the new configuration will be applied.
5. redeploy the cdb
   1. make deploy-web-portal

Org Links

The orgLinks plugin allows each facility to define a set of useful links to be displayed on about page, for example a link to the development deployment of the application and the production deployment, facility home page, etc. Please follow the steps below to define your orgLinks plugin.

1. cd into CDB distribution directory.
2. run source setup.sh
3. run make deploy-cdb-plugin
   1. use the default directory
   2. type the number that corresponds to orgLinks plugin
   3. follow prompts to configure the plugin
4. The utility will prompt you for configuration of your links. They are defined in json format. Example is provided with plugin (default value).
   1. Format is: [{ name: text, href[optional]: text, children[optional]: [links] }]

# JSON example in pretty print. Use single line for configuration. 
  [
    {
      "name": "Help Tools",
      "children": [
        {
          "name": "CDB User Manual",
          "href": "https://confluence.aps.anl.gov/x/fYB3AQ"
        }
      ]
    },
    {
      "name": "CDB Development",
      "href": "https://cdb-dev.aps.anl.gov/"
    }
  ]

5. run make deploy-web-portal
6. Navigate to about page and you should see the configured links.

The Traveler Plugin

The ComponentDB can integrate with the traveler system by allowing the user to create and link traveler forms, instances, and binders to components. This section will outline the steps needed for connecting the two applications together.

1. Deploy the traveler system: https://github.com/AdvancedPhotonSource/traveler (follow instructions in the readme or utilize docker configurations)
2. Edit service.json configuration of the traveler system to have information for CDB.

{
"device_application": "cdb",
"cdb" : {
    "web_portal_url": "https://cdburl/cdb",
    "web_service_url":"http://webserviceurl:10232/cdb"
  }
}

• NOTE: Traveler configuration directory is: travelerInstallDir/etc/traveler-config

3. cd into CDB distribution directory.
4. run source setup.sh
5. run make deploy-cdb-plugin
   1. use the default directory
   2. type the number that corresponds to traveler plugin
   3. follow prompts to configure the plugin
      • Prompt descriptions
        1. WebService.url: api port was configured in the api.json file
        2. webService.basicAuth.username: (keep default - api_write implies permission in traveler app)
        3. webService.basicAuth.password: configured in the api.json file the value of api_write
        4. webApp.url: Used for generating URL to the traveler, enter URL that you would use to access traveler.
        5. webApp.TemplatePath: Likely keep default
        6. webApp.TravelerPath: Likely keep default
        7. webApp.BinderPath: Likely keep default
        8. webApp.TravelerConfigPath: Likely keep default
6. run make deploy-web-portal
7. Add the property for traveler instance, traveler binder, and traveler template.
   1. Navigate the the portal
   2. Log in as administrative account
   3. On navigation bar expand administrative and click on Property Types
   4. Create Traveler instance, traveler template, and traveler binder properties.
      1. Click Add
      2. Fill in the property name, select internal
      3. Select handler for the corresponding traveler instance/binder/template
      4. Click Save
      5. Repeat until all traveler properties are added
8. [Optionally] for traveler template property, you can add traveler template ids as an 'allowed value' to allow any inventory item to create corresponding instance.
9. You should now find a section for traveler template on a catalog item details. You need to add some templates for its inventory items to have selection to create traveler instances from.