Contents

• Notices

• Summary of amendments

• Preface

• 1. Overview of Development

  • 1.1 Range of development

  • 1.2 Flow of plugin development

• 2. Plugin Overview

  • 2.1 Overview of Navigation Platform plugins

    • 2.1.1 About initialization and termination processing of plugins

    • 2.1.2 About plugin sessions

  • 2.2 Types of plugins

  • 2.3 Overview of I/O Plugins

    • 2.3.1 I/O Plugin execution timing

    • 2.3.2 Execution order of I/O Plugins

    • 2.3.3 Data that can be passed by I/O Plugins

    • 2.3.4 Lifecycle of I/O Plugin instances

  • 2.4 Overview of Suspend/Resume Plugins

    • 2.4.1 Suspend/Resume Plugin execution timing

    • 2.4.2 Lifecycle of Suspend/Resume Plugins

  • 2.5 Overview of Custom Window Plugins

    • 2.5.1 Custom Window Plugin execution timing

    • 2.5.2 Data that can be received by Custom Window Plugins

    • 2.5.3 Processing if an error occurs in a Custom Window Plugin

• 3. Preparation of Development

  • 3.1 Setting up Eclipse

  • 3.2 Importing a pluginSDK project

  • 3.3 Adding libraries

    • 3.3.1 Location to place libraries

    • 3.3.2 Creating and configuring libraries

    • 3.3.3 Notes on adding libraries

• 4. Developing Plugins

  • 4.1 Creating template plugins

    • 4.1.1 Editing the plugin information property file

    • 4.1.2 Executing the template plugin creation command

  • 4.2 Importing a template plugin project

  • 4.3 Customizing template plugins

    • 4.3.1 Customizing I/O Plugins

    • 4.3.2 Customizing Suspend/Resume Plugins

    • 4.3.3 Customizing Custom Window Plugins

    • 4.3.4 Creating the JSP file used in custom windows

  • 4.4 Adding database connection processing

    • 4.4.1 Adding a resource adapter

    • 4.4.2 Changing resource adapter settings

    • 4.4.3 Deleting resource adapters

    • 4.4.4 Setting a plugin for database connection processing

    • 4.4.5 Implementing database connection processing

  • 4.5 Implementing processing to be performed during plugin initialization or termination

  • 4.6 Building plugins

    • 4.6.1 Procedure for building plugins

    • 4.6.2 Actions to be taken if an attempt to build plugins fails

  • 4.7 Deploying plugins

  • 4.8 Associating I/O Plugins with Operational Content

    • 4.8.1 Drawing mapping lines (connecting Guide Parts and Plugin Parts)

    • 4.8.2 Details about values input to or output from plugins

    • 4.8.3 Updating Plugin Parts

    • 4.8.4 Checking configuration information for Operational Content that uses plugins

  • 4.9 Configuring the user property file

  • 4.10 Debugging plugins

    • 4.10.1 Conditions for debugging plugins

    • 4.10.2 How to debug plugins

  • 4.11 Deleting plugins

    • 4.11.1 How to delete plugins

  • 4.12 Calculating memory usage for plugins

    • 4.12.1 Procedure for creating Operational Content for measurement

    • 4.12.2 Procedure for measuring the memory usage for plugins

  • 4.13 Changing J2EE server settings

    • 4.13.1 J2EE server setting items that can be changed during plugin development

    • 4.13.2 Storage location of the files used for changing J2EE server setting items

    • 4.13.3 Procedure for changing the user property file for J2EE servers (usrconf.properties)

    • 4.13.4 Procedure for changing the option definition file for J2EE servers (usrconf.cfg)

  • 4.14 Notes on developing plugins used with Operational Content for iPad

  • 4.15 About use of plugins developed in old versions

  • 4.16 Setting up access permissions to Java packages to be used by User Plugins

• 5. API Reference (for I/O Plugin Development)

  • 5.1 List of APIs (for I/O Plugin development)

  • 5.2 IIoPluginController (server processing implementation interface)

    • 5.2.1 inputFromNode method

    • 5.2.2 outputToNode method

    • 5.2.3 Plugin processing during preview

  • 5.3 IPluginInitializer (User Plugin startup (initialization) and termination processing implementation interface)

    • 5.3.1 init method

    • 5.3.2 destroy method

  • 5.4 UCNPPluginUserException (User Plugin exception class)

  • 5.5 ParamConvertUtil (I/O parameter conversion utility class)

    • 5.5.1 decodeHtmlPartParam method

  • 5.6 UCNPPluginException (I/O Plugin exception class)

    • 5.6.1 getMessage method

    • 5.6.2 getMessageId method

  • 5.7 IUCNPSession (session information use interface)

    • 5.7.1 getLoginId method

• 6. API Reference (for Suspend/Resume Plugin Development)

  • 6.1 List of APIs (for Suspend/Resume Plugin development)

  • 6.2 ISuspendActionController (suspend/resume action controller interface)

    • 6.2.1 save method

    • 6.2.2 load method

    • 6.2.3 contains method

    • 6.2.4 delete method

    • 6.2.5 deleteAll method

  • 6.3 ISuspendInfo (suspend information interface)

    • 6.3.1 getContentSuspendedId method

    • 6.3.2 getWorkId method

    • 6.3.3 getContentName method

    • 6.3.4 getGroupName method

    • 6.3.5 getCurrentNodeName method

  • 6.4 SupendInfoSerializeUtil (utility class for suspend information serialization)

    • 6.4.1 serialize method

    • 6.4.2 deserialize method

  • 6.5 UCNPPluginException (Suspend/Resume Plugin exception class)

    • 6.5.1 UCNPPluginException(String message) constructor

    • 6.5.2 UCNPPluginException(String message, Throwable cause) constructor

• 7. API Reference (for Custom Window Plugin Development)

  • 7.1 List of APIs (for Custom Window Plugin development)

  • 7.2 CustomWindowUrlUtil (utility class for custom window URL acquisition)

    • 7.2.1 getCustomWindowUrl method

  • 7.3 LogoutActionUtil (logout processing class)

    • 7.3.1 logout method

• Appendixes

  • A. How to Use Sample Plugins

    • A.1 How to use I/O Plugins (sample)

    • A.2 How to use Suspend/Resume Plugins (sample)

    • A.3 Notes on using sample plugins

  • B. Important Point for I/O Plugin Development

    • B.1 Suppressing execution of I/O Plugins depending on the presence of mapping lines

  • C. Migration from Old Versions

    • C.1 Procedure for migrating plugins developed in old versions

    • C.2 Migration of the menu area developed in old versions

    • C.3 Migration of custom windows (new windows) developed in old versions

    • C.4 J2EE server settings in old versions

  • D. Reference Material for This Manual

    • D.1 Related publications

    • D.2 Conventions: Abbreviations for product names

    • D.3 Conventions: Acronyms

    • D.4 Conventions: KB, MB, GB, and TB

  • E. Glossary

• Index

To Page Top