Beruflich Dokumente
Kultur Dokumente
Axway Automator
Version 3.6
11 March 2013
Copyright Axway Software, 2013
All rights reserved.
This documentation describes the following Axway software: Axway Automator 3.6
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer
language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior
written permission of the copyright owner, Axway Software S.A.
This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information
in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway Software
S.A. may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this
document. Axway Software S.A. does not warrant that this document is error free.
Axway Software S.A. recognizes the rights of the holders of all trademarks used in its publications.
The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are
provided for your convenience only. Axway Software S.A. does not control, endorse or guarantee content found in such sites. Axway
Software S.A. is not responsible for any content, associated links, resources or services associated with a third-party site.
Axway Software S.A. shall not be liable for any loss or damage of any sort associated with your use of third-party content.
Contents
1 Introduction ............................................................................................................................................................ 3
2 Automator domain server ..................................................................................................................................... 4
Overview .................................................................................................................................................. 4
Prerequisites ............................................................................................................................................. 4
Java requirements .................................................................................................................................. 4
Architecture ........................................................................................................................................... 4
Managing the domain server ....................................................................................................................... 6
Default ports .......................................................................................................................................... 6
Starting the domain server ...................................................................................................................... 6
Stopping the domain server ..................................................................................................................... 6
3 General configuration ............................................................................................................................................ 8
Domain server ........................................................................................................................................... 8
Config directory ...................................................................................................................................... 8
Bin directory .......................................................................................................................................... 9
4 Specific configuration ......................................................................................................................................... 10
JD Edwards server ................................................................................................................................... 10
PeopleSoft .............................................................................................................................................. 12
Pericles ................................................................................................................................................... 12
SAP ................................................................................................................................................... 12
Web Service ............................................................................................................................................ 13
Axway Transfer ....................................................................................................................................... 14
Axway Process Manager ........................................................................................................................... 14
5 APIs ....................................................................................................................................................................... 15
cmdNtApiDServer (Windows only) ............................................................................................................. 15
cmdApiDServer (.bat or .sh) ................................................................................................................ 15
6 Domain server properties ................................................................................................................................... 16
Server.properties file ................................................................................................................................ 16
Tcp_udp.properties file............................................................................................................................. 18
Sap.properties file .................................................................................................................................... 19
mft.properties file .................................................................................................................................... 20
Movex.properties file ................................................................................................................................ 20
Pericles.properties file .............................................................................................................................. 21
Jdbc.properties file .................................................................................................................................. 21
Jde.properties file .................................................................................................................................... 22
pstools.properties file ............................................................................................................................... 23
ws.properties file ..................................................................................................................................... 23
Overview
The Automator domain server enables you to manage the submission and monitoring of jobs on various ERPs
and / or in jobs of other Axway products.
When graphs contain objects specific to ERPs, the production server sends the submission to the relevant
domain server.
In the case of an internal connector to the Axway platform, the domain server is used as an interface between
the two products.
The production servers manage the jobs in terms of implementation constraints and Automator domain servers
run them.
Prerequisites
Java requirements
The installation of a domain server for the use of connectors for the different ERPs (SAP, PeopleSoft, JDE, and
Pericles), the Web Services connectors and Movex, as well as the Axway MFT products and Process Manager
requires a Java Runtime Environment (JRE).
For Automator 3. 6.0, Java version must be 1.7.0.
Architecture
Automator is based on a client / server architecture. Modeling servers, production servers, and domain servers
use the TCP/IP and UDP protocols to communicate.
It is possible to use a domain server for several production servers.
A production server can communicate with multiple domain servers.
A Domain server can communicate with multiple ERP and Axway products.
From version 3.6.0, the management of the external applications (ERPs or Axway products) is performed via the
Domain servers objects and Connections objects.
Use the management console to locate the list of known and connected servers:
To validate the correct configuration of a domain server (after it is started), access this console and synchronize
the corresponding domain server. It is available when it appears in orange.
Domain server
The domain servers are the systems which communicate with the ERPs interface or other Axway products.
From the Automator GUI you have to configure each domain server and select the connectors to run and
monitor.
Refer to the Configuration Guide.
Use the Console Management to:
Access and update properties files for technical configuration of the Domain Server.
Access and update properties files for ERP connector types used by this Domain Server.
Before you start the domain server for the first time, you must do the following.
Config directory
Modify the .properties files according to the connectors used (refer to the specific
sections).
It is recommended to use the Management Console from the Automator GUI to
configure these files (Domain Server level).
You can assign an Alias to the domain server in the server.properties file:
# Change the local host name
HOSTNAME=myalias
You can change the default ports in the tcp_udp.properties file:
# Port management
# TCP port
TCP_PORT=12515
# UPD receiving port
UDP_PORT = TCP_PORT + 1
# Acknowledgement receiving port
UDP_AR_PORT = UDP_PORT +1
Bin directory
1. Copy the set_env.bat script (or set_env.sh depending on the platform) from the
<Instal_Dserver_path>/bin/default directory into the
<Instal_Dserver_path>/bin directory.
2. For HP-UX and Solaris 64-bit platforms that use JRE 64-bit, remove the comment
character (#) in the set_env.sh script for the following parameter:
#SWITCH_64BITS=-d64
3. When you start the server, you must specify the JVM to use via the definition of the
JAVA_HOME variable and the specification of the path by doing one of the
following:
o Define the variables at system level
SET JAVA_HOME=C:\Program Files\Java\jdk1.7.0_01
SET PATH=%JAVA_HOME%\bin;./lib/sap;%PATH%
UNIX environment
JAVA_HOME=/testrdq/java/jdk1.7.0_01; export JAVA_HOME
PATH=$JAVA_HOME/bin:$PATH; export PATH
o Define the variables directly in the set_env.bat file for Windows and set_env.sh file for UNIX.
REM # Set java HOME
REM #####################################
set JAVA_HOME=C:\Program Files\Java\jdk1.7.0_01\jre
echo %JAVA_HOME%
REM
REM #####################################
REM # set path for java executable
REM #####################################
set PATH %JAVA_HOME%\bin;./lib/sap;%PATH%
echo %PATH%
JD Edwards server
Only on Windows can you connect an Automator production server to a JD Edwards server through the domain
server to allow submission of jobs to that JD Edwards server (UBE / Report). The connection is made via One
World, which involves the use of the One World SDK.
The domain server must be installed on the same machine as the JD Edwards Enterprise Server.
Refer to the Configuration Guide to configure a Connection Object for a JDE connector.
Service: For Windows, the domain server must be started by the JDE user account on the machine.
For the JDE connector, you must modify some of the files of the server domain config directory:
server.properties:
USE_ERP_JDE=1
jdbc.properties
Specify the parameters depending on the data base used by JDE.
Example for Oracle
DATABASE_TYPE=oracle
JDBC_DRIVER=oracle.jdbc.driver.OracleDriver
JDBC_URL=jdbc:oracle:thin:@localhost:1521:PSOFTONE
JDBC_USER=JDE
JDBC_PASSWD=JDE
Read permissions on tables are sufficient.
jde.properties
Specify the path to the runubexml object on the JDE Enterprise Server . (for
Windows, do not forget to use double backslashes.)
Example: ERP_JDE_PATH= D:\\PeopleSoft\\ddp\\E811\\system\\bin32
Specify the path to the JDE logs.
Example: ERP_JDE_LOG_PATH=D:\\PeopleSoft\\ddp\\E811\\PrintQueue
On UNIX, enter the JDE user to launch runubexml. This user must have execute permissions on the
.../DServer/xml/jde/ directory shells as well as read/write rights on the .../DServer/xml/jde/inputxml and
.../DServer/xml/jde/output directories.
JDE_SERVER_USER= psft811
On AS/400, specify the JDE library.
Example: ERP_JDE_BIB=E811sys
On all operating systems, specify where to search for the information required to execute the requests.
SQL_JDEGETSTATUS=SELECT JCJOBSTS FROM SVM811.F986110 WHERE JCJOBNBR = ?
SQL_JDEGETQUEUE=SELECT JCJOBQUE, JCPRTQ FROM SVM811.F986110 WHERE
JCJOBNBR = ?
SQL_JDEGETQUEUETYPE=SELECT QCQTYPE FROM SY811.F986130 WHERE QCJOBQUE =
? AND QCPORTNM = ? AND QCEXEHOST LIKE ?
http://www.microsoft.com/downloads/details.aspx?FamilyID=99b21b65-e98f-4a61-b811-
19912601fdc9&displaylang=en.
Copy the of sqljdbc.jar library from the <install_repository>\sqljdbc_2.0\<lang>\ into the DServer/lib/jdbc
directory.
PeopleSoft
There are no specific parameters to set in the domain server for the PeopleSoft connector.
Refer to the Configuration Guide to configure a Connection Object for a PeopleSoft connector.
To ensure compatibility with the PeopleSoft server, copy the psjoa.jar from the PeopleSoft server into the
DServer/lib/common directory of the domain server.
Pericles
You can interface an Automator production server with Pericles through the domain server. The interface with
Pericles is not done through a Java API but by direct submission of requests provided by Pericles via the HTTP
protocol.
Refer to the Configuration Guide to configure a Connection Object for a Pericles connector.
SAP
Refer to the Configuration Guide to configure a Connection Object for an SAP connector.
The libraries needed to run the SAP connector must be retrieved from the SAP site
(https://service.sap.com/connectors). To access this URL you will need to have a SAP Service Market Place
account. Select SAP Java connector/Tools and Services.
Download SAP JC0 2.1.x file compatible with your OS and architecture regarding the Domain server host.
Uncompress it in the DServer/lib/sap directory.
Java Runtime
OS-related information available and version of Java installed on the machine.
Versions
java version
Version of the installed Java SAP connector.
Information for middleware and Jco library must be specified if the connector has been correctly installed.
Paths
This section contains the installation directory of the Java APIs for the SAP connector.
You can also retrieve the same information in console mode via the following commands:
java -jar {sapjco-install-path}/sapjco.jar stdout
or
java -classpath {sapjco-install-path}/sapjco.jar com.sap.mw.jco.About stdout
No exceptions or errors should be generated and for all versions found on the machine version number and
date must be returned.
Web Service
Refer to the Configuration Guide to configure a Connection Object for a Web Service connector.
For this connector, you can change some of the properties of the ws.properties file located in the config
directory for the domain server (Number of Threads - Timeout...).
You must install a Web server with axis. You can use the jetty server and the axis2 libraries provided in the
Automator_V3.6.0\tools\websrv directory:
Axway Transfer
Refer to the Configuration Guide to configure a Connection Object for a MFT connector.
No specific settings exist in the domain server for the Axway Transfer connector. The other parameters for an
MFT environment will be set during the modeling of a job of this type.
The Process Manager API is the link with the runtime environment of Process Manager. The configuration files
are located in the xpmServer/XDK/conf directory.
When the main server is stopped, you can use the API to execute a database request.
Server.properties file
Assign an Alias to the domain server
Forces the domain server to use a specific name as hostname during communications with production servers.
#HOSTNAME=
Default: Line is a comment when the line starts with a # character.
If properties are not present in the file or commented out or blank, the hostname used is the local name
retrieved by the program..
Note: If specified, this name must be an alias of the IP Address of the host of the domain server in the DNS
or in any HOSTS files used by the production servers.
Check of status
Time to wait between two status checks.
CHECK=
Default: 100 milliseconds.
Close a connection
Time to wait before closing a connection to an ERP that is not used anymore.
PURGE_ENV_WITH_NO_JOB=
Default: 15 minutes.
Garbage collector
Time to wait before two Java garbage collector calls.
TRACKER_GC=
Default: 15 minutes.
Activate debug
Coupled with DEBUG log level, it forces the domain server to generate more specific
logs about the status check.
ENV_RUNNABLE_DEBUG=
Default: false (else true).
Warning: To be activated only if R&D requests it, logs are spammed very quickly.
Tcp_udp.properties file
Assign specific ports to the domain server
TCP port on which the domain server is listening for request.
TCP_PORT=
Default: 10515.
Note: The domain server computes the UDP_PORT and UDP_AR_PORT used for reception of UDP request
and acknowledgement relatively to the TCP_PORT value.
UDP_PORT = TCP_PORT + 1
UDP_AR_PORT = TCP_PORT + 2
Charset code
Charset used by the domain server.
CODE_PAGE=
Default: iso-8859-1.
UDP purge
Time to keep a sent UDP before deleting it.
UDP_SND_PURGE=
Default: 60 minutes.
Time to keep a received UDP before deleting it.
UDP_RCV_PURGE=
Default: 60 minutes.
Sap.properties file
Audit level
Log level to set on the SAP system associated with each SAP connection made by this
domain server.
SAP_ENVIRONMENT_AUDIT_LEVEL=
Default: 0 (else 1,2,3).
Note: This property can affect the performance of each SAP system to which this domain server is connected.
Job interception
Allows the domain server to use the job interception functionality on the SAP system.
INTERCEPTION=
Default: -1 (else 0, 1).
With:
-1: Use the default activation settings of the SAP system
0: Deactivate the functionality for connection from this domain server
1: Activate the functionality for connection from this domain server.
Note: If this function is deactivated the domain server is not able to intercept jobs.
Warning: The recovery of the chain status holds the chain and calculates the status of all processes that
make up the chain.
mft.properties file
Checking the status of a transfer
Performance improvement: the way you check the status of a transfer has changed and is now more powerful.
The transfer is found directly in the catalog by using the IDTU.
To comply with older versions, there is the possibility to provide information regarding the MFT version in the
properties file. If the version is greater or equal to 230, the new way described above will be used.
MFT_VERSION=
Default: 230
Movex.properties file
Status checks
Time to wait between two status checks.
STATUS_CHECK_INTERNAL=
Default: 5 seconds.
Note: Make sure not to choose too little a value because the APIs used to connect to this product are big
performance consumers.
API name
Name of the API module to call.
M3_PROGRAM=
Default: SHZ001MI.
Note: This property must only be modified in agreement with Automator R&D.
Properties
Parameters to hide in the GUI for a specific treatment.
Default format: TreatmentName.ParametersName=true.
Examples:
ARS330.ZWDIVI=true
ARS330.ZWACDT=true
ARS330.ZWVTXT=true
Pericles.properties file
Status checks
Time to wait between two status check.
CHECK_PERICLES_STATUS=
Default: 1 means 10 seconds (basic unit: Tenseconds).
Note: The APIs used to connect to this product are big performance consumers.
Specifics Properties
They are used to create the XMLs sent to Pericles and are present in this file for convenience.
Jdbc.properties file
This file enables the user to configure a connection to a database using jdbc drivers. This file is only used as
part of the JDE connector at the moment.
Database
Type of database to connect to.
DATABASE_TYPE=
oracle, as400, db2 or sqlserver.
JDBC class
Class to use as jdbc driver.
JDBC_DRIVER=
URL
URL used to access to the database.
JDBC_URL=
Authentification
User to access to the database.
JDBC_USER=
User password to access to the database.
JDBC_PASSWD=
Jde.properties file
Response check
Number of times that the domain server must check the presence of a response file.
WAIT_FILE_SCAN=
Default: 4 times.
Time to wait between two checks of presence of a response file.
WAIT_FILE_SLEEP=
Default: 500 milliseconds.
Path
Path to the runubexml API executable in the JDE server.
ERP_JDE_PATH=
Logs path
Path to the logs files generated by the JDE server.
ERP_JDE_LOG_PATH=
User
JDE user to launch runubexml API on UNIX system.
JDE_SERVER_USER=
UBE Version
Request to retrieve UBE version in the JDE database.
SQL_JDEVERSION=
Default: SELECT VRVERS, VRJD FROM @ENV.F983051 WHERE VRPID = '@UBE' ORDER BY VRVERS.
Status checks
Request to retrieve job status in the JDE database.
SQL_JDEGETSTATUS=
Default: SELECT JCJOBSTS FROM SVM#.F986110 WHERE JCJOBNBR = ?
JOBQ
Request to retrieve job queue in the JDE database.
SQL_JDEGETQUEUE=
Default: SELECT JCJOBQUE, JCPRTQ FROM SVM#.F986110 WHERE JCJOBNBR = ?
JOBQ Type
Request to retrieve job queue type in the JDE database.
SQL_JDEGETQUEUETYPE=
Default: SELECT QCQTYPE FROM SY#.F986130 WHERE QCJOBQUE = ? AND QCPORTNM = ? AND QCEXEHOST
LIKE ?
Interoperability
Activate interoperability with JDE.
USE_INTEROP=
Default: 0 for no (1 for yes).
Use old class loader style.
B9_LOADER=
Default: 0 for no (1 for yes).
Encoding code
EBCDIC_ENCODING=
Default: CP037
Logs format
Logs are generated in XML format.
XML_LOGS=
Default: 0 for no (1 for yes).
pstools.properties file
This file is empty and must be seen as a placeholder to prevent the domain server to generate errors in logs.
This file can be replaced with the one from the PeopleSoft application server.
Using the supplied empty file cause the PeopleSoft API to use default settings.
ws.properties file
Thread number
Number of WebService executer threads running in parallel.
NB_EXECUTER=
Default: 3.
Timeout
Time for waiting the thread end.
END_THR_TIMEOUT=
Default: 60 seconds.
WebServices directory
Path to the directory where PKI_JKS.properties and PM_Standalone.properties are.
Can be absolute or relative to the DServer directory.
WEBSERVICES_HOME=
Default: webServices.
Security Type
Type of keystore used to retrieve keys and certificates.
SECURITY_KEYSTORE_TYPE=
Passport properties
Mandatory properties to interact with passport as keystore (PM and PS).
passport.pm.host=
passport.pm.port=
passport.pm.login=
passport.pm.password=
passport.pm.password.encrypted=
passport.pm.local.identity=
passport.ps.host=
passport.ps.port=
passport.ps.login=
passport.ps.password=
passport.ps.password.encrypted=
passport.ps.entity.alias=
passport.connection.secure=
passport.connection.keystore.path=
passport.connection.keystore.type=
passport.connection.keystore.password.encrypted=
passport.connection.keystore.password=