Document Conventions

This section explains the conventions used in Fivetran HVR documentation.

Convention	Description
bold	Indicates computer terms that are fixed, field or button name in UI, keywords, action name, action parameters, commands, command parameters, file names, directory path.
italics	Indicate computer terms that are variable or placeholder for which you supply values. For example, in a directory path such as HVR_CONFIG/hubs/myhub, the word 'myhub' is in italics indicating that it is a variable and should be replaced by the applicable word/value.
`hvrcompare -rsrc -ltgthub channel`	Code examples, syntax, and commands recognized by the system are displayed in code blocks with mono spaced font. The code examples or SQL statements specified directly in paragraphs are displayed in `bold or italic mono spaced font with gray background`. For example, "the HVR database User must be granted `create table` privilege".
[ ]	Text inside square brackets [ ] indicates optional entries.
\|	The vertical line or pipe sign ( \| ) separates a mutually exclusive set of options.

Menu selection sequences are displayed in bold and each menu item is divided by the ▶ symbol. For example, select Tools ▶ Data ▶ Entity ▶ Organization. This means select the Tools option in the menu bar, then select the Data option in the Tools menu, then select the Entity option in the Data sub-menu and finally click the Organization option in the Entity sub-menu.

Environment Variables

All occurrences of HVR_HOME, HVR_CONFIG, and HVR_TMP in paragraphs should be treated as environment variables. Linux/Unix users need to add a dollar sign ($) and Windows users need to add percent signs (%) when setting variables in their operating system.

For example, if a paragraph mentions something about HVR_CONFIG/logs/, it should be interpreted as:

In Linux/Unix - $hvr_config/logs
In Windows - %hvr_config%/logs

File/Directory Path

Many path names are shown using the Unix conventions, e.g. a forward slash '/' is used as a file path name delimiter. For the Microsoft Windows platform, this can be understood as a backward slash '\'. Generally, HVR converts between the forward and backward slashes as appropriate, so the two can be used interchangeably.

Info, Note, Tip, Warning

Info, Note, Tip, and Warning notices/banners are used in our documentation to highlight important information.

Indicates this is an informational text.

Indicates this is a note.

Indicates this is a tip or trick.

Indicates this is a warning and must not be ignored.

Labels

Applies-to, Available Since, and Default are documentation labels/tags used for indicating certain long messages in a very short format.

`Oracle`	Indicates functionality that is only supported on a certain system (location type or operating system), Oracle in this case. This can be Ingres, SQL Server, Salesforce, Linux, Windows, etc.
`Since v6.x.x`	Indicates the HVR version in which the feature was introduced.
`default`	Indicates the default value for a field/property/command.

Icons

Following are the icons used in this documentation.

Icon	Description
	Indicates an HVR Agent process or machine.
	Indicates an HVR Agent proxy process or HVR Agent proxy machine or a file proxy.
	Indicates a channel.
	Indicates a database location or location whose type (db/file/kafka) is unknown or hub repository or hive database for external tables.
	Indicates a file location or directory or temporary file.
	Indicates a Kafka location.
	Indicates a location group.
	Indicates a table.
	Indicates a table group.
	Indicates a capture job.
	Indicates an integrate job.
	Indicates the direction of replication. The color of this icon turns: blue: if the channel is activated red: if a job failed or the latency threshold is exceeded.