WebSphere Transformation Extender Utility Commands (Part III)

Transcription

1 IBM Software Group WebSphere Transformation Extender Utility Commands (Part III) Tim Rabbitt Websphere Transformation Extender L2 Support February 7, 2013 WebSphere Support Technical Exchange Click to add text

2 Agenda The presentation covers the Utility Commands that are available with WebSphere Transformation Extender (WTX): Why use them What can they do for you Configuring your environment to use Utility Commands Types of Utility Commands Questions and Answers WebSphere Support Technical Exchange 2

3 Why use them Automate processing (compiling, analyzing, converting) of large volumes of maps/trees/systems via batch scripts Use WTX components without the need for X-Windows or Windows GUIs WebSphere Support Technical Exchange 3

4 What can they do for you Analyze type trees Import and export type trees, map source files and systems Convert type tree properties from bytes to characters Compile maps Generate a map report HTML file containing information about a map source file Deploy systems Create one map that can transform any input data into XML output, and a second map that can transform the XML that the first map produced into output data in a format described by the type tree that you specified Edit the Resource Registry Start, Stop, Administer the Launcher WebSphere Support Technical Exchange 4

5 Configuring your environment to use Utility Commands Windows Set the environment variable PATH to reference your WTX installation Set PATH=C:\IBM\WebSphere Transformation Extender 8.4;%PATH% UNIX Run the WTX setup command or set environment variables Setup Command. <path to WTX installation directory>/setup Set environment variables PATH and LD_LIBRARY_PATH/LIBPATH to reference the WTX directories. PATH: export PATH=/opt/ibm/wtx/bin:$PATH WebSphere Support Technical Exchange 5

6 Configuring your environment to use Utility Commands LIBPATH (AIX) export LIBPATH=/opt/ibm/wtx/libs:$LIBPATH LD_LIBRARY_PATH (Solaris, Linux, zlinux, HP-UX) export LD_LIBRARY_PATH=/opt/ibm/wtx/libs:$LD_LIBRARY_PATH WebSphere Support Technical Exchange 6

7 Configuring your environment to use Utility Commands Utility Commands return success/failure in an environment variable: Windows: ERRORLEVEL UNIX: status Utility Commands return the following values in the ERRORLEVEL or status environment variable: 0 - This value indicates that the Utility Commands was successful. 1 - This value indicates that the Utility Commands was not successful. The ERRORLEVEL and status environment variable can also be used in batch and shell scripts to retrieve the value of the return code from the utilities. WebSphere Support Technical Exchange 7

8 Types of Utility Commands Utility Commands are grouped by functionality within WTX: Type Designer (1) Map Designer (1) Integration Flow Designer (1) XML (3) Resource Registry (3) Launcher Map Tuning (2) (1) Previously discussed in the WSTE presentation on 8/29/12, titled WebSphere Transformation Extender Utility Commands (Part I) (2) Map Tuning was discussed in the WSTE presentation on 8/15/12, titled Map Tuning Utilities and Debugging In Design Studio. (3) Previously discussed in the WSTE presentation on 2/6/13, titled WebSphere Transformation Extender Utility Commands (Part II) WebSphere Support Technical Exchange 8

9 Launcher Utility Commands launcheradmin.[bat sh] Administer the Launcher mgmtconsole.[bat sh] Configure the Management Console launcher.[bat sh] Start/Pause/Stop/Log/Trace Systems New functionality added with the release of WTX 8.4 that allows for the use of the Launcher Administration (launcheradmin) and the Management Console (mgmtconsole) utilities without the requirement of a graphics interface. New options added to the launcher utility to enable dynamic logging, tracing and list equivalent to the logging/tracing option with the Management Console. launcheradmin commands were covered in the February 6, 2013, WebSphere Transformation Extender Utility Commands (Part II) WSTE presentation WebSphere Support Technical Exchange 9

10 Management Console The Management Console (mgmtconsole) utility is used to list/add/edit/delete the Launcher definitions along with firewall and override configurations. Each launcher definition establishes a connection to one Launcher service. Windows: mgmtconsole.bat [options] UNIX: mgmtconsole.sh [options] mgmtconsole.{bat sh} specified with options, invokes the command line version of the utility. This is new with the release of WTX 8.4. mgmtconsole.{bat sh} without any options, starts the GUI version of the utility. Reads and/or updates the mgmtconsole.bin file WebSphere Support Technical Exchange 10

11 Management Console Syntax: {mgmtconsole.bat mgmtconsole.sh} [-help] [-list [launchers options all]] [-add name:launcher_name:host;host_name:login;login_name:pwd;password[;port:port] [;refresh:refresh_interval] ] [-delete launcher_name ] [-override name:launcher_name;oc:{enable disable};host:host_name;sp:status_port; cp:control_port ] [ firewall fc:{enable disable};fp:firewall_port] ] [-import properties_file] [-export properties_file] WebSphere Support Technical Exchange 11

12 Management Console The mgmtconsole options are divided into categories all of which read and/or write to the mgmtconsole.bin file. These options are: List Displays launcher definitions. Add Adds/Updates the specified Launcher. Delete Deletes the specified Launcher from the list of Launcher definitions. Override Overrides the Launcher service that is defined in the Management Console and enables a direct connection to the specified Launcher (z/os only). Firewall Enables/disables a firewall configuration for the Management Console and specifies a client port to be used by a Management Console that is behind the firewall. Import Specifies an XML file that contains properties to be imported to the mgmtconsole.bin file. Export Creates an XML properties file that is compliant with the MgmtConsole.xsd schema file. WebSphere Support Technical Exchange 12

13 Management Console -list -list Displays the specified options that are configured in the mgmtconsole.bin file. List Syntax: -list [launchers options all] List options: launchers Displays the Launcher information that is configured in the mgmtconsole.bin file options Displays the Override Configuration and Firewall options that are configured in the mgmtconsole.bin file. all Displays all of the Launcher information that is configured in the mgmtconsole.bin file If a list option is not specified, it has the same meaning as specifying the all option WebSphere Support Technical Exchange 13

14 Management Console -list -list launchers Displays the following Launcher information that is configured in the mgmtconsole.bin file (Management Console Launcher Edit): Launcher name Host name Launcher Port Refresh interval Login and password -list options Displays the following Launcher firewall and override information that is configured in the mgmtconsole.bin file (Management Console Tools Options): Firewall Configuration and port Launcher name Host name Control and Status Port Override Configuration -list all Displays both the launchers and options information WebSphere Support Technical Exchange 14

15 Management Console -list Example: mgmtconsole.bat list launchers (Management Console Launcher Edit) Management Console Settings Listing Launcher Definitions: Launcher Name: MyWindowsServer Host: localhost Port: 5015 Login: admin Password: admin Interval: 5 Launcher Name: MyAIXServer Host: aix61.company.com Port: 5055 Login: admin Password: admin Interval: 5 WebSphere Support Technical Exchange 15

16 Management Console -list Example: mgmtconsole.bat list options (Management Console Tools Options) Management Console Settings Listing Options: Firewall Firewall Configuration disabled Firewall Port: 7777 Launcher Overrides Launcher Name: MyWindowsServer Host: localhost Status Port: 7000 Control Port: 7002 Override Configuration: disabled Launcher Name: MyAIXServer Host: aix61.company.com Status Port: 7000 Control Port: 7002 Override Configuration: disabled WebSphere Support Technical Exchange 16

17 Management Console -add -add Adds/Updates the specified Launcher. If the Launcher definition already exists, updates the definition. Equivalent of Launcher New or Launcher Edit options from the Management Console GUI. Add Syntax: -add name:launcher_name;host:host_name:login;login_name:pwd;password [;port:port] [;refresh:refresh_interval] Add options: name:launcher_name Specifies the Launcher name host:host_name Specifies the Launcher service host name or IP address that is to be added/updated. login:login_name Specifies the login name for the Launcher service to be added/updated. The login name is the name that the Management Console uses to connect to the Launcher service. WebSphere Support Technical Exchange 17

18 Management Console -add -add options (continued) password:password Password associated with login_name port:port Specifies the port on which the Launcher service is to listen. The default port is refresh:refresh_interval Specifies the time interval, in seconds, that is used to refresh the system statistics that are displayed by the Management Console. The default refresh interval is five seconds. UNIX and z/os (USS) platforms must enclose add options in double quotes WebSphere Support Technical Exchange 18

19 Management Console-add WebSphere Support Technical Exchange 19

20 Management Console -delete -delete Deletes the specified Launcher defined in the Management Console. Equivalent of Launcher Delete from the Management Console GUI Delete Syntax: -delete launcher_name Delete Example mgmtconsole.bat delete mynewlauncher WebSphere Support Technical Exchange 20

21 Management Console -override -override Overrides the Launcher service and enables a direct connection to the specified Launcher. Accessed from the GUI with the Menu Bar Tools Options - Launchers option. This option applies to z/os only. Override Syntax: -override name:launcher_name;oc:{enable disable};host:host_name;sp:status_port; cp:control_port Override options: name:launcher_name Specifies the Launcher service/launcher name that is to be overriden. oc:{enable disable} Enables or disables the override configuration for the launcher definition. host:host_name Specifies the host name to be overriden. sp:status_port Specifies the numeric status port of a Launcher that is running on a z/os operating system. The default status port is WebSphere Support Technical Exchange 21

22 Management Console -override Override options (continued): oc:control_port Specifies the numeric control port of a Launcher that is running on a z/os operating system. The default control port is z/os (USS) platforms must enclose override options in double quotes Override example: mgmtconsole.sh override name:newl;oc:enable;host:my_z_server;sp:7010;cp:7012 (USS) WebSphere Support Technical Exchange 22

23 Management Console -firewall -firewall Enables/disables a firewall configuration for the Management Console and specifies a client port to be used that is behind the firewall. Accessed from the GUI with the Menu Bar Tools Options Firewall option. Firewall Syntax: -firewall fc:{enable disable};fp:firewall_port Firewall options: fc:{enable disable} Enables or disables the firewall configuration fp:firewall_port Specifies the client firewall port UNIX and z/os (USS) platforms must enclose firewall options in double quotes Firewall Example: mgmtconsole.bat firewall fc:enable;fp:10700 (Windows) mgmtconsole.sh firewall fc:enable;fp:10700 (UNIX and z/os USS) WebSphere Support Technical Exchange 23

24 Management Console -import and -export -import properties_file Specifies an XML file that contains properties to be imported to the mgmtconsole.bin file. If the mgmtconsole.bin file exists, the existing properties are updated and saved. If the mgmtconsole.bin file does not exist, a new mgmtconsole.bin file is created with the properties from the XML file. Port information related to the override and firewall settings can only be modified if they are in an enabled (true) state. -export properties_file Creates an XML properties file that is compliant with the MgmtConsole.xsd schema file. You can then edit this file and use the import option to implement configuration changes. Examples: mgmtconsole.bat export my_mgmt_configuration.xml mgmtconsole.bat import my_mgmt_configuration.xml WebSphere Support Technical Exchange 24

25 Launcher The Launcher (launcher) utility controls the Launcher. New functionality added with WTX 8.4 allows you to set trace and logging options as well list system information. Windows: launcher.bat [options] UNIX: launcher.sh [options] This new functionality: Does not impact the ini file Used only while the launcher is in a running state -list - List system files, components within each system, trace settings for each component in a system, and log settings for the system. -settrace Enables/disables trace flags for a component that is running under the specified system or compound system -setlogging Enables/disables launcher, connection manager and resource manager logging WebSphere Support Technical Exchange 25

26 Launcher Syntax (new options listed only): launcher.{bat sh} [-settrace launchername systemname systemfilename componentname trace {default on off} [-action {create append}] [-tracefile tracefile_name] ] [-setlogging launchername systemname logtype {launcher resmgr conmgr} logflags {[to tx ],[do dx],[wo wx],[fo fx],[io ix],[eo ex]}] [-list launchername [systemname [systemfilename [componentname]]] [-trace] [-logging]] Note that settrace, -setlogging and list are mutually exclusive (only one option is allowed in a command. WebSphere Support Technical Exchange 26

27 Launcher -list launcher list: Syntax: launcher.{bat sh} [-list launchername [systemname [systemfilename[componentname]]] [-trace] [-logging]] launchername The name of the Launcher that is defined in Management Console utility (mgmtconsole). The launchername variable identifies the host name, port, user name, and password of a particular Launcher definition. systemname The name of the system or group of systems running under one Launcher process. The systemname is defined with the Launcher Administration (launcheradmin) tool. systemfilename The name of an individual system file (.msl) that is running under the specified system and Launcher. componentname The name of an individual map component in the system file that is running on the specified system and Launcher. -trace Lists the trace settings for the specified component. -logging Lists the logging settings for the Launcher, Resource Manager, and Connection Manager for the system WebSphere Support Technical Exchange 27

28 Launcher -list Example: list the logging options for my84launcher launcher.bat -list my84launcher logging ************************************************************************* IBM WebSphere Transformation Extender Version: (14) Time: Wed Nov 21 18:36:20 EST 2012 ************************************************************************* Listing system information: my84test.msl Logging flags Launcher Trace: OFF Debug: OFF Info: OFF Warn: ON Error: ON Fatal: ON (output continued on next slide) WebSphere Support Technical Exchange 28

29 Launcher -list Resource Manager Trace: OFF Debug: OFF Info: OFF Warn: ON Error: ON Fatal: ON Connections Manager Trace: OFF Debug: OFF Info: OFF Warn: ON Error: ON Fatal: ON System MSL Files C:\IBM\WebSphere Transformation Extender 8.4\systems\my84test.msl Components my84system WebSphere Support Technical Exchange 29

30 Launcher -settrace launcher settrace: Syntax: launcher.{bat sh} [-settrace launchername systemname systemfilename componentname trace {default on off} [-action {create append}] [-tracefile tracefile_name] ] launchername The name of the Launcher that is defined in Management Console utility (mgmtconsole). The launchername variable identifies the host name, port, user name, and password of a particular Launcher definition. systemname The name of the system or group of systems running under one Launcher process. The systemname is defined with the Launcher Administration (launcheradmin) tool. In single launcher environments this value would be CompoundSystem. systemfilename The name of an individual system file (.msl) that is running under the specified system and Launcher (Fully qualfied path/name) componentname The name of an individual map component in the system file that is running on the specified system and Launcher. WebSphere Support Technical Exchange 30

31 Launcher -settrace launcher settrace (continued) trace default -trace on -trace off -action create -action append -tracefile tracefile_name Use the settings that are configured on the adapter command line in the map. This is the default option Turn on adapter tracing for all adapters, including RUN maps. Turn off adapter tracing. This option overrides the option that is defined in the map. Write all trace information to a new trace file. Append all trace information to an existing file, or create a new trace file if none exists. Specifies the name and path to a trace file. WebSphere Support Technical Exchange 31

32 Launcher -settrace Example: Enable adapter tracing for the launchername, my84launcher as defined in the management console that has the default system name of CompoundSystem where the msl is launcher.msl and save it to C:\temp\launcher_adapter_trace.txt. launcher.bat settrace my84launcher CompoundSystem C:\IBM\WebSphere Transformation Extender 8.4\systems\launcher.msl launcher trace on tracefile C:\temp\launcher_adapter_trace.txt WebSphere Support Technical Exchange 32

33 Launcher -setlogging setlogging options Syntax: launcher.bat launcher.sh} [-setlogging launchername systemname logtype {launcher resmgr conmgr} logoptions {[to tx],[do dx],[wo wx],[fo fx],[io ix],[eo ex]} ] launchername systemname -logtype launcher -logtype resmgr -logtype conmgr The name of the Launcher that is defined in Management Console utility (mgmtconsole). The launchername variable identifies the host name, port, user name, and password of a particular Launcher definition. The name of the system or group of systems running under one Launcher process. The systemname is defined with the Launcher Administration (launcheradmin) tool. In single launcher environments this value would be CompoundSystem The logging options apply to the Launcher. The logging options apply to the Resource Manager. The logging options apply to the Connection Manager. WebSphere Support Technical Exchange 33

34 Launcher -setlogging setlogging options (continued) logoptions Specifies the logging options. Multiple options must be delimited by commas. to tx Log/Do not log trace information (tx is the default) do dx fo fx eo ex io ix wo wx Example: Log/Do not log debugging information (dx is the default) Log/Do not log fatal error messages (tx is the default) Log/Do not log error messages. (ex is the default) Log/Do not log informational messages. (ix is the default) Log/Do not warning messages. (wx is the default) Enable launcher trace, debug, fatal, info and error logging. Disable warnings. launcher.bat setlogging mylauncher my84system logtype launcher -logoptions to,do,wx,fo,io,eo WebSphere Support Technical Exchange 34

35 Search APARs, Technotes and Info Center WTX Support Site: ibm.com/support/entry/portal/Overview/Software/WebSp here/websphere_transformation_extender WTX Documentation (Information Center, Release Notes) 01.ibm.com/software/integration/wdatastagetx/library/ WebSphere Support Technical Exchange 35

36 Encountering an issue - Open a PMR On-Line problem submission: WTX MustGather: 01.ibm.com/support/docview.wss?rs=2320&uid=swg WebSphere Support Technical Exchange 36

37 Summary Review on-line Web based documentation for Utility Command usage and examples. Part I of WTX Utility Commands including Type Tree, Map and IFD related commands was offered on August 29, 2012 and can be found on the WSTE site. Part II of WTX Utility Commands including Type Tree, Map and IFD related commands was offered on February 6, 2013 and can be found on the WSTE site. Visit the WTX support page for additional information: ibm.com/support/entry/portal/Overview/Software/WebSphere/ WebSphere_Transformation_Extender WebSphere Support Technical Exchange 37

38 Additional WebSphere Product Resources Learn about upcoming WebSphere Support Technical Exchange webcasts, and access previously recorded presentations at: Discover the latest trends in WebSphere Technology and implementation, participate in technically-focused briefings, webcasts and podcasts at: Join the Global WebSphere Community: Access key product show-me demos and tutorials by visiting IBM Education Assistant: View a webcast replay with step-by-step instructions for using the Service Request (SR) tool for submitting problems electronically: Sign up to receive weekly technical My Notifications s: 38

39 Connect with us! 1. Get notified on upcoming webcasts Send an to with subject line wste subscribe to get a list of mailing lists and to subscribe 2. Tell us what you want to learn Send us suggestions for future topics or improvements about our webcasts to wsehelp@us.ibm.com 3. Be connected! Connect with us on Facebook Connect with us on Twitter 39

40 Questions and Answers 40