Control-D Agent 9.0.21 User Guide
Control-D Agent 9.0.21 User Guide
9.0.21
User Guide
August 2022
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain
information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada
Address BMC SOFTWARE INC Telephone 713 918 8800 Fax 713 918 8000
2103 CITYWEST BLVD 800 841 2031
HOUSTON TX
77042-2827
USA
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
2
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER
THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and
computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Field
52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025,
as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD,
HOUSTON TX 77042-2827, USA. Any contract notices should be sent to this address.
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting
Customer Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at
(http://www.bmc.com/support). From this website, you can:
Read overviews about support services and programs that BMC offers
Find the most current information about BMC products
Search a database for issues similar to yours and possible solutions
Order or download product documentation
Download products and maintenance
Report an issue or ask a question
Subscribe to receive proactive e-mail alerts when new product notices are released
Find worldwide BMC support center locations and contact information, including e-mail addresses, fax
numbers, and telephone numbers
Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call
800 537 1813 or send an e-mail message to [email protected]. (In the subject line, enter
SupID:<yourSupportContractID>, such as SupID:12345). Outside the United States and Canada,
contact your local support center for assistance.
Before contacting BMC
Have the following information available so that Customer Support can begin working on your issue
immediately:
Product information
• Product name
• Product version (release number)
• License number and password (trial or permanent)
Operating system and environment information
• Machine type
• Operating system type, version, and service pack or other maintenance level such as PUT or PTF
3
• System hardware configuration
• Serial numbers
• Related software (database, application, and communication) including type, version, and service
pack or maintenance level
Sequence of events leading to the issue
Commands and options that you used
Messages received (and the time and date that you received them)
• Product error messages
• Messages from the operating system, such as file system full
• Messages from related software
License key and password information
If you have questions about your license key or password, contact BMC as follows:
(USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail
message to [email protected].
(Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20
354 8702, or send an e-mail message to [email protected].
(Asia-Pacific) Contact your BMC sales representative or your local BMC office.
Third party Software
For the provisions described in the BMC License Agreement and Order related to third party products or
technologies included in the BMC Product,
seehttps://docs.bmc.com/docs/display/workloadautomation/Control-M+Workload+Automation+Document
ation and click Third-party software (TPS).
4
Contents
Introduction to Control-D/Agent ........................................................................................ 6
Setting up Control-D/Agent .......................................................................................................... 6
5
1
1
Introduction to Control-D/Agent
Control-D/Agent administers the transfer of files and reports from distributed system computers to the
mainframe or to other distributed system computers. The transfer of files is facilitated by components of
Control-D/Agent that are described in this manual (Control-D file watcher, Control-D file transfer client,
and Control-D file transfer server).
Control-D/Agent manages file transfer by monitoring predefined directories to detect newly arrived files
(for example, business reports) in the local file system. Pattern matching on file names is used to identify
individual files or categories of files destined for particular destinations.
Setting up Control-D/Agent
This procedure describes how to set up Control-D/Agent.
6
2
2
Control-D file watcher
Control-D file watcher (file watcher) polls specified directories to detect new files (e.g., reports) as they
arrive in the local file system. Depending on file identification specifications (for example,
Branch_20*.*av would specify all files beginning with the name Branch_20 and having a suffix that
ends with av), files matching the specifications would be sent to their destinations by invoking Control-D
file transfer client to handle the sending processing.
On Windows, the file watcher is started as a Window service. On UNIX, it is started from the command
line.
Once started, the file watcher continually polls specified directories for newly arrived files that fit pattern
matching criteria.
When a file that matches polling criteria is found, the action designated to process the file is automatically
started using the parameters defined in the file watcher GUI. Processing can take place concurrently as
more matching files arrive.
The file watcher GUI allows you to specify what to do with processed files. If a file is processed
successfully, you can have it deleted or placed in the sub-directory, Done.
If processing fails, the file is placed in the sub-directory, Failed.
NOTE: If you define more than one matching mask for the same directory, matching reports will be
transferred randomly to the specified hosts.
7
Control-D/Agent User Guide
Parameter Description
Action Command line Command to process a matched file. This command includes
(Mandatory if the processing program name and its input parameters (e.g.,
parameter ProcessAndSend.sh %%FILE_PATH).
Destination is
Note:
not used.)
using the variable %%FILE causes the watched file
name to be substituted for the variable in the command.
using the variable %%FILE_PATH causes the watched
file path and the watched file name to be substituted for
the variable in the command.
Similarly, use of the %%INSTALLATION_PATH
variable causes the installation path to be substituted for
the variable.
(Mandatory if parameter Destination is not used).
8
Control-D/Agent User Guide
Parameter Description
Delete after execution Delete processed files. If left unchecked, processed files are
moved to the subdirectory done that is created automatically
under the polling directory to store removed files. The polling
directory security must allow file deletion for this parameter
to work.
Default: No
Directory path Polling directory - the directory in which to poll for new files
(e.g., programs/pollfiles).
Mandatory
Overwrite when done Overwrite processed files. files moved to subdirectory done
can overwrite existing files with identical names. Otherwise,
files with identical names are saved with a random number
added to the file name (e.g., a new version of the file abc.txt
might be saved as abc_985352). See also,
DeleteAfterExecution.
Default: No
9
Control-D/Agent User Guide
Parameter Description
Verification ready count Maximum number of times to check that a matched file is
complete. This check is necessary as the file may still be in the
process of being uploaded to the system.
Minimum number of completion checks: 1.
Maximum: 100.
Default: 3.
Mandatory
10
Control-D/Agent User Guide
Console - specific information such as starting, stopping, and runtime errors are written to the
console.
Log file - starting, stopping, runtime errors and warnings are written to a file.
Memory buffer - detailed information held in memory is dumped to a file if a severe error occurs.
File destinations and message levels can be configured in the Control-D/Agent component configuration
files in the <ctdAgentHome>\config directory:
Control-D file watcher - file_watcher_logging.cfg
Control-D file transfer client - ft_client_logging.cfg
Control-D file transfer server - ft_server_logging.cfg
Configuration instructions are provided inside the configuration files.
11
Control-D/Agent User Guide
12
3
3
Control-D file transfer client
Control-D file transfer client (file transfer client) is usually invoked automatically from Control-D file
watcher which monitors directories for incoming files and uses an internal file transfer client to send them
to the mainframe. BMC Software recommends using this method for all your file transfers. For more
information, see Control-D file watcher (on page 7).
13
4
4
Control-D file transfer server
Control-D file transfer server is responsible for receiving files on a distributed systems computer.
Received files are stored in the directory specified by the WorkingDir parameter in the ft_server.config
file.
14
Control-D/Agent User Guide
Parameter Description
RefreshConfigurati Time interval (in minutes) for re-reading the configuration file.
onInterval
15
5
5
Control-D/Agent installation
You can install Control-D/Agent on UNIX (GUI or console mode) or on Windows, either interactively or
silently.
The silent installation procedure allows you to set up an XML script file with all the necessary parameter
information to install Control-D/Agent using a single command. This is especially useful when the product
needs to be installed on several computers using the same configuration.
You can download the installation package in various formats from http://www.bmc.com/available/epd.
For more information, see the Control-D/Agent Release Notes.
The following topics describe how to prepare for the installation and how to install or uninstall
Control-D/Agent on UNIX or Windows:
Preparing an external Java installation (on page 16)
Control-D/Agent installation on UNIX (on page 17)
Control-D/Agent installation on Windows (on page 19)
Uninstalling Control-D/Agent (on page 21)
16
Control-D/Agent User Guide
17
Control-D/Agent User Guide
18
Control-D/Agent User Guide
19
Control-D/Agent User Guide
20
Control-D/Agent User Guide
Uninstalling Control-D/Agent
The uninstall process attempts to delete all Control-D/Agent files and folders/directories. In cases where
items cannot be deleted (locked or in used by another process), you can safely deleted them manually
after the installation process has completed.
The following procedures describe how to uninstall Control-D/Agent from UNIX and Windows:
Uninstalling Control-D/Agent from UNIX (on page 21)
Uninstalling Control-D/Agent from Windows (on page 21)
21
6
6
Control-D/Agent SSL configuration
SSL is used to ensure security when transferring files from distributed systems computers to the
mainframe.
NOTE: Control-D/Agent supports TLS Protocol version 1.2.
Control-D file transfer client, Control-D file transfer server, and Control-D for z/OS should have certificates
signed by the same CA (Certificate Authority). Control-D file transfer client, Control-D file transfer server,
and Control-D for z/OS DEMO certificates are signed by the same DEMO CA. BMC Software recommends
that you replace the demo certificates with a certificate signed by a approved CA in your organization.
Enabling SSL
This procedure describes how to enable SSL on Control-D file transfer client and server.
22
Control-D/Agent User Guide
Parameter Description
If you want to change the encrypted password, see: Changing the encrypted password (on page 23).
23
Control-D/Agent User Guide
24