Skip to main content

Quantela platform user manual

Create an Adapter
updated_inbound_create_adapter.png
  1. In the top left-hand corner of the main dashboard screen, click the Manage icon: manage_icon.PNG.

  2. On the Manage panel, click Data Pipeline new_menu_data_pipeline.PNG.

  3. On the right-hand side of the Adapters screen, click the Adapter icon: new_adapter.png.

  4. In the bar near the top of the Adapters screen, if you want to select an icon that can be used to indicate the meaning of the adapter then click the Icons button: icons.png.

  5. Click newAdapter and enter a descriptive name for the adapter. Click the ‘tick’ icon to confirm the name.

  6. Click the more icon: more.png.

  7. Configure the following general settings as required in the more panel:

    Setting

    Description

    Description

    An optional description of the adapter.

    Version

    Optional version information.

    Tags

    One or more optional descriptive tags for the Adapter. Hit Enter on the keyboard after typing the tag descriptor to add it to the list.

    Tag

    Description

    PA or VMD

    Used to generate content reports for this adapter. Enter PA tag for public announcement or VMD tag for variable message display. For more information, see Create a content report.

    webhooks

    Used to push data seamlessly without access tokens using this adapter. For more information, see API Keys.

    sms

    Used to send SMS based event notifications. For more information, see Create a SOP Template.

    Domain Name

    Name of the domain to which the adapter is to be associated with.

    Configuration Logs

    If enabled, the logs are generated when saving and previewing the data.

    Press the Proceed button to save this configuration information.

  8. In the drop-down list-box beside the adapter name, select whether this is to an Inbound or an Outbound adapter. Depending on the adapter type, edit the corresponding settings as indicated below.

  9. If this adapter is to be invoked automatically at a specific time interval then click the Scheduler icon and configure the scheduler: new_scheduler.png

    • Slide the Scheduler switch to the right to enable the scheduler.

    • Enter a name for the scheduler.

    • Specify the schedule period using the standard Cron time string format. For example, "30 * * * *" can invoke the adapter at 30 minutes past the hour, every hour. "*/15 * * * *" can run every 15 minutes. "0 13 * * 1" can execute at 1pm every Monday.

    Note that if the adapter is to be scheduled then it cannot contain unresolved input parameters. The adapter cannot be invoked in the context of a dashboard widget which can provide input parameters, so it must be able to execute independently.

  10. Click Save and Generate Schema to create the Adapter with schema or Save Adapter to create the Adapter without schema.