Installation

This page gives a practical installation baseline for a first production-ready Punchout setup.

1. Install and enable the module

Install MageB2B_Punchout in your Magento instance and run your standard Magento setup commands:

1. module enable
2. setup upgrade
3. cache clean

If your environment requires compilation, run DI compile before final testing.

2. Verify required routes

Confirm that these routes are available:

• /punchout/oci/login
• /punchout/cxml/setup
• /punchout/oci/transfer
• /punchout/cxml/transfer
• /punchout/health/ping

3. Verify admin menu entries

Confirm these admin sections are visible and accessible:

• Punchout Buyers
• Punchout Mappings
• Punchout Trace
• Punchout Simulator
• Stores >Configuration > Punchout

If a menu is missing, verify ACL role permissions for the current admin user.

4. Set base configuration

In admin configuration, set:

• Punchout Enabled = Yes
• Sandbox Mode = Yes for non-production, No for production
• security options (signature mode, signature secret, IP policy)
• trace retention policy (recommended 14 to 30 days for rollout)

5. Create the first buyer and mapping profile

Create one buyer profile and one mapping profile for your first target protocol. Link the mapping profile to the buyer.

Recommended first setup:

• protocol: oci or cxml
• buyer id: external procurement identity, for example BUYER_TEST_001
• mapping profile: start from template, then adjust only partner-specific fields

6. Validate with simulator

Run one simulator scenario and verify request payload, signature behavior, and expected transfer output.

Minimum acceptance checks:

• inbound request is authenticated
• punchout context token is created
• cart transfer returns expected mapped fields
• trace entry contains correlation id and endpoint details

7. Continue to go-live hardening

After the first successful simulation, continue with:

• Configuration
• Go-Live Checklist