Call Toll Free: 888-623-2374

Request InformationSupport

Installation PunchOut for Magento

Installing PunchOut2Go Module in Magento

The following outlines the installation of the Punchout2go Punchout Connect Magento Module. We want to be supportive in the implementation and testing process. Even if your company is doing the physical install, we want to be talking and helping to make sure everything works as expected.

Changes to expect

The installation process will require the following changes to Magento website. Note: Always backup files prior to installing any magento extension.

  1. Module files will need to be added to your installation.
  2. Fields for UNSPSC and Unit of Measure (UOM) will need to be added to your product.
  3. Fields for UNSPSC and Include in Punchout Index will need to be added to your categories.
  4. A "Punchout Only" CMS page will need to be added
  5. Your theme may require adjustments to conform to your buyer's requirements about elements that should not be available during a punchout session.
  6. Your module will need to be configured.
  7. Your product and/or categories will need to be tagged based on their UNSPSC classification.

Step 1. Install The Module Package

The module package will contain files organized in magento's file structure. This will help you understand where each file goes. You can use the "Magento Connect Manager" to install the package or you can manually unzip the archive and move the below files to their respective locations.

- core module files
app/code/local/Vbw/Punchout/*
- layout xml file
app/design/frontend/base/default/layout/punchout.xml
- design template files
app/design/frontend/base/default/templates/punchout/*
- module initialization config
app/etc/modules/Vbw_Punchout.xml
- punchout2go library
lib/Vbw/* 

Note: if you use the package manager to install the module, you may need to logout then log back in to your admin to be able to access the configuration options in the "System" > "Configuration" > "Punchout2go" area.

Step 2. Add new fields to Product

If your buyer requires UNSPSC and Unit of Measure classifications for each item, Two attribute fields needed to be added to Product. Otherwise some buyers will feel that category level classifications will be sufficient. The extension supports Product Level, Category and Store level classifications.

  • UNSPSC - This classifies the product so the procurement system knows what each product is.
  • Unit of Measure - This identifies the measurement for the quantity of the purchased item.

The names of these fields should be set to "unspsc" and "uom" respectively. Their field names can be configured in if you already have fields representing these values (see module configuration).

You can use your Attribute Manager to create these fields if needed.

Step 3. Add new fields to Categories

Two fields will be added to the Categories when installed through Magento Connect Manager.

  • UNSPSC - This classifies the category to a UNSPSC number. This is required for category exports, in addition products can inherit their classification from the category it belongs to.
  • Include in Punchout Index (In Development) - A level2 Punchout Index catalog can be created and loaded on your buyer's procurement system. This control allows you to include/exclude certain categories that don't naturally have a natural UNSPSC classification.

When the module is loaded for the first time, these fields will be created automatically with the default names of "unspsc" and "punchout_export". Their field names can be configured in if you already have fields representing these values (see module configuration). If you already have a category field with a matching name, the field will not be modified.

Step 4. Add an "Access Restricted" CMS page

A store can be configured to be "Punchout Only". This means that any access without a valid punchout session will send the user to an Access Restricted page. Add a page to your instance through the Magento "CMS" > "Pages" manger. By default the "Punchout Only Url" is set to "access-restricted". The Access Restricted page can be configured per site or store. Simply create pages in your CMS then configure them in the System Configuration Manager (see module configuration).

Step 5. Modifying your theme

By default, the module comes with configuration changes to remove some basic parts of the Magento interface that we have seen procurement systems asking us to remove. These are mainly done through the layout/punchout.xml file. Depending on your theme, these changes may or may not work. Or you may choose to have other parts changed. The rules around modifying aspects of our module are the same as those modifying any other modules. You can override our objects, layout and template files to meet your needs. We HIGHLY recommend including any changes within your theme directory so any updates do not conflict with your changes. See Resource Extension Extending (Developers)

Step 6. Configure The Module

The module can be configured through Magento's "System" > "Configuration" manager. Located under the "Sales" group is a "Punchout2go" section of configuration options. The configuration options have notes about their purposes and uses.

Step 7. Product and Category Classification

If your product does not already use UNSPSC classifications, then you will need to classify your product per the requirements of your buyer.

We suggest at the minimum you select a classification for your store and add it in the System Configuration for the module. As well classify some of your top most categories. If a product does not have a specific classifications, it will try to discover classification by reviewing the categories it belongs to.

The UNSPSC list can be found at : http://www.unspsc.org/Search.asp

Understanding Configuration Options

More coming soon... In the meantime, look at Configuring Magento for Punchout or fill out the form below.

We're glad you are here. Let us help you integrate!

Request more information about PunchOut2Go and our Solutions.