Table of Contents
ProFrame provides a total of 14 guides, so that users who are new to the product or not familiar with it may have trouble finding appropriate guides. For example, to get information about DBIO module creation, users need to know whether the information is only described in ProFrame DBIO Developer's Guide or if there is another guide to refer to together. Therefore, this chapter describes how to use the ProFrame guides and what information is included in each guide. Users who are new to the guides are advised to read this chapter carefully.
ProFrame provides the following 14 guides.
| ProFrame | Guide |
|---|---|
| Common | Getting Started Guide |
| Installation Guide | |
| Studio Guide | |
| Developer's Guide | |
| Module | ProMapper Developer's Guide |
| FileIO Developer's Guide | |
| DBIO Developer's Guide | |
| EMB Developer's Guide | |
| Others | Unit Test Guide |
| Utility Guide | |
| Administrator's Guide | |
| Online Programming Guide | |
| Batch Programming Guide | |
| TCache Guide |
The following briefly describes each guide.
ProFrame Getting Started Guide
This guide.
ProFrame Installation Guide
Describes system requirements and how to install and uninstall ProFrame Server and Studio.
Includes the following.
System requirements for ProFrame Server and Studio installation
Additional software check
Server installation, verification, and uninstallation in Unix
Studio installation, verification, and uninstallation in Windows
Troubleshooting
ProFrame Studio Guide
Intended for developers who develop systems by using ProFrame Studio. It describes what they need to know before using the Studio.
Includes the following.
Introduction to Studio and its screen layout
Starting Studio
Configuring Studio
Shortcuts
ProFrame Developer's Guide
Describes how to write a unified program for developers who use ProFrame to develop online service programs.
Includes the following.
Development overview, technology, and components
Development tools (Studio and test framework)
Development procedure
Introduction to development-related guides
ProFrame ProMapper Developer's Guide
Describes how to design input/output and create conversion rules for applications by using ProMapper Editor embedded in Studio.
Includes the following.
ProMapper introduction and configuration
Basic information addition for each resource type
ProMapper editor usage for each resource type
Structure editor
Message editor
Map editor
Source generation, compilation, and Dlupdate
Created ProMapper resource usage
Variable-length array structure usage and examples
ProMapper-related API
ProMapper-related error code
ProFrame FileIO Developer's Guide
Describes how to create FileIO modules by using FileIO editor embedded in Studio.
Includes the following.
FileIO introduction and configuration
FileIO basic information addition
FileIO editor usage
Compilation and Dlupdate
Created FileIO module usage and examples
FileIO-related API
ProFrame DBIO Developer's Guide
Describes how to create DBIO modules by using DBIO editor embedded in Studio.
Includes the following.
DBIO introduction and configuration
DBIO basic information addition
DBIO editor usage
Source generation, compilation, and Dlupdate
DBIO's additional functions
DWIO function integration
ProFrame EMB Developer's Guide
Describes how to create EMB modules by using EMB Designer embedded in Studio.
Includes the following.
EMB overview
EMB Designer overview
Environment configuration
Screen layout
EMB module creation procedure
EMB module basic information addition
Flow creation
Flow edition
Compilation, Dlupdate, and unit tests
Other EMB functions
ProFrame Unit Test Guide
Describes how to conduct unit tests for service and application modules developed with Studio.
Includes the following.
Test framework introduction
Unit test function and screen layout
How to conduct a unit test for each function
How to check test log in Studio
How to configure log view
Troubleshooting
ProFrame Utility Guide
Describes utilities provided by ProFrame.
Includes the following.
ProFrame API overview
Date utility and related API
Number utility and related API
String utility and related API
Long utility and related API
Error handling and debugging utility and related API
Other utilities and related APIs
PfmNumber usage
ProFrame Administrator's Guide
Describes runtime engine, integrated server, and WebAdmin in detail.
Includes the following.
Runtime environment management
Runtime environment operation
Integrated server environment management
Development environment operation
WebAdmin management
ProFrame Online Programming Guide
Describes how to develop online programs by using ProFrame.
Includes the following.
Online service program introduction
Online service program development procedure
Online service program development method
Service integration method
Notes for service integration
ProFrame Batch Programming Guide
Describes how to develop batch programs by using ProFrame.
Includes the following.
Batch framework overview
Batch framework types
General batch
POD batch
Residential batch
Batch job information
Batch creation procedure
Batch creation method for each batch framework type
Batch parameters
ProFrame TCache Guide
Describes how to configure and use TCache.
Includes the following.
TCache overview
TCache components
pfmtcacheadmin
pfmtcache.cfg
pfmtcachebackup
pfmtcacherestore
Starting and managing TCache
pfmtcacheadmin usage
TCache API
pfmTCacheGet
pfmTCacheGetAll
pfmTCachePut
pfmTCacheInvalidate
pfmTCacheInvalidateAll
pfmTCacheItem
TCache API examples
pfmTCacheGet, pfmTCachePut example
pfmTCacheInvalidate example
TCache synchronization
Multi Domain Invalidation
Multi Node Invalidation(COUSIN)