LANSA Composer Guide
Table of contents
-
LANSA Composer
- About this Guide
-
What's New in LANSA Composer Version 5.0?
- Licensing
- Installation
- New SQL Database Activities
- Other New and Enhanced Activities
- Extended Duration Processing Sequences
- Cross References
- Deployment
- Audit Trail
- Events
- Parameter Classes
- LANSA Composer Client User-interface Enhancements
- Transformation Maps
- Transaction Document Support
- System Settings
- Database Housekeeping
- Browsers for Server Files and Folders
- Other New and Enhanced Features
- 1. Introducing LANSA Composer
-
2. Define Integration Components
- 2.1 Activities
-
2.2 Activities by Group
- 2.2.1 Design, Test and Debug
- 2.2.2 Email
- 2.2.3 File Management
- 2.2.4 FTP Transport Activities
- 2.2.5 HTTP Transport Activities
- 2.2.6 Iterator activities
- 2.2.7 Messaging Transport
- 2.2.8 Processing
- 2.2.9 Spooled File Management
- 2.2.10 SQL Database Activities
- 2.2.11 Terminal Server Activities
- 2.2.12 Transaction Document Processing
- 2.2.13 Transformations
- 2.2.14 Transport
- 2.2.15 Variable manipulation
- 2.2.16 Zip Activities
-
2.2.17 All Supplied Activities
- BASE64_DECODE
- BASE64_ENCODE
- BLANKCONCAT
- CALCULATE
- CALL_3GL
- CALL_FUNCTION
- CALL_JAVA
- CLEARLIST
- CLEARVARIABLE
- COMPOSER_RUN
- CONCAT
- COPY_FILE
- COUNTLIST
- DELETE_FILE
- DELETE_SPLF
- DIRECTORY_LIST
- DISCOVER_DOC
- DISCOVER_EDI
- DISCOVER_MAP
- DISCOVER_XML
- DTAQ_CLEAR
- DTAQ_RECEIVE
- DTAQ_SEND
- EDI_SPLIT
- FIND_TPMAP
- FOR_EACH_CSVROW
- FOR_EACH_INDEX
- FOR_EACH_OBJECT
- FOR_EACH_TXDOCO
- FOR_EACH_TXDOCT
- FOR_EACH_TXTLIN
- FOR_EACH_VAR
- FTP_COMMANDLIST
- FTP_DIRLIST
- FTP_INBOUND
- FTP_OUTBOUND
- FTP_SCRIPT
- GET_DTAARA
- HASH_FILE
- HTTP_GET
- HTTP_INBOUND
- HTTP_POST
- JSM_RECLAIM
- JSM_SCRIPT
- LAST_SPLF
- LOAD_PSVSET
- LOGLIST
- LOGUSERINFO
- LOGVARIABLE
- LOWERCASE
- MAIL_RECEIVE
- MAIL_RECEIVEALL
- MAIL_SEND
- MOVE_FILE
- MOVE_SPLF
- MSG_RECEIVE
- MSG_SEND
- MSGQ_RECEIVE
- MSGQ_SEND
- NOTIFYEVENT
- NEXTNUMBER
- NULL
- PATHMAKE
- PATHSPLIT
- PUT_DTAARA
- QUERY_CCSID
- RANDOMNUMBER
- RENAME_FILE
- SAVE_PSVSET
- SLEEP
- SMS_SEND
- SORT_LISTS
- SPLF_LIST
- SPLF_TO_PDF
- SPLF_TO_TEXT
- SQL_CALL
- SQL_CALLQRYCSV
- SQL_CALLQUERY
- SQL_COMMIT
- SQL_CONNECT
- SQL_DISCONNECT
- SQL_PARAMS
- SQL_PARAMSCSV
- SQL_QUERY
- SQL_QUERYTOCSV
- SQL_ROLLBACK
- SQL_UPDATE
- SUBSTITUTE
- SUBSTITUTE_VAR
- SUBSTRING
- SYSTEM_COMMAND
- TEXT_SUBSTITUTE
- TRANSFORM
- TS_CAPTURE
- TS_CONNECT
- TS_DISCONNECT
- TS_EXECUTE
- TS_GET
- TS_GETBYNAME
- TS_GETBYPOS
- TS_GETFIELD
- TS_SEND
- TS_SETBYNAME
- TS_SETBYPOS
- TS_SETCURSOR
- TXDOC_ALLOCCTRL
- TXDOC_EXPORT
- TXDOC_IMPORT
- TXDOC_KEYS
- TXDOC_REGISTER
- TXDOC_REGOUTBND
- TXDOC_REGOUTEDI
- TXDOC_REGOUTX12
- TXDOC_STATUS
- UNIQUEID
- UPPERCASE
- WAIT_FILESREADY
- WATCH_DIRECTORY
- WATCH_DTAQ
- WATCH_MSGQ
- XML_SPLIT
- XML_QUERY
- XML_VALIDATE
- XSL_TRANSFORM
- ZIP_DIRECTORIES
- ZIP_FILES
- ZIP_LIST
- ZIP_UNZIP
- 2.2.18 Deprecated Activities
- 2.3 Configurations
-
2.4 Trading Partners
- 2.4.1 Work With Trading Partners
- 2.4.2 Trading Partner Details
- 2.4.3 Trading Partner Groups
- 2.4.4 Trading Partner Properties
- 2.4.5 Trading Partner Data Interchange Attributes
- 2.4.6 Link Directories to a Trading Partner
- 2.4.7 Link Transformation Maps to a Trading Partner
- 2.4.8 Link Configurations to a Trading Partner
- 2.4.9 Outbound Numbering
- 2.5 Transformation Maps
-
3. Processing Sequences
-
3.1 Anatomy of a Processing Sequence
- 3.1.1 Activities and Transformation Maps
- 3.1.2 Variables
-
3.1.3 Built-in Variables
- Using the System Property Built-in Variables
- Using the Trading Partner Built-in Variables
- Trading Partner (*TRADINGPARTNER) Built-in Variable Qualifiers
- Using the Transformation Map Built-in Variables
- Transformation Map (*TRANSFORM) Built-in Variable Qualifiers
- Using the Transaction Document Built-in Variables
- Transaction Document (*TXDOC) Built-in Variable Qualifiers
- 3.1.4 Processing Directives
- 3.1.5 Parameters
- 3.2 Work With Processing Sequences
- 3.3 Work With Processing Sequence Version History
- 3.4 Use the Processing Sequence Editor
-
3.5 Run a Processing Sequence
- 3.5.1 Run a Processing Sequence from the LANSA Composer client
- 3.5.2 Run a saved Processing Sequence "shortcut" from a client computer
- 3.5.3 Run a Processing Sequence from the Operations Console
- 3.5.4 Run a Processing Sequence using the COMPOSER command
- 3.5.5 Run a Processing Sequence using a Run Control File
- 3.5.6 Run a Processing Sequence from a LANSA application
- 3.5.7 Run a Processing Sequence by calling the Web Service function
- 3.5.8 Run a Processing Sequence using the DXP1FN1 function
- 3.6 Restart a Processing Sequence Run
- 3.7 Review the Processing Sequence Log
-
3.1 Anatomy of a Processing Sequence
-
4. Transaction Document Processing
-
4.1 Transaction Document Processing Framework
- 4.1.1 Overview of the Transaction Document Processing Framework
- 4.1.2 Getting Started with the Transaction Document Processing Framework
- 4.1.3 Document Types and Document Standards
- 4.1.4 Trading Partner support for Transaction Document Processing
- 4.1.5 Activities for Transaction Document Processing
- 4.1.6 Processing Sequences for Transaction Document Processing
- 4.1.7 Transformation Maps for Transaction Document Processing
- 4.1.8 Pre-built EDI X12 solution components
- 4.1.9 Application program interfaces (APIs)
- 4.2 LANSA Composer Document Manager
-
4.1 Transaction Document Processing Framework
-
5. Using aXes Terminal Server with LANSA Composer
- 5.1 What can I use the aXes Terminal Server Activities for?
- 5.2 Requirements for using The aXes Terminal Server Activities
- 5.3 When to use the aXes Terminal Server Activities
- 5.4 Things you should understand about the aXes Terminal Server Activities
- 5.5 Overview of aXes Terminal Server Activities
- 5.6 Using aXes Terminal Operations Scripts
- 5.7 Processing Sequence Example
- 6. Deploying Solutions for LANSA Composer
- 7. Operations
- 8. Administration and Housekeeping
-
9. Develop Custom Activities for LANSA Composer
- 9.1 Plan Your Custom Activity
- 9.2 Define the Activity to LANSA Composer
- 9.3 Create the Activity Processor
- 9.4 Test your Activity
- 9.5 Deploy your Custom Activity
-
9.6 Develop a Custom Activity Processor
- 9.6.1 Before you Begin your Custom Activity
- 9.6.2 Generate Skeletal RDMLX Code
- 9.6.3 Names
- 9.6.4 The Ancestor Class - DXACTBAS1
- 9.6.5 Load and Unload
- 9.6.6 Initialize, Terminate and Execute
- 9.6.7 Access the Variable Pool
- 9.6.8 Understand Activity Parameters
- 9.6.9 Implement an Activity Processor for an Iterator Activity
- 9.6.10 Supporting Restartable Activities
- 9.6.11 Use the Java Service Manager
- 9.6.12 Signal an Event
- 9.6.13 Set the Activity Return Code
- 9.6.14 Use Logging Services
- 10. Tips and Techniques for Success with LANSA Composer
-
LANSA Composer Tutorials
- LIC001 - Introduce Composer Client & Validate Environment
- LIC002 - Create a Processing Sequence
-
LIC003 - Create a Transformation Map
- Step 1. Create a Transformation Map Registration
- Step 2. Edit the Transformation Map
- Step 3. Identify the xml source for the Transformation Map
- Step 4. Identify the Target Database for the Transformation Map
- Step 5. Map the Input xml to the Target Database
- Step 6. Prepare your Transformation Map for use within Composer
- Step 7. Set up the Database Configuration
- Summary
- LIC004 - Add the Transformation to the Processing Sequence
- LIC005 - Set up a Trading Partner
- LIC006 - Add Email Acknowledgement to Processing Sequence
-
LIC007 - Extract Database to CSV File
- Step 1. Create Transformation Map
- Step 2. Define Transformation Map
- Step 3. Define an SQL Where condition and input parameter
- Step 4. Prepare Transformation Map
- Step 5. Create Processing Sequence
- Step 6. Run the Processing Sequence
- Step 7. Run Composer CL Command (Optional)
- Step 8. Run Processing Sequence from a shortcut (optional)
- Summary
- LIC008 - Processing via Email
-
LIC009 - Handle multiple requests via an email attachment
- Step 1. Create FTP configuration
- Step 2. Create Server Folders
- Step 3. Create Request and Response Sample Files
- Step 4. Create Transformation Map
- Step 5. Create Processing Sequence
- Step 6. Execute and Test the Processing Sequence
- Step 7. Handling multiple messages and response xml files - Optional
- Summary
- LIC010 - Calling a Processing Sequence (Optional)
- LIC011 - Email notification service
-
Appendix A. Install or Upgrade LANSA Composer
- LANSA Composer Requirements
- LANSA Composer Server on IBM i
-
LANSA Composer Server on Windows
- Before You Begin Checklist
- Plan Your Upgrade from LANSA Composer Version 4.0
- Create a Database for a New LANSA Composer installation
- Start the Installation Program
-
Install or Upgrade LANSA Composer Windows Servers Software
- Welcome to the LANSA Composer Server Setup Wizard
- Installation Scope
- Destination Folder
- Setup the Application
- Setup the Local Database
- User Id
- Web Sites for IIS Plug-In
- Web Site Virtual Folders
- Communication Ports
- Choose Setup Type
- Ready to install LANSA Composer Server
- Installing LANSA Composer Server
- Completed the LANSA Composer Server Setup Wizard
- Completing LANSA Composer Server Setup
- LANSA Composer Files Location
- LANSA Composer Files Network Path
- Import Supplied Definitions
- Ready To Install
- Installing LANSA Composer Files and Data
- LANSA Composer Files and Data Have Been Installed
- Repair an Existing LANSA Composer Installation
-
Complete the Installation
- Restore Configurations for LANSA for the Web applications
- Remove LANSA Composer Version 4.0
- Remove LANSA Composer database tables from the earlier version
- Apply Licenses
- Configure Network Share for use by LANSA Composer Clients
- Grant Database Permissions to the Web User
- Configure IIS to Serve the LANSA Composer Web Components
- Running the LANSA Composer Client on the Windows Server
- Services Used by the LANSA Composer Windows Server
- LANSA Composer Client on Windows
- Uninstall LANSA Composer Client on Windows
- Appendix B. License LANSA Composer
-
Appendix C. The Mapping Tool
- Learn about the Mapping Tool
- Overview of the Mapping Tool
- Mapping Tool Requirements
-
Connecting to databases in Transformation Maps
- Connecting to databases while defining a Transformation Map using ODBC or ADO
- Connecting to databases while defining a Transformation Map using JDBC
- Connecting to Databases while Executing a Transformation Map using JDBC
- Database Connectivity Components and Drivers
- Example Database Connections for IBM DB2 for i5/OS
- Example Database Connections for Microsoft Access
- Example Database Connections for Microsoft SQL Server
- Example Database Connections for Oracle
- Supported Functionality of the Mapping Tool
- Supported Versions of the Mapping Tool
- Appendix D. Commands to Invoke LANSA Composer
- Appendix E. Using LANSA Composer with LANSA Applications
-
Appendix F. The LANSA Composer Request Server
- What You Need to Know About Requests Processed Through the LANSA Composer Request Server
- How the LANSA Composer Request Server for IBM i Works
- How the LANSA Composer Request Server for Windows Servers Works
- Connecting to the LANSA Composer Request Server on a Remote System
- LANSA Built-in Functions that use the LANSA Composer Request Server
- LANSA Programming Considerations for Called Functions
- Configuring the LANSA Composer Request Server for IBM i to Suit Your Needs
- Appendix G. National Language and Multilingual Support in LANSA Composer