Interstage Data Manager Using the Manuals
Using the Manuals Trademarks Trademarks of other companies are used in this manual only to identify particular products or systems. Product Microsoft, Visual C++, Windows, and Windows Server Solaris Linux Java Red Hat, RPM, and all trademarks and logos based on Red Hat Interstage Trademark/Registered Trademark Registered trademark or trademarks of Microsoft Corporation in the United States and other countries. Solaris and all other trademarks and logos related to Solaris are registered trademarks or trademarks of Sun Microsystems Inc. U.S.A. in the United States and other countries, and are used under license from the said company. Registered trademark or trademark of Linus Torvalds in the United States and other countries. Java and other trademarks comprising Java are trademarks of Sun Microsystems Inc. U.S.A. in the United States and other countries. Trademarks or registered trademarks of Red Hat Inc. in the United States and other countries. Interstage is a registered trademark of Fujitsu Limited. Fujitsu documentation may contain specific technologies that are subject to the Foreign Exchange and Foreign Trade Control Law. When such specific technology is described in a document, and that document is either exported or provided to a nonresident, permission must be sought under the above law. Fujitsu Limited First Edition (May 2005) The contents of this manual may be revised without prior notice. All Rights Reserved, Copyright FUJITSU Limited 2005 ii
Preface Purpose of this Manual This manual explains the organization the manual set for Interstage Data Manager (hereafter referred to as ). It also details how to use these manuals. Target Audience This manual is aimed at the following readers: Persons using manuals iii
Preface iv
Table of Contents Chapter 1 Using the Manuals Chapter 2 Manual Organization and How to Read Them Manual Title Format...2-2 Diagram of Manual Organization...2-3 Supplementary Information on Function Classification...2-4 Basic Functions...2-4 Extended Functions...2-4 Manual Reference by Intended Usage...2-5 Preliminary Information...2-5 Getting an Overview of the System...2-6 Design...2-7 Installation and Setup...2-8 Operation...2-9 Application Development...2-11 References...2-12 Notation Used in Manuals...2-14 Platform-specific Information...2-14 Format for Terms and Abbreviations...2-14 Format of Product Version...2-15 Chapter 3 Trademark, Export Permit, and Copyrights v
Table of Contents vi
Chapter 1 Using the Manuals manuals cover the following products: Interstage(R) Data Manager Enterprise Edition V7.0 for Windows Interstage(R) Data Manager Enterprise Edition V7.0 for Linux Solaris OE Interstage(R) Data Manager Enterprise Edition 7.0 Table 1-1 Operating Systems Supported by Purchase Product Windows version Linux version Admin Server (*1) Operating system that can be used Director Server Sort Server Search Server Application Server (*3) Solaris OE version (*2) *1 Refer to the Installation for software required to use with the Admin Server. *2 A searcher package is supplied for the use with Linux. *3 An API package is supplied for the use with all platforms. For information on the application development environment, refer to the Installation. 1-1
Chapter 1: Using the Manuals 1-2
Chapter 2 Manual Organization and How to Read Them This chapter describes how the manual is structured and how most effectively it should be read. Manual Title Format Diagram of Manual Organization Manual Reference by Intended Usage Notation Used in Manuals 2-1
Chapter 2: Manual Organization and How to Read Them Manual Title Format In manuals, the description Interstage Data Manager preceding the manual titles is abbreviated, instead, the following manual titles are used: Format used in manuals Manual title Using the Manuals (this manual) Interstage Data Manager Using the Manuals New Features in V7.0 Interstage Data Manager New Features in V7.0 Installation Application Development Command Reference Java API Reference C API Reference Messages Glossary Interstage Data Manager Interstage Data Manager Interstage Data Manager Installation Interstage Data Manager Application Development Interstage Data Manager Command Reference Interstage Data Manager Java API Reference Interstage Data Manager C API Reference Interstage Data Manager Messages Interstage Data Manager Glossary 2-2
Diagram of Manual Organization Diagram of Manual Organization The organization of manuals is shown in the following diagram: Figure 2-1 Organization of Manuals *1 Basic functions available in the basic configuration (for details, refer to the section on the Basic Functions). *2 Extended functions available in the multi-server configuration (For details, refer to the section on the Extended Functions) 2-3
Chapter 2: Manual Organization and How to Read Them Supplementary Information on Function Classification This section explains details of the basic functions and the extended functions referred to in the manual. Basic Functions Basic functions is used to refer to the following basic functions and system configuration/operation methods: Construction and operation of the system in the basic configuration (where only the single servers or the searchers are allocated to other servers) Data retrieval and update (add, update, and delete) Centralized operation from the Web browser (Management Console) Conversion of data from the database or of files in CSV format into XML format Fetching of data from the database or from files in CSV format Simplified backup and recovery (maintenance of data up to the point of backup). Extended Functions Extended functions is used to refer to the following extended functions and system configuration/operation methods: Server expansion and operation with multiple servers (multi-server configuration) Ensuring independence of respective businesses and defining the data retrieval range ( File) Construction and operation of a system with high availability (failover configuration) High-level backup and recovery (maintenance of data to the latest state) Command line operations Ensuring data integrity during data manipulation (transaction function). 2-4
Manual Reference by Intended Usage Manual Reference by Intended Usage This section explains which where to look for required information in the manual set, based on intended usage of. Preliminary Information Purpose/usage Function Classification (Note) Manual title Contents How to read To understand manual names and the sequence in which to read the manuals Common Using the Manuals Lists the purpose/usage of the manuals and how to read them. Also, gives information on related products Read to find out which manual to refer to for a specific purpose To read about new functionality Common New Features in V7.0 Describes new functions added in version 7.0 Read to learn about the new functionality added to this version To read about changes to. Common New Features in V7.0 Provides an overview of modifications made to functionality of earlier versions Read to learn the about modifications made to functionality from earlier versions. Note The function classification refers to the following: Basic Basic functions available in the basic configuration (for details, refer to the section on Basic Functions) Extended Extended functions available in the multi-server configuration (for details, refer to the section on Extended Functions) Common Applicable to both the Basic and the Extended. 2-5
Chapter 2: Manual Organization and How to Read Them Getting an Overview of the System Purpose/usage Function Classification (Note) Manual title Contents How to read To acquire an overview of and the knowledge required to operate or use Basic Extended Explains the reason for using functions, when to use it, and provides operation examples. Also, provides functionality overview Describes new functions added in version 7.0 Read this manual first Read to understand why you might use the basic functions, when to use them, and to see operation examples of the basic functions Read to understand why you might use the extended functions, when to use them, and to see operation examples of the extended functions Note The function classification refers to the following: Basic Basic functions available in the basic configuration (for details, refer to the section on the Basic Functions) Extended Extended functions available in the multi-server configuration (for details, refer to the section on the Extended Functions) Common Applicable to both the Basic and the Extended. 2-6
Manual Reference by Intended Usage Design Purpose/usage Function Classification (Note) Manual title Contents How to read To understand the system configuration Basic Extended Explains 's process configuration, file configuration, and system configuration Read to learn 's process configuration, file configuration, and system configuration To design the operation format Basic Extended Explains how and what type of information system to construct by installing and how to design the operation format Read to obtain the information required for operation design such as considerations to information system construction, system construction procedure, and how to estimate the required resources To study the operating environment files Extended Explains the parameters of the operating environment files supplied by Read to study the operating environment parameters in details Note The function classification refers to the following: Basic Basic functions available in the basic configuration (For details, refer to the section on the Basic Functions) Extended Extended functions available in the multi-server configuration (For details, refer to the section on the Extended Functions) Common Applicable to both the Basic and the Extended. 2-7
Chapter 2: Manual Organization and How to Read Them Installation and Setup Purpose/usage Function Classification (Note) Manual title Contents How to read To install and set up Installation Explains the procedure from installing to verifying correct operation Read to install and set up To uninstall Common Explains the procedure for uninstalling Read to uninstall Note The function classification refers to the following: Basic Basic functions available in the basic configuration (For details, refer to the section on the Basic Functions) Extended Extended functions available in the multi-server configuration (For details, refer to the section on the Extended Functions) Common Applicable to both the Basic and the Extended. 2-8
Manual Reference by Intended Usage Operation Purpose/usage Function Classification (Note) Manual title Contents How to read To learn about operation and maintenance Basic Explains how to operate and manage, the functions required for operation and management and how to use them Read to learn how to operate using the Management Console. Read to study the methods of system operation such as activating/ deactivating, how to monitor, and how to back up and recover Extended Read to study the extended operation using the command line. Read to study system operation such as activating/ deactivating, how to monitor, and how to back up and recover To study the XML conversion function of the data Common Explains how to convert data from a database or non-xml data into data in XML format Read when converting data from a database or non-xml data to data in XML format To learn how to change the system configuration Basic Explains how to add directors and searchers Read to understand how to use directors for different data types and to improve retrieval performance Extended Explains how to add directors and extend director servers Explains how to add searchers and extend search servers Explains how to add sorters and extend sort servers Read to understand how to use directors for different data types and to improve retrieval performance 2-9
Chapter 2: Manual Organization and How to Read Them Purpose/usage Function Classification (Note) Manual title Contents How to read To understand how to a define the retrieval range for each business Extended Explains when and how the Files can be used Read when defining hardware resources required by each business for storage of retrieved and other data, and when defining application logic To understand backup and recovery operations Explains backup and recovery operations from available from the Management Console. Data can be recovered to the state at which the last backup was performed Read to understand how to perform backup and recover operations using the Management Console Common Explains backup and recovery operations from the command line. Data can be recovered to the state at which the last backup was performed, or it can be recovered to the state of the most recent update operation. Read to learn how to back up and recover in extended mode using the command line To understand 's HA (High Availability) functions Extended Gives an overview of the failover function of director servers that that are linked to cluster products. Also, gives an overview of the failover function of the search server and explains how to use this function Read to study the fail over configuration of the director server or search server To learn how to monitor the system Extended Explains what can be monitored and how Read to understand system monitoring 2-10
Manual Reference by Intended Usage Purpose/usage Function Classification (Note) Manual title Contents How to read To understand s operating environment files Extended Explains parameters of the operating environment files supplied by Read to understand the operating environment files parameters Note The function classification refers to the following: Basic Basic functions available in the basic configuration (For details, refer to the section on the Basic Functions) Extended Extended functions available in the multi-server configuration (For details, refer to the section on the Extended Functions) Common Applicable to both the Basic and the Extended. Application Development Purpose/usage Function Classification (Note) Manual title Contents How to read To learn how to develop applications To learn how to retrieve data To learn how to add, update, and delete data Common Application Development Explains how to create applications that operate on the information system built with Also, explains the interface required to operate the applications Read to understand the overview of application development and the development procedure To learn how to develop applications using Java API To learn how to develop applications using C API 2-11
Chapter 2: Manual Organization and How to Read Them Purpose/usage Function Classification (Note) Manual title Contents How to read To study the format of the retrieval formula, return formula, and the sort formula To view sample programs Basic Application Development Describes sample programs that use basic functions such as data retrieval, update, and deletion Read to view sample programs basic function usage such as data retrieval, update, and deletion. Extended Describes transactions and the sample program that uses Files Read to reference transactions and the sample program that uses Files. To learn how to develop applications that use transactions Extended Explains how to create advanced applications that use transactions Read to learn how to create applications that use transactions To learn how to develop applications that use Files Extended Explains how to create applications in extended mode using Files Read to understand how to create applications using File Note The function classification refers to the following: Basic Basic functions available in the basic configuration (For details, refer to the section on the Basic Functions) Extended Extended functions available in the multi-server configuration (For details, refer to the section on the Extended Functions) Common Applicable to both the Basic and the Extended. 2-12
Manual Reference by Intended Usage References Purpose/usage Function Classification (Note) Manual title Contents How to read To understand how to use commands Common Command Reference Explains the command functions available to and how to use them Read to study the command overview and the function details To understand how to use APIs Common Java API Reference Explains the Java API functions available to and how to use them Read for details of the Java APIs C API Reference Explains the C API functions available to and how to use them Read for details of the C APIs To reference terminology Common Glossary Explains important terms and specific terms Read to understand or reference technical terms, specific terms and abbreviated terms used in the manuals. To understand what action to take in response to messages Common Messages Explains how to interpret messages output during command execution or those output to the event log or system(syslog) logs. Also explains what action to take in response to these messages. Read to find out the appropriate action to take in response to messages. Note The function classification refers to the following: Basic Basic functions available in the basic configuration (For details, refer to the section on the Basic Functions) Extended Extended functions available in the multi-server configuration (For details, refer to the section on the Extended Functions) Common Applicable to both the Basic and the Extended. 2-13
Chapter 2: Manual Organization and How to Read Them Notation Used in Manuals This section explains the notation used in manuals. Platform-specific Information All manuals describe information relevant to all platforms supported by. Where the description differs between platforms, the applicable platform is indicated for the respective descriptions. Refer to the information applicable to the platform in use. Describes details relevant to Windows Describes details relevant to Linux Describes details relevant to Solaris OE Format for Terms and Abbreviations Terms Used in Manuals Corresponding terms used in the manuals are below: Term used in manuals Folder Directory The term directory may sometimes be used in manuals. Abbreviations Abbreviations are used for the following product names in manuals: Abbreviation Windows Windows 2000 Windows Server 2003 Solaris OE Linux Product name Interstage(R) Data Manager Enterprise Edition for Windows, Interstage(R) Data Manager Enterprise Edition for Linux, and Solaris OE Interstage(R) Data Manager Enterprise Edition Microsoft(R) Windows(R) 2000 Server operating system, Microsoft(R) Windows(R) 2000 Advanced Server operating system, Microsoft(R) Windows Server(TM) 2003, Standard Edition, and Microsoft(R) Windows Server(TM) 2003, Enterprise Edition Microsoft(R) Windows(R) 2000 Server operating system and Microsoft(R) Windows(R) 2000 Advanced Server operating system Microsoft(R) Windows Server(TM) 2003, Standard Edition and Microsoft(R) Windows Server(TM) 2003, Enterprise Edition Solaris(TM)8 Operating Environment, and Solaris(TM)9 Operating Environment Red Hat Enterprise Linux AS and Red Hat Enterprise Linux ES 2-14
Notation Used in Manuals Abbreviation Apworks Interstage Application Server Application Server Plus Developer Frameworks Suite Product name Interstage(R) Apworks Standard Edition V7.0, Interstage(R) Apworks Enterprise Edition V7.0, and Interstage(R) Apworks Modelers-J Edition V7.0 Interstage(R) Application Server Plus V7.0, Interstage(R) Application Server Standard Edition V7.0, and Interstage(R) Application Server Enterprise Edition V7.0 Interstage(R) Application Server Plus Developer V7.0 Interstage(R) Application Frameworks Suite Web Edition V7.0, Interstage(R) Application Frameworks Suite Standard Edition V7.0, and Interstage(R) Application Frameworks Suite ClientJ Edition V7.0 Format of Product Version Format of some versions referred to in manuals may sometimes differ from that of the official versions for the products concerned. Unless otherwise is stated, in all manuals, the following version format is used. The format should be replaced as follows when reading the manual. Version format Japanese product Product concerned/version English product V7.0 V7.0 Windows Interstage(R) Data Manager Enterprise Edition V7.0L10, Linux Interstage(R) Data Manager Enterprise Edition V7.0L10, and Solaris OE Interstage(R) Data Manager Enterprise Edition 7.0 V6.0 V6.0L30 Windows Interstage(R) Data Manager Enterprise Edition V6.0L30, Linux Interstage(R) Data Manager Enterprise Edition V6.0L30, and Interstage(R) Data Manager Enterprise Edition V7.0 for Windows, Interstage(R) Data Manager Enterprise Edition V7.0 for Linux, and Solaris OE Interstage(R) Data Manager Enterprise Edition 7.0 Interstage(R) Data Manager Enterprise Edition V6.3 for Windows, and Interstage(R) Data Manager Enterprise Edition V6.3 for Linux Solaris OE Interstage(R) Data Manager Enterprise Edition 6.2 (*1) 2-15
Chapter 2: Manual Organization and How to Read Them Version format Japanese product Product concerned/version English product V6.0L20 V6.0L10 Linux Interstage(R) Data Manager Enterprise Edition V6.0L20 (*1) Windows Interstage(R) Data Manager Enterprise Edition V6.0L10, Linux Interstage(R) Data Manager Enterprise Edition V6.0L10, and Solaris OE Interstage(R) Data Manager Enterprise Edition 6.0 - Interstage(R) Data Manager Enterprise Edition V6.0 for Windows, Interstage(R) Data Manager Enterprise Edition V6.0 for Linux, and Solaris OE Interstage(R) Data Manager Enterprise Edition 6.0 *1) Version only available in Japanese 2-16
Chapter 3 Trademark, Export Permit, and Copyrights This chapter details the Trademarks, Export Permit and Copyrights applicable to all documents in the document set. 3-1
Chapter 3: Trademark, Export Permit, and Copyrights Trademarks Export Permit Copyrights Microsoft, Visual C++, Windows, and Windows Server are registered trademarks or trademarks of Microsoft Corporation U.S.A. in the United States and other countries. Solaris and all other trademarks and logos related to Solaris are registered trademarks or trademarks of Sun Microsystems Inc. U.S.A. in the United States and other countries, and are used under license from the said company. Linux is a registered trademark or trademark of Linus Torvalds in the United States and other countries. Java and other trademarks comprising Java are trademarks of Sun Microsystems Inc. U.S.A. in the United States and other countries. Red Hat, RPM, and all trademarks and logos based on Red Hat are registered trademarks or trademarks of Red Hat Inc. in the United States and other countries. Interstage are registered trademarks of Fujitsu Limited. Fujitsu's document may contain a certain technology that is subject to the Foreign Exchange and Foreign Trade Control Law. To export such a document or supply it to a non-resident, permission must be sought under the above law. All Rights Reserved, Copyright(C) FUJITSU Limited 2005 First Edition, May 2005 3-2