24 Appointments Management
The Appointments Management module is an application available in the Supply Chain Hub. This chapter describes the implementation considerations and the operation details.
Implementation Overview
This section provides an implementation overview of Appointments Management.
Status Workflow
Figure 24-1 Appointments Management Status Workflow
Appointments Management follows a workflow path for Appointment, and the status can change depending on:
- The user permissions.
- The current status of the Appointment.
Appointment Status:
- New (N) - This is the initial Appointment Status. From this status, it's possible to Cancel and Approve an Appointment.
- Approved (A) - This is the status of an Appointment that was approved. From this status, it's possible to Cancel, Check-in or Receive an Appointment.
- Canceled (X) - This is the status of an Appointment that was canceled. The appointment is not editable whilst on this status.
- Checked-In (CI) - This is the status of an Appointment that was checked in. From this status, it's possible to Receive an Appointment.
- Received (R) - This is the status of an Appointment that was received. The Appointment is not editable whilst on this status.
- Expired (XP) - This is the status of an Approved Appointment where the Appointment date has already passed. The appointment is not editable whilst on this status.
Configuration
This section describes Appointments Management configuration.
POM Configuration
Batch scheduler details with all batches, dependencies and frequencies can be downloaded following the steps in the Supply Chain Hub Frameworks section.
Other Implementation Considerations
This section describes the Appointment Management implementation considerations.
Notifications and Alerts
Appointments Management uses the Events Framework to inform users about some actions with notifications and alerts. Below is the list of notifications available. The notifications are implemented via the Rule Engine Framework documented in the Supply Chain Hub Frameworks section.
Notifications
SPAP_EVENT_PEND_APPR_APPT - Submitted Appointment is pending approval
Table 24-1 Notifications - Appointments Management
| PROPERTY | VALUE |
|---|---|
| Event Name | SPAP_EVENT_PEND_APPR_APPT |
| Event Type | ORCV_SPAP_EVENT_PEND_APPR_APPT |
| Description | Notification triggered when an Appointment is Submitted by a Supplier User without approval permission. |
| Trigger | UI/S9T |
| Target Users | The Retailer Contacts of the Supplier with access to the Location of the Appointment. |
SPAP_EVENT_CANCEL_APPT - Appointment canceled by the Retailer User
| PROPERTY | VALUE |
|---|---|
| Event Name | SPAP_EVENT_CANCEL_APPT |
| Event Type | ORCV_SPAP_EVENT_CANCEL_APPT |
| Description | Notification triggered when an Appointment is Canceled by a Retailer. |
| Trigger | UI/S9T |
| Target Users | Supplier Users of the Supplier with access to the Location of the Appointment. |
Alerts
SPAP_EVENT_APPTS_PENDING_ACTION
List of future Appointments pending approval.
| PROPERTY | VALUE |
|---|---|
| Event Name | SPAP_EVENT_APPTS_PENDING_ACTION |
| Event Type | ORCV_SPAP_EVENT_APPTS_PENDING |
| Alert Type | |
| Description | Email with the list of future Appointments pending approval. |
| Trigger | Batch ORCV_SPAP_APPT_EVT_PND_JOB |
| Target Users | The Retailer Contacts of the Supplier with access to the Location of the Appointment. |
Custom Validations
| Group Id | Executed When |
|---|---|
| SPAP_APPT_APPROVE | Appointment is approved. |
| SPAP_APPT_CANCEL | Appointment is canceled. |
| SPAP_APPT_CHECK_IN | Appointment is checked in. |
| SPAP_APPT_RECEIVE | Appointment is received. |
| SPAP_APPT_SUBMIT | Appointment is submitted. |
| SPAP_SLOT_AVL_EXC_DELETE | Slot availability exception is deleted. |
| SPAP_SLOT_AVL_EXC_SUBMIT | Slot availability exception is submitted. |
Specific Batch Configuration
Appointments Pending Action Alert Batch
Appointments Pending Action Alert checks if there are Appointments pending approval with Booking Date after Business Data (VDATE) and creates Event Alerts in Events Framework.
- Job: ORCV_RLEG_SPAP_EVENT_APPT_JOB
- Frequency: Ad-hoc
- Dependency: None
- Inter Scheduler Dependency: None
This batch uses the Rule Engine Framework described in the Supply Chain Hub Frameworks section with the following configurations.
Rule default configuration (ORCV_RLEG_RULE):
| RULE KEY | RULE NAME | PROGRAM NAME | APP ALIAS | RULE MODE |
|---|---|---|---|---|
| SPAP_APPT_EVT_PND | ORCV_RLEG_SPAP_EVENT_APPT_JOB | ORCV_RLEG_SPAP_APPT_EVT_PND | SPAP | Batch |
Batch default configuration (ORCV_BATCH_CONFIG):
| COLUMN NAME | DEFAULT VALUES |
|---|---|
| Program Name | ORCV_RLEG_SPAP_APPT_EVT_PND |
| Maximum Chunk Size | 1000 |
| Maximum Concurrent Threads | 4 |
| Retry Lock Attempts | 3 |
| Retry Wait Time | 3 |
| Retry Maximum Attempts | 3 |
| Retry Ordered | N |
| Retry Indicator | N |
Materialized Views
This application requires some results to be materialized in tables using the Materialized View Framework described in the Supply Chain Hub Frameworks section, below is the list for this application. Materialized Views used in SPAP are listed in this section.
Codes
Certain operations require codes to define the options available at system level. Below you can find the list of code types available.
The codes are defined in the ORCV_CODE_HEAD and ORCV_CODE_DETAIL tables.
| CODE TYPE | CODE TYPE DESCRIPTION |
|---|---|
| APAR | Appointment - Appointment Create Screen Document Type |
| APCL | Appointment - Appointment Calendar Day Labels |
| APDP | Appointment - Appointment Calendar Date Period |
| APDT | Appointment - Appointment Detail Document Type |
| APQI | Appointment - Appointment Query information |
| APRC | Appointment - Appointment Reason Codes |
| APST | Appointment - Appointment Status |
| SBRC | Appointment - Slot Blocks Reason Codes |
| SLAD | Appointment - All Slots Desc |
| SLAV | Appointment - Slot Availability |
| SLLT | Appointment - Slot Location Type |
| SLST | Appointment - Slot Status |
| SLTP | Appointment - Slot Type |
Templates
Appointments uses a spreadsheet download and upload process, developed as part of the Retail Supply Chain Hub Frameworks, to create, maintain, and extract data. Some templates must be configured to support these processes, and several configurations should be reviewed as part of the implementation.
Template Appointments Data
Template key: SPAP_APPTS_DATA
The required permissions per action for this template are the following:
| ACTION TYPE | ROLE NAME |
|---|---|
| Download | ORCV_SPAP_APPT_APPR_JOB |
| Download | ORCV_SPAP_APPT_EDIT_JOB |
| Download | ORCV_SPAP_APPT_VIEW_JOB |
| Download Blank | ORCV_SPAP_APP_JOB |
| Upload | ORCV_SPAP_APPT_APPR_JOB |
| Upload | ORCV_SPAP_APPT_EDIT_JOB |
Worksheet Appointments
| ACTION | MANDATORY CELLS / FIELDS | NOTES |
|---|---|---|
| Create |
Appointment ID Booking Date Supplier Location Appointment Type Slot ID |
NA |
| Approve | Appointment ID | Updates the appointment status. |
| Cancel | Appointment ID | Updates the appointment status. |
| Check-In | Appointment ID | Updates the appointment status. |
| Receive | Appointment ID | Updates the appointment status. |
Template Slots Data
Template key: SPAP_SLOTS_DATA
The required permissions per action for this template are the following:
| ACTION TYPE | ROLE NAME |
|---|---|
| Download | ORCV_SPAP_SLOT_EDIT_JOB |
| Download | ORCV_SPAP_SLOT_VIEW_JOB |
| Download Blank | ORCV_SPAP_SLOT_EDIT_JOB |
| Download Blank | ORCV_SPAP_SLOT_VIEW_JOB |
| Upload | ORCV_SPAP_SLOT_EDIT_JOB |
Worksheet Slot
| ACTION | MANDATORY CELLS / FIELDS | NOTES |
|---|---|---|
| Create |
Slot ID Slot Name Location Time Capacity Multiple Bookings Ind Dock Status Slot Type Availability 1 Sunday Ind, Monday Ind, Tuesday Ind, Wednesday Ind, Thursday Ind, Friday Ind, Saturday Ind |
1 Daily Indicators are only mandatory if availability is set to "C- Custom Days". |
| Update |
Slot ID Updatable: Slot Name, Location, Time, Capacity, Limitations, Multiple Bookings Ind, Dock, Status, Slot Type, Availability and daily indicators. |
Updates the slot with the new information. |
| Delete | Slot ID | Deletes the slot. |
Operations
This section describes Appointments Management operations.
Batch by Module
This section describes Appointments Management batches.
Appointments Pending Action Alert Batch
The Events Alerts batch uses the Rule Engine Framework described in the Supply Chain Hub Frameworks section. To execute this batch call Rule Engine Web Service with Rule Key ORCV_RLEG_SPAP_EVENT_APPT_JOB.
Materialized Views Refresh Details
This section describes Materialized Views Refresh Details for Appointments Management.
ORCV_MV_SPAP_APPT_EST_QTY
| PARAMETER | VALUE |
|---|---|
| Result Synonym | ORCV_MV_SPAP_APPT_EST_QTY |
| Result Table A | ORCV_SPAP_APPT_EST_QTY_A_R |
| Result Table B | ORCV_SPAP_APPT_EST_QTY_B_R |
| Source View | ORCV_V_SPAP_APPT_EST_QTY_R |
| Driving View | ORCV_V_SPAP_APPT_EST_QTY_RC |
| Pre-Processor | ORCV_COMMON_MV_REFRESH.COMMON_PRE_PROCESSOR |
| Check Function | NA |
| Preserve Data | Y |
| Restart Indicator | N |
| Max Concurrent Threads | 4 |
| Filter Fields | APPOINTMENT_ID |