Create Service

In this article

Before you start

• The operator is signed in with Harbor Demo Group and Harbor Soho selected, or another valid organisation and location context.
• The operator can open the Services calendar and has service:view for the location.
• The operator has service:manage for the location before creating the service.
• For a public service, a valid layout and catalogue are available. The GB demo runtime includes SETUP_LAYOUT_SOURCE_LAYOUT_ID and Soho Menu through SETUP_CATALOG_SOURCE_ID.
• For an internal service, layout, catalogue and optimisation references are not needed because the form clears them.
• Staff roles are available before adding required-role counts; staff and staff roles are available before adding staff schedule rows.
• A valid start and end date/time can be chosen. Recurrence is optional.

Instructions

1. 1.

   Open the Services Calendar

   Open the Services calendar for Harbor Soho. This is the normal entry point for reviewing existing service blocks and starting a new service.

2. 2.

   Start a New Service

   Choose Create service. The app opens the New service form in create mode with Info, Required roles, Staff and Repeat tabs.

3. 3.

   Enter Core Details

   In Info, enter the service title, start and end date/time, visibility and optional description. Use a clear title such as Soho lunch service for the GB demo.

4. 4.

   Choose Visibility and Capacity References

   Keep Public when the service should be operational and bookable, then select the layout and Soho Menu catalogue. Choose Internal when the service is only a planning block; the form removes layout, catalogue and optimisation fields.

5. 5.

   Add Required Roles

   Use Required roles when the service needs staffing coverage by role. Add each role once and set the minimum and recommended counts expected for the service.

6. 6.

   Add Staff Schedules

   Use Staff when assigning named employees to the service. Each staff schedule is saved as a child staff_schedule event linked to the new service.

7. 7.

   Configure Repeat Settings

   Use Repeat only when the service should recur. Choose a supported daily, weekly, monthly or yearly rule and provide the required interval and day or month details.

8. 8.

   Create the Service

   Submit the form. Antylogic creates the service event, recurrence, staff requirements and staff schedule rows together, then refreshes calendar data and returns to the calendar view.

Validations and limits

• Organisation and location context must be present before the form is usable.
• service:view is needed to reach the service calendar, and service:manage is needed to create the service.
• Title, start and end are required in the form, and start must be before end.
• Public services require valid layout_id and catalog_id. optimization_config_id is optional but requires reservation-automatic:use when supplied.
• Internal visibility clears layout_id, catalog_id and optimization_config_id and creates a planning-only service block.
• Recurrence requires a supported frequency and valid interval, day and month constraints.
• Each required role needs a staff_role_id, and duplicate role requirements in the same bundle are rejected.
• Staff schedules require staff-schedule:manage, a staff member, a role, a valid time mode and valid absolute times or relative offsets.
• The service-bundle create API accepts only an empty kind or kind service, and creation can be rejected when the service conflicts with a location vacation rule.

Expected result

The service bundle is saved transactionally: the main calendar_event is created as kind service, recurrence is stored when configured, staff requirements are synchronised, staff schedules are stored as child calendar_events with kind staff_schedule, and the Services calendar reloads.