Custom Services

From the Xenial Portal, add custom service integrations. Custom service types include:

  • Delivery service via mobile app or website.

  • Customer loyalty program service.

  • Gift card service provider.

Optionally add custom sections and unique input fields to capture additional information or settings for the service. The custom fields are added to the Custom Service section of the Sites editor.

Add Custom Service

Xenial PortalSettings and ToolsCustom Services

To add a custom service:

  1. From the upper-right of the Custom Services screen, select Add Custom Service.

  2. Define General Settings for a Custom Service.

  3. Define Custom Fields for a Custom Service.

  4. From the upper-right of the screen, select Save.

Define General Settings for a Custom Service

Xenial PortalSettings and ToolsCustom Services

To define general settings for a custom service:

  1. From the menu pane on the left of the Custom Services page, select General.

  2. In the Service Name field, type the name of the service.

  3. In the Description field, type a description of the service.

  4. In the Service URL field, type the integrator-provided URL to which this service communicates.

  5. From the Type dropdown, select the service type:

    Type

    Description

    Delivery

    Delivery service via mobile app or website.

    From the Order Source dropdown, select the applicable order source for the delivery service: Mobile app or Website.

    Gift Provider

    Gift card service provider.

    Once created, assign the service to a gift provider profile in Data Management. See Gift Provider Profiles.

    Once the service is assigned to a profile, the service properties cannot be changed.

    Loyalty

    Customer loyalty program service.

Define Custom Fields for a Custom Service

Xenial PortalSettings and ToolsCustom Services

Optionally add custom sections and unique input fields to capture additional information or settings for the service. The custom fields are added to the Custom Service section of the Sites editor.

The following describes how to:

Add Section

To add a section:

  1. From the menu pane on the left of the Custom Services page, select Custom Fields.

  2. Select +Add New Section.

  3. In the Section Name field of the Add Section popup, type a name for the section.

  4. From the lower-right of the Add Section window, select Create.

  5. Add as many sections as needed. The following controls are displayed in the upper-right of each section:

    Control

    Description

    pencil icon

    Edit the properties of the section.

    single up arrow

    Move the section up one level.

    single down arrow

    Move the section down one level.

    grey "x"

    Remove the section.

Add Field to Section

Within each section, add any combination of three types of fields:

Type

Description

Drop Down

A list of choices from which the user makes a selection.

Text Entry

A field where text is typed (maximum characters: 1024).

Toggle

An option to toggle on/off.

Next to each field in a section, the following controls are provided.

Control

Description

dot menu

Select and drag the field to a new location in the section.

pencil icon

Edit the properties of the field.

grey "x"

Remove the field from the section.

Add Drop Down

To add a Drop Down field to a section:

  1. From inside a section, select +Add New Field.

  2. From the Type dropdown, select Drop Down.

  3. In the Label field, type a name for the field.

  4. In the Help Text field, type an instructional note to help the user understand the purpose of the field.

  5. In the Placeholder Text field, type the placeholder text to display in the field when the section is first opened. The user replaces this text when they type their own value in the field.

  6. Toggle Required to On if the user is required to provide a value for the field.

  7. (Gift Provider service only) Toggle Bulk Enabled to On if the service supports Bulk Gift Card Activation.

  8. In the Parameter Key field, type the parameter name for this value that is used in the API.

  9. In the Field Choices section, select +Add Choice to add a choice to the dropdown.

    • Add as many choices to the dropdown as needed.

    • From the Default Choice column, select the choice that is selected from the dropdown by default.

    • In the Preview section, a preview of the new field is displayed.

  10. From the lower-right, select Save.

Add Text Entry

To add a Text Entry field to a section:

  1. From inside a section, select +Add New Field.

  2. From the Type dropdown, select Text Entry.

  3. In the Label field, type a name for the field.

  4. Toggle Required to On if the user is required to provide a value for the field.

  5. (Gift Provider service only) Toggle Bulk Enabled to On if the service supports Bulk Gift Card Activation.

  6. In the Help Text field, type an instructional note to help the user understand the purpose of the field.

  7. In the Placeholder Text field, type the placeholder text to display in the field when the section is first opened. The user replaces this text when they type their own value in the field.

  8. In the Parameter Key field, type the parameter name for this value that is used in the API.

  9. From the lower-right, select Save.

Add Toggle

To add a Toggle field to a section:

  1. From inside a section, select +Add New Field.

  2. From the Type dropdown, select Toggle.

  3. In the Label field, type a name for the field.

  4. From the Default State dropdown, select whether the field is toggled On or Off by default.

  5. (Gift Provider service only) Toggle Bulk Enabled to On if the service supports Bulk Gift Card Activation.

  6. In the On Description field, type the field description when it is toggled On.

  7. In the Off Description field, type the field description when it is toggled Off.

  8. In the Help Text field, type an instructional note to help the user understand the purpose of the field.

  9. In the Parameter Key field, type the parameter name for this value that is used in the API.

  10. From the lower-right, select Save.