Add-On Content (AOC) Purchase Confirmation Guide

The following describes the purchase confirmation process for add-on content (AOC) using the Item Management Server (IMAS) and the Nintendo eShop. To use IMAS, fill out an E-Commerce Feature Usage Application on Online Title Management System (OMAS), using your title information and paying careful attention to the E-Commerce section. For information about how to apply for access to IMAS, see Important: IMAS Usage in the Wii U Announcements on your local Nintendo developer support group website.

For information about the IMAS e-commerce development server migration from DEV5 to DEV3 that took place in March 2013, see IMAS E-Commerce System Release Date and Transition Period in the Wii U Announcements on your local Nintendo developer support group website.

Terminology

Term Definition
Add-On Content Add-On Content is purchased by users from Nintendo eShop. After purchase, it may be used in applications. Add-on content instances are identified by an index beginning with a one (1).
content item A content item is one unit of data that a user purchases from Nintendo eShop. It consists of a single directory in the content directory of a submission, and all of the files and folders in that directory. The maximum size for a single content item is 4 GB. Content items may contain multiple files and/or actual in-game items. For example, one content item may add a new sword or a sword and shield.
item sets Item sets are purchasable units on eShop. An item set must contain at least one content item and no more than 64 content items. For example, a shield and a helmet may be individually purchasable content items, and an armor item set may contain both the shield and the helmet content items. Creating and managing item sets is performed entirely in IMAS. You do not need to duplicate content items that are included in multiple item sets.
catalog Groups of items or content are managed as catalogs. Catalogs are the units in which developers submit add-on content and service items to Nintendo, and the units in which they are eventually released to the eShop. When you add a new catalog, it is created with the status Developing. You may manage one data title and service title as multiple catalogs, and manage associations between each catalog and your items and content. Normally, a catalog transitions through states on its way toward a release. The content and items in each catalog are independent. If you edit the content and items in one catalog, you do not affect any other catalogs.
data title A data title is one submission package to Lotcheck. It is a unique variation of one of the AOC unique IDs for the title. The data title is an archived ROM file that contains metadata content and the add-on content that users purchase. A data title may contain up to 255 content items and be up to 10 GB in size.
metadata content Metadata content stores the name of the add-on content, a description of the add-on content, an icon image, attributes such as the sale price and sale period, and other information. You may generate metadata using ctr_makeMetaDataContent, based on the content information (XML) that is exported from IMAS.
title_id A title_id is a 64-bit value, usually written in hexadecimal format, that is used for identification. For more information about the structure of a title ID, see Title ID and Unique ID Overview.
AOC unique ID AOC unique IDs are used to reference groups of data titles which may be accessed by an application. To provide an application access to all content items released with that AOC unique ID, enter the AOC unique ID into one of the add_on_unique_id# fields in the meta.xml file for the application. An AOC unique ID is five-digit hexadecimal number that is provided by NOA Submissions and NOE Lotcheck. An AOC unique ID is part of the title ID for a data title. With the variation portion of the title ID, a AOC unique ID may have up to 256 data titles. For example, if the title ID for a data title is “0005000C154321FF,” the AOC Unique ID is “54321,” and the variation (the least significant byte) is “FF” (255).

AOC Purchase Confirmation Process

DEV3, the e-commerce development server, must be provisioned for your application before you may purchase AOC. Nintendo provisions DEV3 based on the e-commerce data in your OMAS application.

  1. Log in to IMAS and configure settings for your title. For information about logging in to IMAS and how to set up your application, see IMAS Login and Settings Process.
  2. Perform the mastering process for the title that will be using the AOC.
    1. Build with the specification NDEBUG=TRUE.
    2. Use the Application Configuration Tool to set the appropriate Title ID and TIN for your application. The TIN is displayed in OMAS after your e-commerce features are approved.
  3. Install the Wii U MenuChanger on your devkit (CAT-DEV or CAT-R). Ensure that you install the most recent version.
  4. To connect to DEV3, configure the DNS settings on the devkit.
    1. In the System Config Tool, on the Root Menu, select Network Setting.
    2. On the Network Setting menu, select the profile that you want to use to connect to DEV3, and then select Edit Config.
    3. On the Edit Config menu, select IP Address Setting.
    4. Set the Primary DNS address to 205.166.76.187.
    NOTE:
    The DEV5 e-commerce development server is no longer used.
  5. Purchase and download your AOC on the development eShop.
    1. In the Wii U Menu, start the application, and then, in the application, open the HOME Menu.
    2. Select the eShop icon. The eShop icon is an orange shopping bag.
    3. Follow the on-screen instructions to purchase and download your AOC.
  6. After confirming that everything behaves properly, master the application, and then submit the mastered copy and the data title to NOA Submissions. For information about mastering your application and submitting it to Nintendo, see Wii U AOC From Start to Finish.
    1. Notify NOA Submissions after you submit your catalog.
    2. There are some limitations on when you may submit your catalog. If your catalog submission fails, contact your local Nintendo developer support group.
    3. Until Lotcheck reaches a certain point in their testing, you are not unable to submit your catalog, and will receive an error if you try to submit it. This restriction does not apply if Lotcheck has already completed testing for your data title and you then submit your catalog only.
NOTE:
For the DEV5 environment, request that Nintendo whitelist your IP address before attempting to access the eShop from a devkit. This is not required for the DEV3 environment.

IMAS Login and Settings Process

This section provides an overview of the IMAS login and settings process. For more information, see the IMAS Operations Manual for Developers on your local Nintendo developer support group website.

  1. An OMAS administrator, with an OMAS role of "Company Administrator" or "Company Manager," accesses IMAS.
    • DEV3 server environment IMAS: https://imas-dev3.shop.nintendowifi.net/imas4/login/
    • DEV5 server environment IMAS: no longer in use. Use DEV3 instead.
  2. The OMAS administrator may grant himself or herself the necessary permissions.
  3. The OMAS administrator may grant login and edit rights, one account at a time, to the non-administrative OMAS accounts in their own group or company. The affected user must log in again for newly granted rights to take effect.
  4. Titles with complete server settings are viewable for accounts with properly configured OMAS and IMAS user rights.
  5. You may configure the settings for your title from the Master Title menu item.
    • After setting the title name, description, and banner image, perform a save, request approval, and approve. The approval status for the title changes to approved.
  6. Create a data title.
    • Some points to note when creating a data title:
      • Use the Application Configuration Tool to set the correct Title ID.
      • Master the data title with makecfdownloadimage.sh, and then create the data in compressed .zip format. For more information, see 8.2.2 Cafe ROM File in the IMAS Operations Manual for Developers on your local Nintendo developer support group website.
  7. Upload the data title.
    • To access the upload tool, your IP address must be added to a whitelist.
      • To add your IP address to the whitelist, post on the OMAS Message Board for your title or contact your local Nintendo developer support group.
      • These IP addresses are managed separately from the IP addresses in your OMAS company information.
  8. Configure the language-specific and country-specific information for your data title.
    • For more information, see 4.2 Data Title Management in the IMAS Operations Manual for Developers on your local Nintendo developer support group website.
  9. Register your content and items, and then Apply the item information.

Access Restrictions

  1. Access restrictions for logging into IMAS from a PC
    • If IP restrictions are enabled, access restrictions are set according to OMAS company information IP address restrictions.
  2. IP restrictions for accessing the IMAS upload tool (the system for uploading IMAS data titles) from a PC
    • You must request access for your IP address via your OMAS bulletin board or your local Nintendo developer support group.
  3. Restrictions for accessing the eShop from a devkit
    • To be whitelisted, you must request access for your IP address via the OMAS bulletin board or your local Nintendo developer support group. However, this restriction applies only to the previous DEV5 server environment.

For items #2 and #3 above, one whitelist is shared for PCs and devkits. We may not set different IP address restrictions for each type of device.

IMAS Operations Manual for Developers Errata

The following errata refer to Version 1.3 (2012/11/26).

IMAS Item Description Format

AOC Purchase Testing Errors

The following errors may occur in the eShop or on the Wii U Menu.

Frequently Asked Questions

  1. After starting an AOC download, when I view the Download Management Screen, it shows a dummy icon and name.
    • In the development environment, dummy data is set for these values.
    • In the production environment, the data shown here is the data that you configured in the mastered wumad file that you submitted.
  2. In the eShop, the text "WIIU_DL" or "WIIU_DISC" is shown on the software details page.
    • This is normal. In the development environment, this text is shown on the details page above the title name and release date.
  3. When purchasing AOC in the eShop, the ratings information is not displayed properly, and some icons do not show up. Is this acceptable?
    • In the development environment, the ratings information and certain icons are not properly displayed.
      • Ratings information: you may see a blue "?" box, or a rating is displayed that you did not set for your title.
      • Certain icons: you may see a blue "?" box. This includes the icon that is displayed for your software on the final purchase confirmation screen. The final purchase confirmation screen is the screen which notifies you that pressing the Purchase button pays for the item. In the production environment, a special promotional icon that is submitted for the eShop separately, is displayed.
  4. How do I add more money to my e-cash balance?
    • Use one of the following dummy credit cards:
          Visa MasterCard
        Number: 4444-4444-4444-4448 5454-5454-5454-5454
        Expiration date: 12/2030 12/2030
        Security code: 123 123
        Zip code: any any
  5. How do I reset the purchase history for an item?
    • In the Wii U Menu, delete your network account and create another one. About an hour after you delete your network account, your eShop rights data for purchased items is deleted, and then you may repurchase the same items.
    • If you are checking the purchase process in multiple regions, run the Device Account Deletion Tool. This deletes your network account and resets your eShop purchase history.
      • The Device Account Deletion Tool is included in the Wii U Menu Changer 1.3 (and later). The tool may be found in the $CAFE_ROOT/system/bin/ghs/cafe/app/drm/DeleteDeviceAccount/NDEBUG/DeleteDeviceAccount_p01 folder.
      • Notes for running the Device Account Deletion Tool:
        • Run the tool on your console before changing the region.
        • Ensure that the network accounts that you use on the devkit are still linked.
        • Ensure that all account passwords are saved in the Wii U Menu (for auto-login).
  6. What should I be aware of when uploading data titles in IMAS?
    • When uploading and publishing data titles, increment the remaster version by 1.
    • To reset the remaster version to 0:
      • Perform a revert operation on the server.
      • Run the Device Account Deletion Tool. (For more information, see FAQ #5.)
  7. What should I be aware of when switching from local-based development to online-based development and vice-versa?
    • Ensure that you do not use both types of data title acquisition (importing locally via SD card and purchasing online through the eShop) on a single devkit, which installs multiple versions of the same data title.
    • Before switching from one method to the other, use the Uninstall command from the System Config Tool on the devkit to delete installed data titles. This also deletes all rights information linked to data titles.
    • When you switch from online testing to local environment testing, run the Device Account Deletion Tool. (For more information, see FAQ #5.)
  8. Is it possible to use HTML tags in IMAS catalog data?
    • <br> tags may be used.
    • <font> tags may be used. Ensure that they are displayed properly on actual Wii U hardware.
    • Do not use any other HTML tags, because they are not supported.
  9. What should I be aware of when switching from the DEV5 server environment the DEV3 server environment?
    • Ensure that you obtain a new network account.
    • Delete the network account you were using for the DEV5 environment ahead of time.
    • Set the DNS setting for the devkit to 205.166.76.187.

Questions

If you have any questions, contact your local Nintendo developer support group, or post questions on the Message Board for your title on OMAS.

Revision History

2013/06/01 Convert PDF files to HTML.


CONFIDENTIAL