Agent section - connect_cdc_sqdata - 4.1

Connect CDC (SQData) Secure communications components

Product type
Software
Portfolio
Integrate
Product family
Connect
Product
Connect > Connect CDC (SQData)
Version
4.1
Language
English
Product name
Connect CDC (SQData)
Title
Connect CDC (SQData) Secure communications components
Topic type
How Do I
Installation
Copyright
2024
First publish date
2000
ft:lastEdition
2024-02-07
ft:lastPublication
2024-02-07T13:29:14.268926

The Agent Section consists of one or more "named" blocks representing the alias names of individual agents. They are alphanumeric and may also contain the underscore "_" character.

Agent sections - not identified by a section header, each agent is identified with its "alias name" between square brackets, heading a block of properties for that agent.

Syntax
[<capture_agent_alias>] | [<publisher_agent_alias>]
[<engine_agent_alias> ] | [<program_alias> ] | [<process_alias>]
type=Capture | Publisher | Engine | Program
program=<name>
args=<parameter list>
working_directory=<full path to working directory>
cab=<full or relative path/<capture/publisher_alias.cab>
stdout_file=<full or relative path>/<agent_alias>.<ext>
stderr_file=<full or relative path>/<agent_alias>.<ext>
report=<synonym of stderr_file>
comment=<user comment>
auto_start=[ YES | NO ]
Keyword and Parameter Descriptions
Keyword Description
[<capture_agent_alias>] | [<publisher_agent_alias>]

Must be unique in the configuration file of the daemon on the same machine as the Capture / Publisher process. This alias name will be referenced in the Engine connect string. Must be associated with the cab=<*.cab> file name specified in the sqdconf create command for the capture or publisher Agent setup in the previous section.

[<engine_agent_alias>]

Only present in the configuration file of the daemon on the same machine where the Engine process executes. Also known as the Engine name, the <engine_agent_alias> provided here does not need to match the one specified as the subscription name in the Capture/Publisher .cab file, however there is no reason to make them different. Will also be used by sqdmon agent management and display commands.

[<program_alias> ] | [<process_alias>]

Only present in the configuration file of the daemon on the same machine where the program or process associated with the alias will execute. Any string of characters may be used.

type=Capture | Publisher | Engine | Program

Type of the agent. This can be Engine, Program capture or publisher. It is not necessary to specify the type for Engines, programs, scripts or batch files.

program=<name>

The name of the program (or nix shell script / or windows batch file) to invoke in order to start an agent. This can be a full path or a simple program name. In the latter case, the program must be accessible via the PATH of the sqdaemon - context. The value must be "SQDATA" for Engines but may also be any other executable program, shell script (nix) or batch file (Windows).

args=<parameter list> Parameters passed on the command line to the the program=<name> associated with the agent on startup. In the case of an Connect CDC (SQData) Engine, it must be the "parsed" Engine script name ie <engine.prc>. This is valid for program= entries only.
working_directory=<full path to working directory>

Specify the working directory used to execute the agent.

cab=<full or relative path/<capture/publisher_alias.cab>

Location and name of the configuration (.cab) file for capture and publisher agent entries.

stdout_file=<full or relative path>/<agent_alias>.<ext>

Location and name of the output file name used by the agent_alias for stdout. The file extension is optional but .rpt is recommended. If not specified, the default value is agent_name.stdout. Using the same file name for stdout_file and stderr_file is recommended and will result in a concatenation of the two results, for example <engine_name.rpt>.

stderr_file=<full or relative path>/<agent_alias>.<ext>

Location and name of the output file name used by the agent_alias for stderr. The file extension is optional but .rpt is recommended. If not specified, the default value is agent_name.stderr. Using the same file name for stdout and stderr is recommended and will result in a concatenation of the two results, for example <engine_name.rpt>

report=<synonym of stderr_file>

If both are specified, report takes precedence.

comment=<user comment>

User specified comment associated with the agent, used for display purposes.

auto_start=[ YES | NO ]

A boolean value indicating if the associated agent should be automatically started when sqdaemon is started.

The valid auto_start values are 'yes' (case insensitive) or '1'.

Valid auto_start values:
  • auto_start=1

  • auto_start=yes

  • auto_start=YES

  • auto_start=yEs

Non-valid auto_start values will be treated as NO:
  • auto_start=y
  • auto_start=Y

This also has an impact in the return code reported by sqdmon when an agent stops with an error. If an agent is marked as auto_start and it stops unexpectedly, this will be reported as an Error in the sqdaemon log, otherwise it is reported as a Warning. This is valid for engine entries only.

Note:
  • Directories and paths specified must exist before being referenced. Relative names may be included and are relative to the working directory of the sqdaemon "-d" parameter or as specified in the file itself.
  • All references to .cab files names must be fully qualified.