Content Delivery Server 5.1 Content Developer Guide

Transcription

1 Sun Java System Content Delivery Server 5.1 Content Developer Guide Sun Microsystems, Inc. Part No.: June 2008 Submit comments about this document at:

2 Copyright 2008 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed at patents and one or more additional patents or pending patent applications in the U.S. and in other countries. U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Use is subject to license terms. This distribution may include materials developed by third parties. Sun, Sun Microsystems, the Sun logo, Java, and J2ME are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. The Adobe logo is a registered trademark of Adobe Systems, Incorporated. Products covered by and information contained in this service manual are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited. DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. Copyright 2008 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, Etats-Unis. Tous droits réservés. Sun Microsystems, Inc. détient les droits de propriété intellectuels relatifs à la technologie incorporée dans le produit qui est décrit dans ce document. En particulier, et ce sans limitation, ces droits de propriété intellectuelle peuvent inclure un ou plus des brevets américains listés à l adresse patents et un ou les brevets supplémentaires ou les applications de brevet en attente aux Etats - Unis et dans les autres pays. L utilisation est soumise aux termes de la Licence. Cette distribution peut comprendre des composants développés par des tierces parties. Sun, Sun Microsystems, le logo Sun, Java, et J2ME sont des marques de fabrique ou des marques déposées de Sun Microsystems, Inc. aux Etats- Unis et dans d autres pays. Le logo Adobe est une marque déposée de Adobe Systems, Incorporated. Les produits qui font l'objet de ce manuel d'entretien et les informations qu'il contient sont regis par la legislation americaine en matiere de controle des exportations et peuvent etre soumis au droit d'autres pays dans le domaine des exportations et importations. Les utilisations finales, ou utilisateurs finaux, pour des armes nucleaires, des missiles, des armes biologiques et chimiques ou du nucleaire maritime, directement ou indirectement, sont strictement interdites. Les exportations ou reexportations vers des pays sous embargo des Etats-Unis, ou vers des entites figurant sur les listes d'exclusion d'exportation americaines, y compris, mais de maniere non exclusive, la liste de personnes qui font objet d'un ordre de ne pas participer, d'une facon directe ou indirecte, aux exportations des produits ou des services qui sont regi par la legislation americaine en matiere de controle des exportations et la liste de ressortissants specifiquement designes, sont rigoureusement interdites. LA DOCUMENTATION EST FOURNIE "EN L ETAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L APTITUDE A UNE UTILISATION PARTICULIERE OU A L ABSENCE DE CONTREFACON. Please Recycle

3 Contents Using the Developer Portal 1 Content 1 Content Type Submissions 2 Editions 3 Additional Property Fields 4 Content Hosting 4 Registration 5 Registering 5 Submitting Content 6 Submission Guidelines 7 Submitting New Content with the Wizard 7 Submitting Content Editions With the Wizard 13 Submitting Packaged Content 16 Submission Verification Notices 18 Packaging Content 18 Creating the Package 18 Creating the Content File 19 Creating the Support Files 20 Creating a Content Submission File 20 iii

4 Creating a Provisioning File 34 Creating the Compression File 37 Packaging Editions 39 Packaging External Content 40 Packaging Live Streamed Content 42 Submitting Content to the Content Aggregator Interface 44 Creating the XML File for the Content Aggregator Interface 44 Posting the XML File 51 Managing Submitted Content 52 Viewing Submissions 52 Searching for Submitted Content 53 Performing a Simple Search 53 Performing a Field Search 54 Displaying Additional Content Information 55 Displaying a Specified Number of Content Rows 56 Displaying A Specified Number of Matches 57 Sorting the Content List 58 Search Fields 59 Advanced Searching 64 Simple Word or Phrase Search 64 Property Fields Search 65 Multiple Field Search 65 Range Search 66 Wildcard Search 66 Special Characters Search 66 Exact Search 67 Search Using Boolean Operators 68 Relative Time Period Searches 69 iv Content Developer Guide June 2008

5 Proximity Searches 69 Relevancy Searches 70 Editing Submissions 70 Editing the Content Price 71 Editing Previews 71 Updating Content 73 Update Guidelines 74 Updating Locally Stored Content 76 Updating Externally Hosted Content 78 Packaging Updates 79 A. Submission Examples 81 Original Content File as Preview 81 Edition with Two Preview Sets 82 Content with Separate Preview File 83 Edition with Separate Preview Files 84 Content with Multiple Preview Files 85 Edition with Multiple Preview Files 86 Index 87 Contents v

6 vi Content Developer Guide June 2008

7 Figures FIGURE 1 Editions Field Showing Updated Content 76 FIGURE 2 Editions Field Showing Updated Status 76 vii

8 viii Content Developer Guide June 2008

9 Tables TABLE 1 Pricing Model Definitions 10 TABLE 2 Summary of Support Files 20 TABLE 3 Required Top-Level Content Descriptor Tags 21 TABLE 4 Content Descriptor Tags 22 TABLE 5 Possible Capability Definitions 25 TABLE 6 Web Descriptor Tags 27 TABLE 7 Provisioning File Tags 34 TABLE 8 Compression File Contents for ZIP or PAR Files 38 TABLE 9 Example of the First Download Pricing Model in Price Descriptor 46 TABLE 10 Example of the Every Download Pricing Model in Price Descriptor 46 TABLE 11 Example of the Per Interval Pricing Model in Price Descriptor 47 TABLE 12 Example of the Per Period Pricing Model in Price Descriptor 47 TABLE 13 Example of the Per Subscription Pricing Model in Price Descriptor 48 TABLE 14 Example of the Usage Pricing Model in Price Descriptor 48 TABLE 15 Search Fields for Content 60 TABLE 16 Search Fields for Content Editions 63 TABLE 17 Search Operators 68 TABLE 18 Content Status Types in Catalog Manager 74 TABLE 19 Content Updating Guidelines 75 ix

10 x Content Developer Guide June 2008

11 Code Examples CODE EXAMPLE 1 Content Submission File for New Application Content 30 CODE EXAMPLE 2 Content Submission File for New Ring Tone Content 31 CODE EXAMPLE 3 Content Submission File for a New Locally Hosted Edition 32 CODE EXAMPLE 4 Content Submission File for an Update of Existing Content 33 CODE EXAMPLE 5 Provisioning File Example 36 CODE EXAMPLE 6 Content Submission File for an Externally Hosted New Edition 41 CODE EXAMPLE 7 Content Submission File for Live Streamed Content 43 CODE EXAMPLE 8 XML File for XML-RPC Submission Using PriceDescriptor 49 CODE EXAMPLE 9 XML File for XML-RPC Submission Using PricingOptionID 50 CODE EXAMPLE 10 XML File for XML-RPC Submission Using PricingOptionName 50 CODE EXAMPLE A-1 Content Item Using the Original Content as a Preview 81 CODE EXAMPLE A-2 Edition Using the Original Content as a Preview and a Different Preview for the Web 82 CODE EXAMPLE A-3 Content Item With a Preview Using a Separate File as the Preview 83 CODE EXAMPLE A-4 Edition With a Preview Using a Separate File as the Preview and a Different Preview for the Web 84 CODE EXAMPLE A-5 Content Item with Multiple Previews 85 CODE EXAMPLE A-6 Edition With Multiple Previews 86 xi

12 xii Content Developer Guide June 2008

13 Using the Developer Portal This document describes the purpose and use of the Developer Portal, a web-based interface for submitting content to an operator s Sun Java System Content Delivery Server. The operator makes the content available to subscribers for download to mobile phones and other devices. This chapter covers the following topics: Content - Describes content with respect to Content Delivery Server. Registration - Provides instructions for creating an account with the Developer Portal. Submitting Content - Provides guidelines and instructions for submitting content. Packaging Content - Provides instructions for packaging content for advanced submission. Managing Submitted Content - Provides instructions and guidelines for viewing submitted content, changing descriptive information and pricing for content, searching and sorting content, and updating content files. Content Content is a generic term for any item that a subscriber might want to download to a mobile device. Examples of content are games, business applications, ring tones, and images. Content files are the binary or data files that subscribers can download and use on their devices. For Java technology-based MIDlet applications, content files consist of a Java Application Descriptor (JAD) and a Java Archive (JAR) file per MIDlet. Note that JAD files have the extension.jad and JAR files have the extension.jar. 1

14 If Content Delivery Server is set up to support iappli applications, content files refer to the application descriptor file with the extension.jam and the JAR (.jar) file. Support files are optional files that can be included with content. Support files include a user guide, icons, screen shots, and a preview file. Support files provide subscribers with additional information about your content. A preview is a means for a subscriber to see or hear a sample of a content item. Previews are submitted with editions. A preview file contains a sample of a content item. Sometimes a content file itself can be used as its own preview file. Various formats of preview files for each content type enable subscribers to sample a content item on a web browser or a WAP browser. The preview file must be of a MIME type that is supported by Content Delivery Server and cannot be an application or other type of content that requires more than one source file. A preview set refers to one or more preview files associated with a content edition. When a new edition or an edition update is submitted, it can be associated with the preview set of an existing edition or new preview files can be submitted with the edition to create a new preview set. Content Type Submissions The types of content that you can submit are specified by the operator. To see what content types are supported, start the submission wizard in the Developer Portal (see Submitting New Content with the Wizard on page 7). The Select Content Type field on the first page shows the types of content that Content Delivery Server accepts. The Catalog Manager administrator configures Content Delivery Server to set up either separate or single content type submission. By default, Content Delivery Server is configured for separate content type submissions. The two setups are described as follows: Separate content types - Each format of a content item is submitted individually. Submitting content on a per format basis has the following benefits: Individual formats of content can be submitted and managed individually Defining the metadata and the pricing of content per format (for example, a higher resolution image can be priced higher while a lower resolution image can be priced lower) Providing subscribers with the ability to choose from among compatible content formats For example, suppose a content provider submits a screen saver image, Sunset, of content type image and makes a separate submission of Sunset that has that content type sms_picture. Each format of Sunset has its own metadata and price. 2 Content Developer Guide June 2008

15 Single content types - Content is submitted under one content type. Once the initial content is submitted, editions can be submitted for each format of the content. Editions have the same pricing option and preview file, if any, as the original content. Submitting content on a content type basis has the following benefits: Defining the metadata and price for all content formats is done once Publishing and stocking for all content formats is done once Choosing and delivering compatible content formats to subscribers is automatically done for them For example, suppose a content provider has a ring tone, Melody, to submit. The content is submitted with the ringtone content type. After the content is submitted, the content provider then submits an edition of Melody that has a monophonic format. The monophonic version of Melody is automatically assigned the metadata and price of the initial submission. The submission of separate or single content type is determined by the Catalog Manager. The default configuration is to have separate content types. Editions Due to the multitude of devices available with varying capabilities, it can be difficult to produce content of the highest quality that can be used on all devices without customization. Creating customizations of your content to target specific devices or devices with specific capabilities enables you to reach a larger customer base and provide a more satisfying user experience. However, it is inefficient to treat each customization as different items of content. Content Delivery Server handles this situation with editions. You can submit multiple editions for a single item of content. All editions of the item share the same description, category, pricing information, and support files. The editions differ in the device capabilities that they require. Editions can also have custom fields that are unique to the edition. When subscribers view the list of content available to them, they see only one entry for each item. Content Delivery Server determines which edition is appropriate for the subscriber based on the capabilities of the subscriber s device. An edition is different from an update. An update refers to the features and fixes of content (see Updating Content on page 73). An edition refers to the targeted device or device capabilities, such as Push type. The following items are examples of editions: 3

16 StockTicker - The initial edition of a basic application that requires no special features. This is labeled version 1.0. StockTickerLargeScreen - An edition of StockTicker customized for devices with large screens. This edition provides the same capabilities as StockTicker and is also labeled version 1.0. StockTickerSiemens - An edition of StockTicker optimized for use with a Siemens device. This edition provides the same capabilities as StockTicker and contains fixes specific to the Siemens device. It is labeled version 1.1. For information on submitting content editions, see Submitting New Content with the Wizard on page 7. Additional Property Fields In addition to the standard properties, such as Display Name, Short Description, and Preview, a content item or edition can have additional properties, custom fields, that are determined by the vendor. These custom fields can be required or optional. If required, you must a provide values for them or your submission is rejected by the Catalog Manager. You can edit the values of these fields just as you can the other properties of a content item or edition. Content Hosting Content Delivery Server can manage both externally hosted and locally stored content. You can upload the content to Content Delivery Server for local storage, or you can submit a URL that points to content files stored on your server. Content stored on your server is referred to as external content. To make changes to the content files for locally stored content, you must submit the modified files to Content Delivery Server. To make changes to external content, you just update the content files on your server. Content Delivery Server automatically gets the updates when a subscriber accesses that content. In either case, the administrator must then accept and publish the changes to make them available to subscribers. Content files are hosted externally. Support files, such as icons and screen shots, are stored locally at Content Delivery Server. A preview file can also be a local file, an externally hosted file, or a copyrighted externally hosted file. 4 Content Developer Guide June 2008

17 Registration Only registered content providers can submit content. The administrator can create an account for you, or you can create your own account by registering through the Developer Portal. Registering To register as a content provider, follow these steps: 1. Go to the Developer Portal at domain is the domain name and port is the port number for Content Delivery Server. This information is provided by the operator. 2. Click New Developers Sign Up Here on the Log In page to display the Developer Registration page. 3. Enter the requested information as follows: Developer Name - Your name or the name of your company. This field is required. Developer URL - The URL that points to information about you or your company. Contact Name - The name of the person to be contacted about content submitted using this account. Contact - The address for the contact person. Contact Phone - The phone number for the contact person. Contact Fax - The fax number for the contact person. Address - The mailing address for the contact person. User Name - The name used for this account. This is the name that you use to log in to the Developer Portal. Password - The password for this account. Confirm Password - The password for this account. Note that required fields are flagged with a red arrow. 4. Review the developer s agreement. This is necessary only if a link to the agreement is displayed at the end of the page. Registering through the Developer Portal indicates that you agree to abide by the terms and conditions stated. 5

18 5. Click Register to complete your registration. 6. Click OK to close the confirmation page and access the Developer Portal home page. When an account is created for you, a developer plan is assigned. This plan specifies the APIs that you can use in the applications that you create for submission. If you use APIs that are not allowed, your content is rejected. The developer plan might restrict other types of content. Contact the operator if you have questions on what is allowed by the developer plan assigned to your account. Note After you register, you can log into the Developr Portal at any time by providing your user name and password. To log in, your browser must be set to accept cookies. Submitting Content This section describes the guidelines and processes for submitting content. When you submit content, Content Delivery Server performs four major tasks: Authorizes the content Categorizes the content Stores the content or the URL Posts a content description on a web interface You can submit content using the Developer Portal or the Content Aggregator Interface. The Developer Portal provides a submission wizard that prompts you for all of the information and files needed to successfully submit content. Alternatively, you can package the information and files yourself and submit the content in a single step using the advanced submission feature. The Content Aggregator Interface supports XML-RPC. You can post an XML file that describes the content to the Content Aggregator Interface of Content Delivery Server. Note If the message Skipping Device device_name because it does not support Class class_name appears when you submit content, either the library that includes the class identified by class_name is not supported by Content Delivery Server or the library is not included in the device profile for the device specified by device_name. Contact the Content Delivery Server administrator for information on what class libraries can be used in applications. 6 Content Developer Guide June 2008

19 Submission Guidelines Following are guidelines for submitting content: Only registered content providers can submit content to Content Delivery Server. See Registration on page 5 for instructions on registering. Only content types supported by Content Delivery Server can be submitted. See Content Type Submissions on page 2 for information on supported content types. If you submit applications, the APIs that you can use might be limited by the developer plan assigned to your account. Contact the operator for information on what APIs are acceptable. Depending on which format the Catalog Manager supports, SMS content can be provided in either pre-encoded or raw format. If pre-encoded, the default character to use to separate SMS fragments is a space. MIDlets that you submit must be compiled with tools that certify compliance with the Technology Compatibility Kit (TCK) for the Connected Limited Device Configuration (CLDC). If no devices have the capabilities required to run your content, the submission is rejected. Content Delivery Server enforces a maximum size for uploaded files. Your submission file must be less than this size. Contact the operator for the maximum size accepted. If you need to deliver content with DRM, you must either submit all your content with protection and choose None for the DRM type, or you must provide unwrapped content and choose the DRM scheme that meets your needs. Note Content is wrapped with the DRM type determined by the Catalog Manager administrator when it received by the Catalog Manager. If you plan to submit content that is prewrapped with OMA DRM 1.0 protection, coordinate with the Catalog Manager administrator to ensure that your submission is handled correctly by the Catalog Manager. Submitting New Content with the Wizard The submission wizard provides an easy-to-use interface for submitting content. Use the wizard to submit one item at a time. Make sure that you have access to all of the files and the information that you need to complete the submission. To submit new content using the submission wizard follow these steps: 7

20 1. Log into the Developer Portal. To log in, your browser must be set to accept cookies. 2. Click Submit with Wizard to start the submission wizard. 3. Select the type of content that you want to submit from the list provided. 4. Click Next. The Content Data page is displayed. 5. Choose whether you want to upload the content to Content Delivery Server or host the content externally. Follow these steps to upload content to Content Delivery Server: a. Select the Upload option. b. Enter the path and file name of the content file that you want to upload, or click Browse to locate the file. The file name must have one of the file extensions indicated. If you are uploading an application, you must enter the location of both the application descriptor file and the JAR file. To host content externally, follow these steps: a. Select the Host Remotely option. b. Enter the URL for the content. The URL must point to a file with the MIME type indicated. If you are submitting a MIDlet, the URL must point to the.jad file. If you are submitting an iappli application, the URL must point to the.jam file. If you are submitting live streamed content, enter the URL in the Streaming URL text field. The URL must point to the content on the external host. You must also specify the MIME type of the live streamed content so that capability matching can occur. c. If a user name and password are required to access content at the URL provided, select Use Basic Authentication. Enter the user name and password that Content Delivery Server must use. d. Select Use Original Content as a Preview if you want the content file to also be a preview file. A caption is optional. This option is available only if the Catalog Manager administrator enabled the option for the type of content that you are submitting. This option is inapplicable for streamed content as streamed content can be too large for the purposes of a preview. 6. Click Next. The Web Descriptions page is displayed. 8 Content Developer Guide June 2008

21 7. Enter the information used to present the content to the subscriber: Suggested Category - The categories most appropriate for this content. Select one or more categories from the list provided. Hold the Control key to select multiple categories. Info URL - The URL that points to a web site or other information about this content. Developer Content ID - A string that you want to use to identify this content. This ID is for your use only. It is not used by Content Delivery Server. Display Name - A title for this content. This is the name that subscribers see. Short Description - A brief description of this content. The string is limited to 40 characters. Long Description - A detailed description of this content. The string is limited to 512 characters. Device Icon - The path and file name of the device icon for this content. Enter the name in the field provided, or click Browse to locate the file. The file must be a GIF and the icon must be 40 x 40 pixels. Note that if an icon with a larger pixel size is used, a page showing that icon might not display correctly on a subscriber s device. Small Icon - The path and file name of the small icon for this content. Enter the name in the field provided, or click Browse to locate the file. The file must be a GIF and the icon must be 40 x 40 pixels. Note that if an icon with a larger pixel size is used, a page showing that icon might not display correctly on a subscriber s device. Large Icon - The path and file name of the large icon for this content. Enter the name in the field provided, or click Browse to locate the file. The file must be a GIF and the icon must be 80 x 80 pixels. Note that if an icon with a larger pixel size is used, a page showing that icon might not display correctly on a subscriber s device. User Guide - The path and file name of the user guide for this content. Enter the name in the field provided, or click Browse to locate the file. The file must be a PDF file. Start Time - The first date that content is valid for downloading. This field takes a date and time value of the form yyyy-mm-ddthh:mm:ssz and must be after the current date. End Time - The expiration date when content cannot be downloaded. This field takes a date and time value of the form yyyy-mm-ddthh:mm:ssz and must be after the start time. Custom Fields - Provide values as needed for any other fields that might be present. By default, Start Time and End Time are applicable to streamed content only. However, these properties can be configured to be applicable to other content types. 9

22 Note that a red arrow indicates a required field. 8. Click Next. The Content Descriptions page is displayed. 9. Enter content information: Edition Name - A string that identifies this edition. For information on editions, see Editions on page 3. Version - The version number for this content. Delivery Type - The delivery mechanism used for this content: OTA, Nokia Smart Messaging (NSM), or Enhanced Messaging (EMS). This field only appears if single content type submission is being used and if the applicable MIME types can have more than one delivery type. Target Languages on Device - The languages that the device must support to use this content. Select the languages from the list provided. Hold the Control key to select multiple languages. If you select a language, this content is made available only to subscribers with devices that support the selected languages. Pricing - The pricing option for the content item. Depending on whether the Catalog Manager administrator created predefined pricing options for this content type, you must either select a pricing option or define a custom price: Select one of the predefined pricing options. If predefined pricing options are available, all options are listed here. Create a custom price to associate with this content item. By defining your own pricing option, you create a custom price for the content item. If Custom Pricing is not available, the Custom Pricing section is not displayed. TABLE 1 defines the pricing models supported in Content Delivery Server: TABLE 1 Pricing Model Definitions Pricing Model Free Always Trial First Download Every Download Per Use Definition No charge for downloading content. Content can be downloaded any number of times for as long as the content is available. No charge for content on initial download. Subscriber must purchase content for subsequent downloads. Subscriber is charged for initial download of content. Subscriber is not charged for subsequent downloads. Subscriber is charged for each download of content. Subscriber can download content once after purchase and is charged for N uses. 10 Content Developer Guide June 2008

23 TABLE 1 Pricing Model Definitions (Continued) Pricing Model Per Period Per Subscription Per Interval Definition Subscriber can download content once after purchase and is charged for running content for the specified length of time, for example, 3 days, 2 weeks, or 1 month. Charge for N days, weeks, months, or years. Subscriber can download content an unlimited number of times during the subscription period and is automatically charged for the next period of use when the current period expires. Charge recurring fee daily, weekly, monthly, or yearly. Subscriber can download content an unlimited number of times during the interval and is charged for running content from the specified start date to the specified end date. Charge for use starting mm/dd/yyyy through mm/dd/yyyy. Preview - The preview for the content item. Select File to indicate that the preview file is local or URL to indicate that the preview file is remote. Enter the fully qualified pathname of the file. The original location of the preview file is displayed in the File field. You can click Browse to locate the file. Select the browser type by which the preview can be viewed, either from a device (WAP) or a PC (web). You can select both. Click Add to include the preview file. A window appears while the add operation is performed. If the file is invalid, the window shows an error. Otherwise, the window closes and the preview file is added to the WAP Previews list and the Web Previews list based on your selections. You have the option to provide a caption for the preview. If the preview file is for both WAP and web browsers, entering a caption for the file in the WAP Previews list automatically enters the same caption for that file in the Web Previews list. If you want a different caption for the web preview file, overwrite the caption in the Web Previews list. This action breaks the link between the two captions. Captions appear in both the device-based and PCbased Subscriber Portal. If no caption is provided, the default implementation shows Untitled. You can verify that the correct preview file is added by clicking Inspect. You can repeat the preview addition process to add more preview files for this content item. You can then click the Up and Down arrows to position the previews to set the order in which they are presented to the subscriber. Click Delete to remove a file from the list. If preview is not enabled by the Catalog Manager administrator for a content type, this field is not present. 11

24 Device Capabilities - The device capability requirements for this content. Only subscribers who have devices that match the capabilities specified can access this content. To let the Content Delivery Server determine which devices can run the content item, select Use Automated Capabilities Matching (typical). To choose specific devices or set specific capabilities, select Use Custom Capabilities Matching, which displays the custom capability options. For a content item that runs only on specific devices, select Choose by Supported Devices, and select one or more devices from the list provided. Hold the Control key to select multiple devices. For content that requires a set of specific capabilities, select Choose by Minimum Required Capability and specify one or more of the following capabilities: Input CharSet - The character sets that must be accepted for input. Press the Control key to select multiple character sets. Screen Width - The width of the screen required by the content. Bits Per Pixel - The number of bits per pixel required by the content. Number of Softkeys - The number of soft keys that are required. Screen Height - The height of the screen required by the content. Color Capable - Whether the content requires a color screen. Output CharSet - The character sets that must be used to output to the display. Press the Control key to select multiple character sets. 10. Review the developer s agreement. This is necessary only if a link to the agreement is displayed at the end of the page. Submitting content through the Developer Portal indicates that you agree to abide by the terms and conditions stated. 11. Click Submit Content. If the submission is successful, a confirmation page is shown. If the submission is not successful, an error message is displayed. Click Details for additional information about the error. The Content Delivery Server sends an that describes the status of your submission. See Submission Verification Notices on page 18 for more information. 12. Click Done. The content submitted is considered the first edition of the item. To submit other editions, see the following section. 12 Content Developer Guide June 2008

25 Submitting Content Editions With the Wizard After the first edition of an item has been successfully submitted, you can submit other editions. Subsequent editions inherit the descriptive information, support files, and pricing information from the first edition. For more information on editions, see Editions on page 3. Editions can be added depending on the status of the content in the Catalog Manager. See Update Guidelines on page 74 for information on when editions can be submitted and what aspects of the content can be changed depending on its status. To submit editions, follow these steps: 1. Log in to the Developer Portal. 2. Click the Content List tab to show the list of content that you have submitted. 3. Click the title of the content to which you want to add an edition. The content properties are shown. 4. Click New Edition to start the submission wizard for editions. 5. Enter the next edition of the content. This step is dependent on whether the first edition is stored locally or externally: a. If the first edition is stored locally on Content Delivery Server, each additional edition must also be stored locally. Enter the path and file name of the content file that you want to upload or click Browse to locate the file. The file name must have one of the file extensions indicated. If you are uploading an application, you must enter the location of both the application descriptor file and the JAR file. If you are submitting streamed content, you must enter the location of the edition on the external host. b. If the first edition is hosted externally, each additional edition must also be hosted externally. Enter the URL for the content, and the user name and password, if needed. The URL must point to a file with the MIME type indicated. If you are submitting a MIDlet, the URL must point to the.jar file. If you are submitting an iappli application, the URL must point to the.jam file. If you are submitting streamed content, the URL must point to the content on the external host. If you are submitting live streamed content, enter the URL in the Streaming URL text field. The URL must point to the content on the external host. You must also specify the MIME type of the live streamed content so that capability matching can occur. 13

26 6. Use Original Content as a Preview if you want the content file to also be a preview file. A caption is optional. This option is available only if the Catalog Manager administrator enabled the option for the type of content that you are submitting. This option is inapplicable for streamed content as streamed content can be too large for the purposes of a preview. 7. Click Next. 8. Enter content information: Edition Name - A string that identifies this edition. This field is required. Edition names have a maximum length of 64 characters. Version - The version number for this edition. This field is required. Delivery Type - The delivery mechanism used for this content: OTA, NSM, or EMS. This field only appears if single content type submission is being used and if the applicable MIME types can have more than one delivery type. Target Languages on Device - The languages that the device must support to use this edition. Select the languages from the list provided. Hold the Control key to select multiple languages. If you select a language, this edition is made available only to subscribers with devices that support the selected languages. Custom Fields - Provide a value for any other required fields that might be present. 9. Create a new preview set for this edition or skip to Step 10 to use an existing preview set. a. Select Use a Custom Set of Preview Files. b. Choose the files that you want to use. To submit new files, follow the instructions for Preview in Submitting New Content with the Wizard on page 7. To use files in other preview sets, follow these steps: i. Click Available Editions. The Select from Available Editions window is shown. ii. Select from the Filter list the preview set that contains the file that you want to use. The entries in the list identify the edition and the preview set that it references. If all editions use the same preview set, the list contains only one entry. If more than one edition uses the same preview set, the set appears in the list more than once. If an edition has been updated, all versions of the edition appear in the list. The WAP Files and Web Files lists are filled with the preview files in the selected preview set. 14 Content Developer Guide June 2008

27 iii. Select the file or files that you want to use. Click Inspect to view or hear the preview. iv. Specify the target for each selected file. Select WAP to use the file when subscribers browse from their device. Select WEB to use the file when subscribers browse from their PC. Both targets can be selected. v. Click Add. The files that you selected are added to the WAP Previews and Web Previews lists on the Content Descriptions page based on the targets for each selected file. vi. (Optional) Repeat Step i through Step v to select additional files for this edition. When you are done selecting files, click Cancel in the Select from Available Editions window. vii. On the Content Descriptions page, edit the caption, change the position of the files in the list, or delete files as needed. 10. Select Use an Existing Set of Preview Files and select the preview set from the drop-down list. The entries in the list identify the edition and the preview set that it references. If all editions use the same preview set, the list contains only one entry. If more than one edition uses the same preview set, the set appears in the list more than once. If an edition does not have any preview files, the set is shown as Empty Set. If an edition has been updated, all versions of the edition appear in the list. The files in the selected preview set are added to the WAP Previews and Web Previews lists. If the empty set is selected, no files are added to the lists. To view a preview file, click Inspect for that item. 11. Specify required capabilities for a device to run this edition. Only subscribers who have devices that match the capabilities specified are given access to this edition. To let the Content Delivery Server determine which devices can run the edition, select Use Automated Capabilities Matching (typical). To choose specific devices or set specific capabilities, select Use Custom Capabilities Matching, which displays the custom capability options. For an edition that runs only on specific devices, select Choose by Supported Devices, and select one or more devices from the list provided. Hold the Control key to select multiple devices. For editions that require a set of specific capabilities, select Choose by Minimum Required Capability. Specify one or more of the following capabilities: 15

28 Input CharSet - The character sets that must be accepted for input. Hold the Control key to select multiple character sets. Screen Width - The width of the screen required by the content. Bits Per Pixel - The number of bits per pixel required by the content. Number of Softkeys - The number of soft keys that are required. Screen Height - The height of the screen required by the content. Color Capable - Whether the content requires a color screen. Output CharSet - The character sets that must be used to output to the display. Hold the Control key to select multiple character sets. 12. Review the developer s agreement. This is necessary only if a link to the agreement is displayed at the end of the page. Submitting content through the Developer Portal indicates that you agree to abide by the terms and conditions stated. 13. Click Submit Content. If the submission is successful, a confirmation page is shown. If the submission is not successful, an error message is displayed. Click Details for additional information about the error. An message is sent to you that describes the status of your submission. See Submission Verification Notices on page 18 for more information. 14. Click Done. You can check on the status of content editions by going to the content list and clicking on the desired content. The Editions section of the Content Properties page shows the status of all submitted editions. Submitting Packaged Content In addition to the submission wizard, an advanced submission option is available. You must package the content that you want to submit and create a submission file before you use this option to submit content. For information on creating a submission file, see Packaging Content on page 18. Note Any MIDlets in the package that you submit must be compiled with tools that certify compliance with the Technology Compatibility Kit (TCK) for the Connected Limited Device Configuration (CLDC). All content submitted through a package must be of the same content type and must use the same pricing option. A package containing content items with different content types is rejected. 16 Content Developer Guide June 2008

29 To submit packaged content, follow these steps: 1. Log in to the Developer Portal. 2. Click Submit Packaged Content. 3. Enter the path and file name of your submission file, or click Browse to locate the file. The file must be either a ZIP file with the extension.zip or a Provisioning Archive (PAR) file with the extension.par. 4. Review the developer s agreement. This is necessary only if a link to the agreement is displayed at the end of the page. Submitting content through the Developer Portal indicates that you agree to abide by the terms and conditions stated. 5. Click Next. 6. Select the pricing option for the contents in the package. Depending on whether the Catalog Manager administrator created predefined pricing options for this content type, you must either select a predefined pricing option to be applied to all content items in the package or define a custom price of your own. To define a custom price, follow these steps: a. Select Custom Pricing. b. Select a pricing model. If free trials are offered, enter the number of free trials allowed. See TABLE 1 for a description of pricing models. c. Enter a purchase price and other information as applicable in the formats shown in the fields. 7. Click Submit Content. If the package being submitted contains a large amount of content, the process might take several minutes to complete. For each content that is successfully submitted, a confirmation message is shown. For each content that is not successfully submitted, an error message is displayed. Click Details for additional information about the error. You also receive an that describes the status of your submission. See Submission Verification Notices on page 18 for more information. The pricing options or custom pricing is only available if the package contains only new content. Note that depending on the status of the content, the submission of new editions and edition updates might be rejected. 17

30 8. Click Done. Submission Verification Notices When you submit content to Content Delivery Server, you receive an message from Content Delivery Server that describes the status of your submission. If you submitted a package with multiple items of content, the status of each item is described. For content that passed the automatic verification process, a link to your content in Content Delivery Server is provided. After the administrator reviews your content, you receive an from Content Delivery Server that indicates whether your content is accepted, denied, or is undergoing further review or testing. Any time the administrator makes a change to the status or the properties of content that you submitted, Content Delivery Server notifies you by . Packaging Content If you have multiple items to submit and all the items are of the same content type and use the same pricing option, you can bundle the items into a single submission file and submit the content in one step. You can also package a single item for submission if you want to bypass the submission wizard and submit the item in one step. To categorize, store, and post content accurately, content must be submitted in a package with specific files. Content Delivery Server uses these packaged files to accurately distribute your content to customers. This section describes how to package content for submission without using the submission wizard. Creating the Package The package that you create can be a ZIP file with the.zip extension or a PAR file with the.par extension. Be aware that if you choose to create a Provisioning Archive (PAR) file, you can submit one or more editions of an item of content, but you cannot use a PAR file to submit edition updates. Also, you cannot submit previews using a PAR file. You can only submit previews using a ZIP file. Editions can be added depending on the status of the content in the Catalog Manager. See Update Guidelines on page 74 for information on when editions can be submitted and what aspects of the content can be changed depending on its status. 18 Content Developer Guide June 2008

31 Note Catalog properties including user-guide, screenshot, recommended category, and pricing are not supported for PAR submissions. Content Delivery Server ignores user-guide and screenshot for PAR submissions. All PAR submissions are priced as free by default and placed in the Home:Featured category. The advanced capability values are set to their default values for PAR submissions. Custom fields are also not supported for PAR submissions. When you package your content as a PAR file, you must include a provisioning file named provisioning.xml. The contents of this file are described in Creating a Provisioning File on page 34. For detailed information on provisioning files, see the J2EE Client Provisioning Specification, version 1.0 (JSR-124) available at When you package your content as a ZIP file, you must include a content submission file named ContentSubmission.xml that provides the following information: The device capabilities required to use the content How content should be displayed to the user Your price for providing the content Your package must also include all the graphic and support files (see the preceding note about PAR files) for the web interface along with either your content or the URL for external content. To package content, you must create the following files for each item: A file of a type supported by Content Delivery Server. Support files, if desired. A ContentSubmission.xml file if you are packaging your content as a a ZIP file or create a provisioning.xml file if you are packaging your content as a PAR file. A compression file. The following sections describe how to create each of these files. Creating the Content File Create a file that contains the content that you want to provide. For example, create a GIF file for an image or a MIDI file for a ring tone. This file must be a content type that is supported by Content Delivery Server. Contact the operator for information on the valid content types. 19

32 To submit an application, bundle the application files into a single JAR file. You must also create an application descriptor with the extension.jad for a MIDlet or.jam for an iappli application. The application descriptor provides information to the application manager about the contents of the JAR file. For applications, content file refers to both the application descriptor and JAR files. Creating the Support Files Support files include a device icon, a small icon, a large icon, a user guide, and one or two screen shots. You can also provide a preview file that the subscriber can use to sample content before purchasing it. All support files are optional. Support files must be of the type and size indicated in TABLE 2. TABLE 2 Summary of Support Files File Type Image Size Device icon GIF (.gif) 40 x 40 pixels Small icon GIF (.gif) 40 x 40 pixels Large icon GIF (.gif) 80 x 80 pixels User guide PDF (.pdf) Not applicable Preview file Any supported content type Not applicable Screen shots JPEG (.jpg) 200 wide x 190 high pixels Creating a Content Submission File The content submission file (ContentSubmission.xml) includes the following items: Information about the device capabilities that are required to run the content. Content-specific information used to post the content. Customers use this information to select content from the server s web interface or their devices. Pricing information. 20 Content Developer Guide June 2008

33 Each package in the ZIP format must include the ContentSubmission.xml file. TABLE 3 contains the top-level tags that are required in the content submission file: TABLE 3 Tag Name <?xml?> Required Top-Level Content Descriptor Tags Tag Description <?xml version="1.0" encoding="utf-8"?> It is the first tag in the file. It states the XML version and the text encoding used for this file. The file must use UTF-8 encoding. <ContentSubmission> <Action> This is the top-level content submission file tag and encloses the entire document. <Action value="action"> It indicates the purpose of this submission. action has the following valid values: New - Use New when you are submitting an item for the first time. Add - Use Add when you are adding an edition to an existing item. Update - Use Update when you are changing the binaries for an existing item. The remaining tags in the file are described in the following sections: Content Descriptor Section Web Descriptor Section For examples of content submission files and tag usage, see Sample Content Submission Files on page 30. Content Descriptor Section This section of the content submission file describes the capabilities required to run the content. This section is required for all actions (required tags are so noted). Tags for this section are defined in TABLE 4. 21

34 TABLE 4 Tag Name Content Descriptor Tags Tag Description <ContentDescriptor> <Capability> <ContentType> This tag is required. The content descriptor section of the content submission file must begin with this top-level content submission tag. The following tags are valid within <ContentDescriptor>: <Capability>, <ContentType>, <EditionName>, <StreamingURL>, and <Version>. <Capability name="capability" value="value"/> This tag defines a device capability. Each device capability is defined with a separate <Capability> tag. Listing a capability indicates that the capability is required for the content. See TABLE 5 for a list of possible capability definitions. You can use an asterisk (*) for any string or Boolean value. Using the asterisk indicates that the content supports all devices. Omitting a capability from your XML file indicates that the content supports all devices. For example, if you include the tag <Capability name= "colorcapable" value="*"/> or omit the colorcapable tag, both color-capable and non-color devices are allowed to download the application. To specify more than one value for a capability, include more than one <Capability> tag with the same value for name. All capabilities are optional. Capabilities are not case sensitive. Do not include <Capability> tags if you include a <TargetDevice> tag. This tag is valid within <ContentDescriptor>. This tag is required and is case sensitive. It indicates the type of content submitted in the package. You must specify a content type that is supported by Content Delivery Server. Contact the Operator for this information. This tag is valid within <ContentDescriptor>. 22 Content Developer Guide June 2008

35 TABLE 4 Tag Name Content Descriptor Tags (Continued) Tag Description <CustomField> <EditionName> <MimeType> <CustomField customkey="key" value="somedata"/> This tag specifies an additional property of the content item that can be used to identify the item or to gather more vending information about the item. More than one custom field can be specified. Custom fields are defined by a Content Delivery Server administrator. Custom fields can be defined as required or optional. It is your responsibility to determine what custom fields exist for the content, if any, and whether the field is required. customkey takes an alphanumeric character with no spaces. Valid special characters are underscore (_) and hyphen (-). value is data that is relevant to the key, such as a name, number, or date. Specify one <CustomField> tag for each custom field you are submitting. Submission rules are as follows: If no custom fields are defined for the content and you include custom fields in your submission, the submission is rejected. If custom fields are defined as required for the content and you do not provide custom fields in your submission, the submission is rejected. If custom fields are defined as optional for the content and you do not provide custom fields in your submission, the submission is accepted as long as all other submission criteria are met. This tag is valid within <ContentDescriptor>. This tag is required. It specifies the name assigned to the content. This name must be unique by content provider. If <Action> is Update, using a name different from the name specified for <EditionName> in the <Action> section causes the content to be renamed. This tag is valid within <ContentDescriptor>. This tag is required if live streamed content is being submitted. This tag specifies the format of the live streamed content. This tag is valid within <StreamingURL>. 23

36 TABLE 4 Tag Name Content Descriptor Tags (Continued) Tag Description <Preview> <StreamingURL> <TargetDevice> <Version> <Preview src="path"/> This tag specifies a preview file that the subscriber can sample before purchasing the content. This value must be the fully qualified file name within the package, for example, src= "ring1_preview.wav" for a ring tone or src="mazegame_preview.jad" for a MIDlet. Preview files are not required. If a file is provided, the file must be a type supported by Content Delivery Server. No default is provided. If preview is not enabled by the Catalog Manager administrator for the content type, then the preview file is ignored. This tag is valid within <ContentDescriptor>. <StreamingURL src=path"/> This tag specifies the live streamed content file. If live streamed content is submitted, the <MimeType> tag must be included, which specifies the format of the streamed content. The <MimeType> tag is valid within <StreamingURL>. This tag is valid within <ContentDescriptor>. This tag indicates the type of device on which the content is intended to run. Specifying the target device prevents customers with unsupported devices from downloading your content. The device specified must be a device supported by Content Delivery Server. To specify more than one device, include more than one <TargetDevice> tag. If you include this tag, do not include <Capability> tags. Any <Capability> tag included is ignored. This tag is valid within <ContentDescriptor>. This tag indicates the version number for the content. Note - If you are submitting a MIDlet, this value overrides the MIDlet-Version defined in your JAR manifest file. This tag is valid within <ContentDescriptor>. TABLE 5 lists the possible device capability definitions. None of the capabilities are required as part of the content descriptor section. However, when you define capabilities, you limit the devices that can download your content. By limiting your content to optimum devices, you improve customer satisfaction. 24 Content Developer Guide June 2008

37 TABLE 5 Possible Capability Definitions Name Value Definition Spaces bitsperpixel Integer Integer that defines the minimum number of bits per pixel that a device screen must have to run the content. None Example: <Capability name="bitsperpixel" value="8"/> ccppaccept-language String Defines the device-supported locale that your content requires. Use a twocharacter language code followed by a two-character country code, for example, en_us. None Example: <Capability name="ccppaccept-language" value="en_us"/> <Capability name="ccppaccept-language" value="it_it"/> colorcapable yes or no Defines whether or not your content requires a device with a color screen. None Example: <Capability name="colorcapable" value="yes"/> deliverytype String Defines the delivery mechanism for content. In the case of separate content submission, only one value can be given. In the case of single content type submission, more than one value can be included. OTA, NSM, and EMS can be listed as values. No leading or trailing Example: <Capability name="deliverytype" value="ota"/> <Capability name="deliverytype" value="nsm"/> <Capability name="deliverytype" value="ems"/> inputcharset String Defines the device-supported character set that your content requires for text entry. Any device-supported character set can be listed as a value. No leading or trailing Example: <Capability name="inputcharset" value="us-ascii"/> <Capability name="inputcharset" value="utf-8"/> numberofsoftkeys Integer Defines the number of soft keys that your content requires. None Example: <Capability name="numberofsoftkeys" value="2"/> 25

38 TABLE 5 Possible Capability Definitions (Continued) Name Value Definition Spaces outputcharset String Defines the device-supported character set that your content requires for output to the device s display. Any devicesupported character set can be listed as a value. No leading or trailing Example: <Capability name="outputcharset" value="us-ascii"/> <Capability name="outputcharset" value="iso "/> <Capability name="outputcharset" value="shift-jis"/> screenheight Integer Defines in pixels the minimum device screen height that your content requires. None Example: <Capability name="screenheight" value="64"/> screenwidth Integer Defines in pixels the minimum device screen width that your content requires. None Example: <Capability name="screenwidth" value="64"/> Capabilities are not required as part of the content descriptor section. However, when you define capabilities, you limit the devices that can download your content. By limiting your content to optimum devices, you can improve customer satisfaction. Web Descriptor Section This section of the content submission file describes the content to subscribers. The information provided in this section is presented to customers when they are browsing the list of available content. Include this section only if <Action> is New. Tags for this section are defined in TABLE 6 (required tags are so noted). 26 Content Developer Guide June 2008

39 TABLE 6 Tag Name Web Descriptor Tags Tag Description <WebDescriptor> <Category> <CustomField> This tag is required. The web descriptor section of the content submission file must begin with this top-level web submission tag. This tag is required. It indicates the server categories under which the content will be cataloged, for example: Home:Business:Finance. To specify more than one category, provide more than one <Category> tag. You can see the existing categories defined for Content Delivery Server through the Developer Portal. This tag is valid within <WebDescriptor>. <CustomField customkey="key" value="somedata"/> This tag specifies an additional property of the edition that can be used to identify the edition or to gather more vending information about the edition. More than one custom field can be specified. Custom fields are defined by a Content Delivery Server administrator. Custom fields can be defined as required or optional. It is your responsibility to determine what custom fields exist for the content, if any, and whether the field is required. customkey takes an alphanumeric character with no spaces. Valid special characters are underscore (_) and hyphen (-). value is data that is relevant to the key, such as a name, number, or date. Specify one <CustomField> tag for each custom field you are submitting. Submission rules are as follows: If no custom fields are defined for the content and you include custom fields in your submission, the submission is rejected. If custom fields are defined as required for the content and you do not provide custom fields in your submission, the submission is rejected. If custom fields are defined as optional for the content and you do not provide custom fields in your submission, the submission is accepted as long as all other submission criteria are met. This tag is valid within <WebDescriptor>. 27

40 TABLE 6 Tag Name Web Descriptor Tags (Continued) Tag Description <DeveloperContentID> <DeviceIcon> <DisplayName> <InfoURL> <LargeIcon> This tag specifies a personal identifier for your system to use to identify this content. This ID is for your use only. It is not used by Content Delivery Server. It takes a string of alphabetic and numeric characters. This tag is valid within <WebDescriptor>. <DeviceIcon src="path"/> This tag specifies a graphic to display on the device s screen. This value must be the fully qualified file name of a graphic file within the package, for example, src= "/icon/deviceicon.gif". The graphic file must be a GIF with the extension.gif and must be 40 pixels wide and 40 pixels high. If you define a path that does not exist, your submission fails. If you do not define a path for the icon, a default icon is provided. This tag is valid within <WebGroup>. This tag is required. It specifies the content title that is shown on the server s web interface, for example, Stock Ticker. This value can be a maximum of 20 characters including spaces. This tag is valid within <WebGroup>. This tag indicates a web site with content or vendor information. If you are submitting a MIDlet, this variable overrides the MIDlet-Info-URL defined in your JAR manifest file. This tag is valid within <WebDescriptor>. <LargeIcon src="path"/> This tag specifies a graphic to display on the server s web interface. This value must be the fully qualified file name of a graphic file within the package, for example, src= "/icon/largeicon.gif". The graphic file must be a GIF with the extension.gif and must be 80 pixels wide and 80 pixels high. If you define a path that does not exist, your submission fails. If you do not define a path for the icon, a default icon is provided. This tag is valid within <WebGroup>. 28 Content Developer Guide June 2008

41 TABLE 6 Tag Name Web Descriptor Tags (Continued) Tag Description <LongDescription> <Preview> <ScreenShot> <ShortDescription> This tag is required. It takes a text string that further describes the content, for example: Let Stock Ticker watch the market while you get on with your life. Get the latest stock quotes, personalize your portfolio, and set alarms on stock values. This value can be a maximum of 512 characters. This tag is valid within <WebGroup>. <Preview src="path"/> This tag specifies a preview file that the subscriber can sample before purchasing the content. This value must be the fully qualified file name within the package, for example, src= "ring1_preview.wav" for a ring tone or src="mazegame_preview.jad" for a MIDlet. Preview files are not required. If a file is provided, the file must be a type supported by Content Delivery Server. No default is provided. If preview is not enabled by the Catalog Manager administrator for the content type, then the preview file is ignored. This tag is valid within <WebGroup>. <ScreenShot src="path"/> This tag specifies screen shots to display on the server s web interface. To specify a second screen shot, provide an additional <ScreenShot> tag. The value must be the fully qualified file name of a graphic file within the package, for example, src= "/graphics/screen1.jpg". Screen shots are not required. If a screen shot is provided, the graphic file must be a JPEG file with the extension.jpg and must be 200 pixels wide and 190 pixels high. No default is provided. This tag is valid within <WebGroup>. This tag is required. It takes a text string that describes the content, for example, Get the latest stock quotes.this value can be a maximum of 40 characters. This tag is valid within <WebGroup>. 29

42 TABLE 6 Tag Name Web Descriptor Tags (Continued) Tag Description <SmallIcon> <UserGuide> <WebGroup> <SmallIcon src="path"/> This tag specifies a graphic to display on the server s web interface. This value must be the fully qualified file name of a graphic file within the package, for example, src= "/icon/smallicon.gif". The graphic file must be a GIF with the extension.gif and must be 40 pixels wide and 40 pixels high. If you define a path that does not exist, your submission fails. If you do not define a path for the icon, a default icon is provided. This tag is valid within <WebGroup>. <UserGuide src="path"/> This tag specifies an Adobe PDF file as instructions for the content. This value must be the fully qualified file name of a PDF file within the package, for example, src= "/docs/usersguide.pdf". Documentation is not required. If a file is provided, the file must be an Adobe PDF file. No default is provided. This tag is valid within <WebGroup>. This tag is required. It encloses locale-specific content descriptions. It can contain the following valid tags: <DisplayName>, <ShortDescription>, <LongDescription>, <DeviceIcon>, <SmallIcon>, <LargeIcon>, <UserGuide>, <Preview>, and <ScreenShot>. This tag is valid within <WebDescriptor>. Sample Content Submission Files The sample file shown in CODE EXAMPLE 1 describes a package that contains a stock ticker application that requires specific device capabilities. This application is being submitted for the first time. CODE EXAMPLE 1 Content Submission File for New Application Content <?xml version="1.0" encoding="utf-8"?> <ContentSubmission> <Action value="new"/> <ContentDescriptor> <ContentType>midlet</ContentType> <EditionName>Stock Ticker - color</editionname> <Version>1.0</Version> <Capability name="bitsperpixel" value="8"/> <Capability name="ccppaccept-language" value="en_us"/> 30 Content Developer Guide June 2008

43 CODE EXAMPLE 1 Content Submission File for New Application Content (Continued) <Capability name="colorcapable" value="yes"/> <Capability name="deliverytype" value="ota"/> <Capability name="inputcharset" value="us-ascii"/> <Capability name="inputcharset" value="utf-8"/> <Capability name="outputcharset" value="us-ascii"/> <Capability name="outputcharset" value="utf-8"/> <Capability name="numberofsoftkeys" value="2"/> <Capability name="screenheight" value="64"/> <Capability name="screenwidth" value="64"/> </ContentDescriptor> <WebDescriptor> <Category>Home:Business:Finance</Category> <Category>Home:Business:Tools</Category> <InfoURL> <WebGroup> <DisplayName>Stock Ticker</DisplayName> <ShortDescription>Get the latest stock quotes</shortdescription> <LongDescription> Let Stock Ticker watch the market while you get on with your life. Get the latest stock quotes, personalize your portfolio, and set alarms on stock values. </LongDescription> <DeviceIcon src="/graphics/deviceicon.gif"/> <SmallIcon src="/graphics/smallicon.gif"/> <LargeIcon src="/graphics/largeicon.gif"/> <UserGuide src="/docs/userguide.pdf"/> <ScreenShot src="/graphics/screen1.jpg"/> <ScreenShot src="/graphics/screen2.jpg"/> </WebGroup> </WebDescriptor> </ContentSubmission> The sample file shown in CODE EXAMPLE 2 includes two previews that are available when using a WAP browser on the device-based Subscriber Portal and one preview that is available when using a web browser on the PC-based Subscriber Portal. Of the two files targeted for a WAP browser, one is the content file itself and one is a different version of the content. The file targeted for the web browser is the content file itself. Custom fields are included for each content submission with one pair of fields defined for the content item and a different pair of fields defined for content edition. CODE EXAMPLE 2 Content Submission File for New Ring Tone Content <?xml version="1.0" encoding="utf-8"?> <ContentSubmission> <Action value="new"/> <ContentDescriptor> 31

44 CODE EXAMPLE 2 Content Submission File for New Ring Tone Content (Continued) <ContentType>ringtone</ContentType> <EditionName>Lullaby</EditionName> <Version>1.0</Version> <Preview> <Wap> <File usecontentfile="true" caption="full Version"/> <File src="/preview/lullabysample.au" caption="short Version"/> </Wap> <Web> <File usecontentfile="true" caption=""/> </Web> </Preview> <CustomField customkey="studio" value="manchester Studio 3"/> <CustomField customkey="rating" value="number"/> <CustomField customkey="seealso" value="text"/> </ContentDescriptor> <WebDescriptor> <Category>Home:Entertainment:Music</Category> <DeveloperContentId>12345</DeveloperContentId> <WebGroup> <DisplayName>Lullaby</DisplayName> <ShortDescription>Latest from GenCompany</ShortDescription> <LongDescription>Bring back memories of gentler days every time your phone rings</longdescription> <Preview src="ring1_preview.wav"/> </WebGroup> <CustomField customkey="artist" value="the Cure"/> <CustomField customkey="album" value="disintigration"/> </WebDescriptor> </ContentSubmission> The sample file shown in CODE EXAMPLE 3 describes a package that contains a new edition of the stock ticker application that targets the Siemens SL45i device. CODE EXAMPLE 3 Content Submission File for a New Locally Hosted Edition <?xml version="1.0" encoding="utf-8"?> <ContentSubmission> <Action value="add"> <EditionName>Stock Ticker</EditionName> </Action> <ContentDescriptor> <ContentType>midlet</ContentType> <EditionName>Stock Ticker - Siemens</EditionName> <Version>1.0</Version> 32 Content Developer Guide June 2008

45 CODE EXAMPLE 3 Content Submission File for a New Locally Hosted Edition <TargetDevice>Siemens SL45i</TargetDevice> </ContentDescriptor> </ContentSubmission> The sample file shown in CODE EXAMPLE 4 describes a package that contains an update to the stock ticker application. CODE EXAMPLE 4 Content Submission File for an Update of Existing Content <?xml version="1.0" encoding="utf-8"?> <ContentSubmission> <Action value="update"> <EditionName>Stock Ticker - color</editionname> </Action> <ContentDescriptor> <ContentType>midlet</ContentType> <EditionName>Stock Ticker - color</editionname> <Version>1.5</Version> <Capability name="ccppaccept-language" value="en_us"/> <Capability name="ccppaccept-language" value="it_it"/> <Capability name="colorcapable" value="yes"/> <Capability name="deliverytype" value="ota"/> <Capability name="inputcharset" value="utf-8"/> <Capability name="outputcharset" value="utf-8"/> <Capability name="numberofsoftkeys" value="2"/> </ContentDescriptor> </ContentSubmission> 33

46 Creating a Provisioning File If the contents you are submitting are packaged as a PAR file, you must include a provisioning.xml file. TABLE 7 lists the tags that a provisioning can contain. TABLE 7 Tag Name Provisioning File Tags Tag Description <provisioningarchive> <bundle-type> <client-bundle> <content-file> <content-id> This is the top-level tag in the provisioning file and encloses the entire document. The bundle type. For MIDlets, the type must be APPLICATION. Contact the operator for information on other valid content types. This tag is valid within <client-bundle>. This tag contains all the tags that define a specific content bundle. Include a <client-bundle> tag for each content item or for each additional edition being submitted. Note - You cannot include new editions of content in a PAR file when submitting the first edition. Later editions of content must be submitted in a provisioning file separate from the initial submission. This tag is valid within <provisioning-archive>. <content-file>" This tag is required when packaging static content. The content-file element. The text contents of this element must be a URI for the content file. The URI can be absolute (that is, it can have a scheme such as indicating that the content file is not inside the PAR file. Otherwise, it is interpreted relative to the PAR file root. For iappli content, provide the URL to the JAM file. For all other content types, provide the URL to the content. If bundled content does not contain a descriptor file, the <content-file> tag must be included to indicate where the content is located. This link can be relative or absolute. The content files for the bundle must be made available to the server. This tag is valid within <client-bundle>. The unique Content ID per developer. If a developer resubmits the content with same ID, it is added as an edition to the existing content in the system. Editions can be added depending on the status of the content in the Catalog Manager. See Update Guidelines on page 74 for information on when editions can be submitted and what aspects of the content can be changed depending on its status. This tag is valid within <client-bundle>. 34 Content Developer Guide June 2008

47 TABLE 7 Tag Name Provisioning File Tags (Continued) Tag Description <descriptor-file> <description> <device-requirement> <display-name> <icon> This tag is required only if submitting a MIDlet. The descriptor-file element. The text contents of this element must be a URI for the descriptor file. The URI can be absolute (that is, it can have a scheme such as ), indicating that the descriptor file is not inside the PAR file. Otherwise, it is interpreted relative to the PAR file root. This tag is valid within <client-bundle>. The bundle description. This tag is used for both long and short descriptions. This tag is valid within <client-bundle>. This tag is required if specifying specific device requirements. Valid tags within <device-requirement> are: <requirement-name> and <requirement-value>. This tag is valid within <client-bundle>. This tag is required. For a first submission, display-name is the catalog display name of the content and the edition name for the first edition of the content. Currently, only one locale is supported. For a subsequent edition, display-name is the edition name of the new edition being added and must be unique. The value for <display-name> can be a maximum of 20 characters. This tag is valid within <client-bundle>. <icon mime-type= image/gif > The MIME type of the icon, if any. This tag is used for device, small, and large icons. This tag is valid within <client-bundle>. 35

48 TABLE 7 Tag Name Provisioning File Tags (Continued) Tag Description <requirement-name> <requirement-value> <user-descriptions> This tag is required if specifying device requirements. Specifies a hardware characteristic of the device. The following values are supported: HardwarePlatform.BitsPerPixel HardwarePlatform.DeviceIdentifier HardwarePlatform.BitsPerPixel This tag is valid within <device-requirement>. This tag is required if specifying device requirements. Provides the value of the hardware characteristic specified in the <requirement-name> tag. This tag is valid within <device-requirement>. This tag is required. Content descriptions are defined within the <userdescriptions> tag. Valid tags within user-descriptions> are: <displayname>, <description>, and <icon>. This tag is valid within <client-bundle>. All PAR submissions are currently treated as free content and are placed in the Home:Featured category by default. You can include multiple client-bundle tags in a provisioning file if you are submitting more than one item of content or additional editions. You cannot include new editions of content in a PAR file when submitting the first edition. Later editions of content must be submitted in a provisioning file separate from the initial submission. See Creating the Package on page 18 for restrictions that apply when creating a package using a PAR file. See Update Guidelines on page 74 for information on when editions can be submitted and what aspects of the content can be changed depending on its status. Details of the contents of a provisioning file (provisioning.xml) are described in the J2EE Client Provisioning Specification, version 1.0 (JSR-124) available at CODE EXAMPLE 5 shows an example of a provisioning file: CODE EXAMPLE 5 Provisioning File Example <provisioning-archive> <client-bundle> <content-id>20235j</content-id> <bundle-type>application</bundle-type> 36 Content Developer Guide June 2008

49 CODE EXAMPLE 5 Provisioning File Example (Continued) <!--Required only for MIDlets <descriptor-file> </descriptor-file> --> <user-descriptions> <display-name>checkers</display-name> <description>play the game of checkers on phone</description> <icon mime-type= image/gif >/Checkers.gif</icon> </user-descriptions> <device-requirement> <requirement-name>hardwareplatform.deviceidentifier</requirement-name> <requirement-value>nokia/6310i</requirement-value> </device-requirement> <device-requirement> <requirement-name>hardwareplatform.bitsperpixel</requirement-name> <requirement-value>1</requirement-value> </device-requirement> <device-requirement> <requirement-name>hardwareplatform.screensize</requirement-name> <requirement-value>101x80</requirement-value> </device-requirement> </client-bundle> </provisioning-archive> Creating the Compression File After you create the content file, support files, and either the ContentSubmission.xml file or the provisioning.xml file, create a compression file for your content. 37

50 TABLE 8 lists the contents of the compression file. TABLE 8 Compression File Contents for ZIP or PAR Files File For Packaged ZIP Files For Packaged PAR Files Content file Submission file Must be placed at the root level. For applications, both the JAD and JAR files must be placed at the root level. The ContentSubmission.xml file must be in the meta directory. Can be placed at any level, including the root level. For applications, the JAD and JAR files must both be placed at the same level. Not applicable. Provisioning file Not applicable. The provisioning.xml file must be in the META_INF directory. Support files Can be placed at any level below the root level. Can be placed at any level, including the root level. The following figure shows a sample ZIP file for a ring tone that also contains a preview file in the preview subdirectory. The following figure shows a sample ZIP file for an iappli application that also includes supporting documentation, icons, and screen shots in subdirectories. 38 Content Developer Guide June 2008

51 If you want to submit more than one item, create a package ZIP file for each item. For example, if you have four different images, make four package ZIP files and bundle them into a single ZIP file. You can bundle multiple package ZIP files into a single submission file as long as the ZIP files contain the same content type. For example, a submission file can contain two or more package ZIP files that contain images, but cannot include a package ZIP file that contains an application. You cannot bundle multiple package PAR files. Packaging Editions Editions are alternate versions of content that run on devices with different capabilities. For example, you can create one edition of the stock ticker application that runs on the Nokia 6310i device and a second edition of the application that runs on the Siemens S55 device. Each edition shares the web descriptor properties of the first edition submitted. For more information on editions, see Editions on page 3. You must package each edition separately. The ContentSubmission.xml file for the first edition must specify New for the action. Be sure to specify the following items in the ContentSubmission.xml files for each subsequent edition: Add for the <Action> tag 39