OMG API Debug Logging: - Log full URL being called - Log API key (first 20 chars for security) - Log HTTP response code - Log response body (first 500 chars) - Log campaign number and business area extraction - Log business unit mapping result ApplicationLogger Class: - Structured JSON logging to logs/application.log - Track all actions: master_asset_submission, global_to_local_transform, box_upload - Capture user email, timestamp, IP address, user agent - Methods for reporting: getRecentLogs(), getLogsByAction(), getLogsByUser() - Generate statistics: total actions, by user, by action, errors Email Configuration: - Configured SMTP via Mailgun (smtp.mailgun.org:587) - Using twist@mail.dev.oliver.solutions - Emails sent to logged-in user This enables full audit trail and troubleshooting capability. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| css | ||
| js | ||
| .gitignore | ||
| .htaccess | ||
| ApplicationLogger.php | ||
| AuthMiddleware.php | ||
| BoxService.php | ||
| composer.json | ||
| config.php | ||
| CSVTransformer.php | ||
| date-form.html | ||
| download-all-csv.php | ||
| download-csv.php | ||
| EmailService.php | ||
| get-csv-preview.php | ||
| Global 2 Regional AC Ingest - LOreal.blueprint (1).json | ||
| global-to-local.php | ||
| header.php | ||
| index.php | ||
| OMGService.php | ||
| process-csv.php | ||
| Project_1601654_mediaBookings.csv | ||
| README.md | ||
| submit.php | ||
| test-csv.php | ||
| test-process.php | ||
| test-process2.php | ||
| test-simple.php | ||
| upload-to-box.php | ||
| validate-box.php | ||
L'Oréal OMG Assistant Global
A comprehensive PHP web application for L'Oréal campaign asset management with two main tools:
- Master Global Asset Submission - Submit Box assets with metadata extraction
- Global to Local - Transform global campaign CSVs into regional market CSVs
Features
Master Global Asset Submission
- Box API Integration: Real-time validation and preview of Box folders
- Auto-population: Master Campaign Number automatically retrieved from Box folder hierarchy
- Nested Folder Display: Recursive 3-level deep folder structure with expand/collapse
- Folder Validation: Ensures folder is named "SUPPLIED_ASSETS"
- Webhook Integration: Submit data to Make.com with response handling
Global to Local CSV Transformation
- Multi-Stage Processing: Visual progress tracker through 6 processing stages
- 16 Regional Markets: Automatically creates CSV files for 16 ISO codes (en-GB, es-ES, pt-PT, etc.)
- OMG Integration: Looks up business unit from OMG API (optional for testing)
- Date Transformation: Parses dates, adds 1 month, formats DD/MM/YYYY
- Preview All Files: Dropdown selector to preview each of 16 CSVs individually
- Download Options: Download individual files or all 16 as ZIP
- Error Reporting: Detailed error messages at each stage with actionable guidance
- Email Notifications: Mailgun integration for process notifications
Shared Features
- SSO Authentication: Microsoft Azure AD SSO with local development mode
- User Tracking: Email tracking for all submissions
- Responsive Design: Modern UI with Montserrat font and L'Oréal brand colors (Black #000000, Yellow #FFC407)
- Comprehensive Error Handling: Clear error messages with actions at every step
Requirements
- PHP 7.4 or higher
- Composer
- Box JWT credentials
- Web server (Apache/Nginx) or MAMP for local development
Installation
1. Install Dependencies
composer install
2. Configuration
The application uses config.php for all configuration:
Local Development Mode (Default)
'sso' => [
'enabled' => false, // Local mode
'local_user' => [
'name' => 'Dave Porter',
'email' => 'daveporter@oliver.agency'
]
]
Production Mode with SSO
'sso' => [
'enabled' => true, // Enable SSO
'tenant_id' => 'your-azure-tenant-id',
'client_id' => 'your-azure-client-id'
]
3. Box JWT Configuration
The Box JWT configuration file (43984435_77m2ujl3_config.json) must be present in the root directory. This file is already configured and should not be committed to version control (it's in .gitignore).
4. Webhook Configuration
The webhook is pre-configured in config.php:
'webhook' => [
'url' => 'https://hook.us1.make.celonis.com/ddxrhuykysnbxqvb25uxsg0pjngqytiv',
'api_key' => 'E4P9923eBaUTKrEr.iqvHtVHcZ6L!WH'
]
5. Global to Local Configuration
Configure regional transformation settings in config.php:
'global_to_local' => [
'output_box_folder_id' => 'XXXXXXXXX', // Set Box output folder ID
'max_file_size' => 5242880, // 5MB max
'iso_codes' => [ // 16 target markets (editable)
'en-GB', 'es-ES', 'pt-PT', 'en-IE', 'fr-CH', 'de-AT',
'de-DE', 'cs-CZ', 'hu-HU', 'sk-SK', 'da-DK', 'fi-FI',
'nb-NO', 'sv-SE', 'en-NN', 'de-CH'
],
'business_unit_map' => [ // 19 business unit mappings
'VICHY' => 'VICHY',
'LA ROCHE' => 'LA ROCHE',
// ... see config.php for complete list
]
]
6. OMG API Configuration (Optional)
For production use with OMG business unit lookup:
'omg_api' => [
'base_url' => 'https://api2.omg.oliver.solutions/loreal/v1',
'api_key' => 'YOUR_OMG_API_KEY', // Add API key here
'timeout' => 30
]
To enable OMG API in production, uncomment lines 113-172 in process-csv.php.
7. Email Notifications (Optional)
Configure Mailgun for email notifications:
'email' => [
'enabled' => true,
'service' => 'mailgun',
'from' => 'admin@oliver.solutions',
'domain' => 'mail.dev.oliver.solutions',
'mailgun_api_key' => 'YOUR_MAILGUN_KEY' // Add API key here
]
Project Structure
Loreal-master-Entry/
├── config.php # Application configuration
├── AuthMiddleware.php # SSO authentication handler
├── BoxService.php # Box API integration
├── index.php # Main form page
├── validate-box.php # AJAX endpoint for Box validation
├── submit.php # Form submission handler
├── css/
│ └── styles.css # Application styles
├── js/
│ └── app.js # Frontend JavaScript
├── vendor/ # Composer dependencies
└── 43984435_77m2ujl3_config.json # Box JWT config (not in git)
Usage
Local Development (MAMP)
- Place the project in your MAMP
htdocsdirectory - Ensure
config.phphas'enabled' => falsefor SSO - Access via
http://localhost:8888/Loreal-master-Entry/
Production Deployment
- Upload to Apache server
- Update
config.php:- Set
'enabled' => truefor SSO - Add Azure tenant and client IDs
- Set
'debug' => false
- Set
- Ensure
.htaccessis configured if needed - Verify Box JWT config file is present
Workflow Overview
This application streamlines the process of submitting L'Oréal campaign assets stored in Box by automatically extracting metadata and sending it to downstream workflows via Make.com webhook.
Purpose
When campaign assets are uploaded to Box, this tool:
- Validates the folder structure
- Extracts campaign metadata from Box folder hierarchy
- Catalogs all submitted assets (files and folders)
- Sends structured data to Make.com for further processing
- Tracks submission dates and user information
Box Folder Structure Requirements
The application expects a specific Box folder hierarchy:
📁 [Campaign Number] (e.g., "123456") ← Master Campaign Number (extracted)
└─ 📁 CAMPAIGN_ASSETS
└─ 📁 SUPPLIED_ASSETS ← User submits this folder's Box ID
├─ 📁 Images/
├─ 📁 Videos/
└─ 📄 files...
Critical Validation: The submitted folder MUST be named "SUPPLIED_ASSETS" or the workflow will fail.
Data Extraction
The application extracts and processes the following data:
From Box API:
- Master Campaign Number: Folder name two levels up (the campaign number folder)
- Master Campaign ID: Box folder ID two levels up
- Folder Structure: Complete recursive listing of all files and subfolders (up to 3 levels deep)
- Asset Count: Total number of files and folders
From User Input:
- Box ID: The Box folder ID for SUPPLIED_ASSETS
- Supply Date: When assets were supplied (formatted as DD/MM/YYYY 00:00)
- Live Date: Campaign go-live date (formatted as DD/MM/YYYY 00:00)
- End Date: Campaign end date (formatted as DD/MM/YYYY 00:00)
From System:
- User Email: Email of the person submitting (from SSO or local config)
- User Name: Full name of submitter
- Submission Timestamp: When the form was submitted
Complete Workflow Steps
Step 1: User Authentication
- Local Mode: Automatically authenticated as
daveporter@oliver.agency - Production Mode: User logs in with Microsoft Azure AD SSO
Step 2: Box ID Entry
- User navigates to the SUPPLIED_ASSETS folder in Box
- User copies the Box folder ID from the URL
- User enters the Box ID into the form
- User clicks "Lookup" button
Step 3: Box Validation (validate-box.php)
- Authenticate with Box: Generate JWT token using Box app credentials
- Retrieve Folder Info: GET
/folders/{boxId}from Box API - Validate Folder Name: Check if folder name is "SUPPLIED_ASSETS" (case-insensitive)
- ❌ If not: Stop immediately with error message
- ✅ If valid: Continue to next step
- Get Parent Folder: Retrieve the parent of SUPPLIED_ASSETS (CAMPAIGN_ASSETS)
- Get Grandparent Folder: Retrieve the parent of CAMPAIGN_ASSETS (Campaign Number)
- Extract Campaign Data:
- Master Campaign Number = Grandparent folder name
- Master Campaign ID = Grandparent folder ID
- Recursively Fetch Contents: Get all files/folders inside SUPPLIED_ASSETS (3 levels deep)
- Return Preview Data: Send back to frontend for display
Step 4: Preview Display
Frontend displays in right column:
- Master Campaign Number
- Master Campaign ID
- Folder Name (SUPPLIED_ASSETS)
- Total item count
- Expandable/collapsible folder tree showing all nested contents
Step 5: Date Entry
User fills in three required dates:
- Supply Date (when assets were provided)
- Live Date (campaign launch)
- End Date (campaign finish)
Step 6: Form Submission (submit.php)
- Validate Form Data: Ensure all fields are present
- Format Dates: Convert to DD/MM/YYYY 00:00 format
- Prepare Webhook Payload:
{
"userEmail": "user@example.com",
"userName": "John Doe",
"boxId": "312657997260",
"masterCampaignNumber": "123456",
"masterCampaignId": "311743237672",
"supplyDate": "24/03/2025 00:00",
"liveDate": "31/03/2025 00:00",
"endDate": "07/04/2025 00:00",
"boxContents": {
"folderName": "SUPPLIED_ASSETS",
"totalItems": 45,
"folders": [
{
"id": "123",
"name": "Images",
"type": "folder",
"contents": {
"folders": [...],
"files": [...]
}
}
],
"files": [
{
"id": "456",
"name": "readme.txt",
"type": "file"
}
]
},
"submittedAt": "2025-11-17 19:58:45"
}
Step 7: Webhook Integration (Make.com)
- Send to Make.com: POST to webhook URL with
x-make-apikeyheader - Receive Response: Get status and any processing results
- Display to User:
- ✅ Success: "Submission successful" + webhook response
- ❌ Error: Show error message with details
Data Flow Diagram
User (Browser)
↓
[1] Enter Box ID → Click "Lookup"
↓
validate-box.php
↓
Box API (JWT Auth)
↓ (Folder Info + Contents)
validate-box.php
↓ (JSON Response)
Browser Preview Panel
↓
[2] User Fills Dates → Click "Submit"
↓
submit.php
↓
Make.com Webhook
↓ (Response)
submit.php
↓ (Success/Error)
User Sees Result
What Happens After Submission
The webhook sends the structured data to Make.com, which can then:
- Trigger downstream automation workflows
- Update campaign management systems
- Notify relevant team members
- Archive submission records
- Integrate with other L'Oréal systems
Error Handling
The application includes comprehensive validation at each step:
Box Validation Errors:
- Invalid Box ID (404)
- Folder not named "SUPPLIED_ASSETS"
- Box authentication failure
- Network/API errors
Form Validation Errors:
- Missing required fields
- Invalid date formats
- Box ID not validated before submission
Webhook Errors:
- Webhook unreachable
- Authentication failure (API key)
- Timeout (>30 seconds)
- Non-200 response codes
All errors are logged and displayed to the user with actionable messages.
Global to Local Workflow Details
Purpose
Transform a single global campaign CSV (with English language) into 16 separate regional CSVs, one for each target market.
Input CSV Requirements
- Format: Comma-delimited with headers
- Excel Compatibility: Supports
Sep=,prefix (automatically removed) - Required Columns: Number, Title, Category, Media, Supply date, Live date, End date, Language, Country
- Filename Pattern:
Project_{CampaignNumber}_*.csvor*_{CampaignNumber}_*.csv
Transformation Process
Stage 1: Upload & Validate
- File type validation (.csv required)
- File size check (max 5MB)
- CSV structure validation
Stage 2: Parse CSV
- Remove Excel separator hint
- Parse headers and data rows
- Validate required columns exist
Stage 3: Extract Campaign Number
- Parse from filename (e.g., "Project_1601654_mediaBookings.csv" → "1601654")
- Validate numeric format
Stage 4: OMG API Lookup (Optional - Currently Skipped for Testing)
- Call OMG API:
GET /loreal/v1/getProject?project_number={campaign} - Extract business_area from response
- For testing: Uses "TESTING" as business unit
Stage 5: Map Business Unit
- Convert business area to short code (VICHY, LA ROCHE, LPP, etc.)
- 19 business unit mappings configured
- Falls back to "ERROR" if unrecognized
Stage 6: Transform Data
- Create 16 separate CSV files (one per ISO code)
- For each ISO code:
- Copy all input rows
- Replace Language field with ISO code (e.g., "en-GB")
- Replace Country field with country code (e.g., "GB")
- Transform dates: Parse → Add 1 month → Format DD/MM/YYYY
- Keep all other fields intact
ISO Codes (16 Markets)
Configured in config.php:
en-GB, es-ES, pt-PT, en-IE, fr-CH, de-AT, de-DE, cs-CZ,
hu-HU, sk-SK, da-DK, fi-FI, nb-NO, sv-SE, en-NN, de-CH
Output Files
- File Count: 16 (one per ISO code)
- Naming Pattern:
OMG{campaign}_GlobalACIngest_{BU}-{Country}_{timestamp}.csv - Example:
OMG1601654_GlobalACIngest_TESTING-GB_1700253845.csv - Destination: Box folder configured in
config.php(output_box_folder_id)
Preview & Download Options
Preview Features:
- Summary dashboard (input rows, output files, campaign info)
- Dropdown selector to view any of the 16 CSV files
- Shows ALL rows in scrollable table
- Real-time switching between files
Download Options:
- Download Current File: Download the currently previewed CSV
- Download All Files (ZIP): Get all 16 CSVs in a single ZIP archive
- Files available before committing to Box upload
User Approval Workflow
- Upload CSV file
- Watch progress through 6 automated stages
- Review summary and any warnings
- Preview each of the 16 output files
- Download to verify (optional)
- Click "Approve & Upload to OMG" to finalize
- All 16 files uploaded to Box output folder
Error Handling Examples
Upload Error:
❌ File Validation Failed
Invalid file type. Expected .csv, got .xlsx
Action Required: → Please upload a valid CSV file (max 5MB)
Parse Error:
❌ CSV Parsing Failed
Missing required columns
Missing: Supply date, Live date, End date
Action Required: → Verify you uploaded the correct CSV file format
Campaign Error:
❌ Campaign Number Not Found in Filename
Expected pattern: *_CAMPAIGN#_*.csv, got: GlobalFile.csv
Action Required: → Rename file to include campaign number (e.g., Global_123456_Assets.csv)
Date Error:
❌ Data Transformation Failed
Row 5: Invalid Live date format - Unable to parse '32/13/2025'
Action Required: → Use format DD/MM/YYYY or DD MMM YYYY
All errors are logged and displayed to the user with actionable messages.
API Endpoints
Global to Local Endpoints
process-csv.php
- Method: POST (multipart/form-data)
- Input: CSV file upload
- Output: Processed data with progress tracking
- Returns: 16 CSV files info + preview
get-csv-preview.php
- Method: GET
- Parameters:
fileIndex(0-15) - Output: Full CSV preview for selected file
download-csv.php
- Method: GET
- Parameters:
file(file index) - Output: Single CSV file download
download-all-csv.php
- Method: POST
- Output: ZIP file containing all 16 CSVs
upload-to-box.php
- Method: POST
- Action: Uploads all 16 CSVs to Box output folder
- Returns: Upload confirmation + folder URL
Master Global Asset Submission Endpoints
validate-box.php
Method: POST Content-Type: application/json
Request:
{
"boxId": "123456789"
}
Response (Success):
{
"success": true,
"data": {
"boxId": "123456789",
"folderName": "Asset Folder",
"masterCampaignNumber": "Campaign Name",
"masterCampaignId": "987654321",
"contents": {
"total": 15,
"folders": [...],
"files": [...]
}
}
}
submit.php
Method: POST Content-Type: application/json
Request:
{
"boxId": "123456789",
"supplyDate": "24/03/2025 00:00",
"liveDate": "31/03/2025 00:00",
"endDate": "07/04/2025 00:00",
"boxData": {
"masterCampaignNumber": "Campaign Name",
"masterCampaignId": "987654321",
"contents": {...}
}
}
Response:
{
"success": true,
"message": "Submission successful",
"webhookResponse": {...},
"webhookStatus": 200
}
Security Features
- httpOnly Cookies: Authentication tokens stored securely
- JWT Validation: Box API uses signed JWT for authentication
- Input Sanitization: All user inputs are validated and escaped
- CSRF Protection: SameSite cookie attribute
- XSS Prevention: HTML escaping in frontend
- Sensitive Data: JWT config excluded from version control
Troubleshooting
Box Authentication Fails
- Verify
43984435_77m2ujl3_config.jsonis present - Check private key passphrase is correct
- Ensure Box app has proper permissions
SSO Not Working
- Verify Azure tenant and client IDs
- Check redirect URI matches your domain
- Ensure HTTPS is enabled in production
Webhook Fails
- Check webhook URL is accessible
- Verify API key is correct
- Check webhook timeout setting (default 30s)
Development
Testing Locally
Set SSO to disabled in config.php for instant local access without Azure AD setup.
Debugging
Enable debug mode in config.php:
'app' => [
'debug' => true // Shows detailed error messages
]
Note: Disable in production!
Author
Dave Porter (daveporter@oliver.agency)
Repository
https://bitbucket.org/zlalani/loreal-global-kickoff
License
Proprietary - L'Oréal/Oliver Agency