Ingest Facility

Description: In the CMD context, a Customer Facility refers to a location where shipping materials are stored. The Ingest Facility is a service used to ingest and manage facility records. This service is accessible to any external application with appropriate access, including the CMD Portal or other backend services.

A Customer Facility can be associated with one or more customers through customer-facility relationships. Within the CMD application, the Customer Facility entity supports the following operations:

• Creation: Adding new facility records.
• Updating: Modifying existing facility details.
• Inactivation: Marking facilities as inactive when they are no longer in use.

These operations ensure seamless management and association of facilities with customers.

API Contract:

Refer below document to understand the request/response Structure :

INGEST FACILITY OAS

SEARCH FACILITY OAS

Functionalities:

1. Create/Update Facility: Enables the creation of new facilities and updating details of existing ones.
2. Validate Facility: Ensures that the facility data provided is accurate and adheres to the required structure and business rules.
3. Duplicate Match: Identifies duplicate facility records to maintain data integrity.
4. Assign Customer-Facility Relationship: Establishes and manages associations between customers and their respective facilities.

These operations and functionalities ensure efficient management of facility data and robust integration with customer relationships.

Mandatory fields for creations are:

FIELDS	MANDATORY
Customer Facility Name	✅
Either Street Name or P.O. Box	✅
Country Name	✅
City Name	✅
Postal Code	Depends on Country Generic rule
Street Number	Depends on Country Generic rule
Region/ State	Depends on Country Generic rule

FACILITY CREATE/UPDATE/ASSIGN FLOW

Validation Rules for Facility Records:

1. Every field’s value must adhere to its defined regular expression.
2. Each facility field's value must conform to the specified regex format.
3. The Facility Name is mandatory.
4. Country Name and City Name are mandatory fields.
5. At least one of Street Name or P.O. Box is mandatory.
6. The Source System must be valid.
7. Validation should ensure that facilities are not associated with restricted countries.
8. Reference Data Validation: Verify fields such as country code, country name, and city name against reference data.
9. Country Rule Set Validation: Check fields like Street Name, Street Number, Region, P.O. Box, and Postal Code to ensure compliance with the mandatory requirements defined for each country.
10. Use an External API to validate City Code and Postal Code values.