This section explains the syntax provided for the commands that you can use to execute data linkage applications with Datareplicator.

Before you can use Datareplicator commands, you must specify environment variables. For details about the environment variables that need to be specified, see 2.4 Specifying environment variables (UNIX) or 2.8 Specifying environment variables (Windows).

Executing commands on Windows Vista or Windows Server 2008

If the UAC feature is used, the processing depends on whether you run the command prompt as an administrator. For details, see 2.10.1 Executing commands.

Table 7-1 Commands used to establish data linkage with Datareplicator lists the commands that are used to establish data linkage with Datareplicator. Table 7-2 Information that is output to the command log lists the information that is output to the command log.

Table 7-1 Commands used to establish data linkage with Datareplicator

Command type	Command	Function	When executable
			During HiRDB operation	During Datareplicator operation
Commands for handling the source Datareplicator	hdestart#1	Starts the source Datareplicator. When the -i option is specified, initializes the source Datareplicator environment but does not start the source Datareplicator.	N/A	Inactive OK#4
	hdestop#2	Terminates the source Datareplicator.	N/A	Only active
	hdeevent#2	Issues an event.	Only active	N/A
	hdestate#2	Outputs the source Datareplicator's status to the standard output.	N/A	Only active
	hdeprep#2	Analyzes the extraction definition and creates an extraction definition preprocessing file.	Only active	Inactive OK#5
	hdemodq#3	Changes the organization of the extraction information queue files.	N/A	Only inactive
	hdefcopy#2	In the event of a file duplexing error, copies the current file into the erroneous file.	N/A	Only inactive
	hdefstate#2	Displays the status of the physical files in use for file duplexing.	N/A	Inactive OK
	hdeshmclean	Deletes shared resources at the source Datareplicator.	N/A	Only inactive
	hdestart_n#2	Partially starts the source Datareplicator.	N/A	Only active
	hdestop_n#2	Partially terminates the source Datareplicator.	N/A	Only active
	hdechgstatus#2	Changes the status and information that is maintained beyond the termination or start of the source Datareplicator.	N/A	Only active
Commands for handling the target Datareplicator	hdsstart	Starts the target Datareplicator. When the -i option is specified, initializes the target Datareplicator environment but does not start the target Datareplicator.	N/A	Only inactive
	hdsstop#5	Terminates the target Datareplicator.	N/A	Only active
	hdsrfctl#5	Controls the import processing method, or restarts import processing only.	N/A	Only active
	hdsstate#5	Outputs the target Datareplicator's status to the standard output.	N/A	Only active
	hdssamqin#6, #7	Outputs to the import information queue file update information extracted from a mainframe database that uses SAM files.	N/A	Only active
	hdsfcopy#6	In the event of a file duplexing error, copies the current file into the erroneous file.	N/A	Only inactive
	hdsfstate#6	Displays the status of the physical files in use for file duplexing.	N/A	Inactive OK
	hdsrefinfm#6	Extracts each item of update information from the import information status file and outputs it to the analysis results output file.	N/A	Inactive OK
	hdschgstatus#6	Changes the status and information that is maintained beyond the termination or start of the target Datareplicator.	N/A	Only active
	hdsshmclean	Deletes shared resources at the target Datareplicator.	N/A	Only inactive
HiRDB commands	pdrplstart	The source HiRDB starts HiRDB Datareplicator linkage.	Only active	N/A
	pdrplstop	The source HiRDB cancels HiRDB Datareplicator linkage.	Only active	N/A
	pdls (-d rpl specified)	Displays the HiRDB Datareplicator linkage status at the source HiRDB.	N/A	N/A
	pdlogchg (-R specified)	Changes the system log file from extracting status to extraction completed status.	N/A	N/A
Commands for JP1/Cm2 operations management#8	hdsagtstart	Starts the Datareplicator agent.	N/A	N/A
	hdsagtstop	Terminates the Datareplicator agent.	N/A	N/A
	hdsagtstatus	Displays the Datareplicator agent's status.	N/A	N/A
	hdsagtopt	Changes Datareplicator agent settings. The information to be specified depends on the options that are specified.	N/A	N/A
	hdspathlist#10	Specifies the Datareplicator directory on a machine that is subject to monitoring.	N/A	N/A
Command for editing a mapping table for converting character codes	hdsccnvedt	Edits a mapping table for converting character codes. To update a mapping table for converting character codes or to migrate a Gaiji character mapping file, the superuser must execute this command.	N/A	N/A
Command for editing activity trace files	hdstrcedit#2, #6	Edits an activity trace file.	N/A	N/A
Commands for managing Datareplicator file system areas#9	hdsfmkfs#2, #6, #10	Initializes a Datareplicator file system area.	N/A	Only inactive
	hdsfstatfs#2, #6, #10	Displays the status of a Datareplicator file system area.	N/A	N/A

Only active: Executable only while HiRDB or Datareplicator is active.

Only inactive: Executable only while HiRDB or Datareplicator is inactive.

Inactive OK: Can be executed while Datareplicator is inactive.

N/A: Not applicable.

#1: When you execute the hdestart command, you must use a user name that belongs to the same user group as the HiRDB administrator.

#2: To execute this command, use the user name that was used to initialize the source Datareplicator (hdestart -i command).

#3: When you execute this command, use the name of the user who executes the extraction node master process (specified in inetd.conf).

#4: You cannot execute the hdestart command with the -i option specified while the source Datareplicator is active.

#5: When the hdeprep command is executed, the execution results do not become effective at the source Datareplicator until the source Datareplicator is restarted (the command's execution results do not become effective during the session in which the command is executed).

#6: To execute this command, use the user name that was used to initialize the target Datareplicator (hdsstart -i command).

#7: The hdssamqin command is available only when the source database uses SAM files. The target Datareplicator does not support the hdssamqin command when XDM/DS is used for data linkage.

#8: These commands are applicable to a Datareplicator that supports JP1/Cm2 operations management. Some of these commands can be executed only by the superuser. These commands are common to both source and target Datareplicators. For details about how to use JP1/Cm2 for operations management, see 3.4 Using JP1/Cm2 for operations management.

#9: These commands are applicable to a Datareplicator that uses Datareplicator file system areas. Only the superuser can execute these commands. These commands are common to both source and target Datareplicators. For details about file management when Datareplicator file system areas are used, see 3.5 Datareplicator file system areas.

#10: This command is not supported by Windows Datareplicator.

Table 7-2 Information that is output to the command log

Command name	Information that is output
	Command's arguments	Command's return value	Details in the event of an error
hdechgstatus	N	N	N
hdeevent hdeeventO hdeeventS	Y	Y	N
hdefcopy	Y	Y	N
hdefstate	N	N	N
hdemodq	Y	Y	N
hdeprep hdeprepO hdeprepS	Y	Y	N
hdeshmclean	Y	Y	N
hdestart hdestartO hdestartS	Y	Y	Y
hdestart_n	Y	Y	Y
hdestate	N	N	N
hdestop hdestopO hdestopS	Y	Y	Y
hdestop_n	Y	Y	Y
hdsagtopt	N	N	N
hdsagtstart	N	N	N
hdsagtstatus	N	N	N
hdsagtstop	N	N	N
hdsccnvedt	N	N	N
hdschgstatus	N	N	N
hdsfcopy	Y	Y	N
hdsfmkfs	N	N	N
hdsfstate	N	N	N
hdsfstatfs	N	N	N
hdspathlist	N	N	N
hdsrefinfm	N	N	N
hdsrfctl	Y	Y	N
hdssamqin	Y	Y	N
hdsshmclean	Y	Y	N
hdsstart	Y	Y	Y
hdsstate	N	N	N
hdsstop	Y	Y	Y
hdstrcedit	N	N	N
pdlogchg	N	N	N
pdls	N	N	N
pdrplstart	N	N	N
pdrplstop	N	N	N

Legend:

Y: Output

N: Not output