Show TOC

ConventionsLocate this document in the navigation structure

These style and syntax conventions are used in SAP® documentation.

Style conventions
Key Definition
  • SQL and program code
  • Commands to be entered exactly as shown
  • File names
  • Directory names
<italic monospaced> In SQL or program code snippets, placeholders for user-specified values (see example below).
  • File and variable names
  • Cross-references to other topics or documents
  • In text, placeholders for user-specified values (see example below)
  • Glossary terms in text
bold san serif
  • Command, function, stored procedure, utility, class, and method names
  • Glossary entries (in the Glossary)
  • Menu option paths
  • In numbered task or procedure steps, user-interface (UI) elements that you click, such as buttons, check boxes, icons, and so on

If necessary, an explanation for a placeholder (system- or setup-specific values) follows in text. For example:

<installation directory>\start.bat

where <installation directory> is where the application is installed.

Syntax conventions
Key Definition
{ } Curly braces indicate that you must choose at least one of the enclosed options. Do not type the braces when you enter the command.
[ ] Brackets mean that choosing one or more of the enclosed options is optional. Do not type the brackets when you enter the command.
( ) Parentheses are to be typed as part of the command.
| The vertical bar means you can select only one of the options shown.
, The comma means you can choose as many of the options shown as you like, separating your choices with commas that you type as part of the command.
... An ellipsis (three dots) means you may repeat the last unit as many times as you need. Do not include ellipses in the command.
< > Angled brackets are not part of the syntax. Rather, they denote variables within the syntax. For example, if the syntax calls for a variable such as a password, this is denoted as <password>. However, when using the syntax in a command or query, omit the angled brackets. So, instead of using <MyPassword> use MyPassword.
  • All command syntax and command examples are shown in lowercase. However, replication command names are not case-sensitive. For example, RA_CONFIG, Ra_Config, and ra_config are equivalent.
  • Names of configuration parameters are case-sensitive. For example, Scan_Sleep_Max is not the same as scan_sleep_max, and the former would be interpreted as an invalid parameter name.
  • Database object names are not case-sensitive in replication commands. However, to use a mixed-case object name in a replication command (to match a mixed-case object name in the primary database), delimit the object name with quote characters. For example: pdb_get_tables "<TableName>"
  • Identifiers and character data may be case-sensitive, depending on the sort order that is in effect.
    • If you are using a case-sensitive sort order, such as “binary,” you must enter identifiers and character data with the correct combination of uppercase and lowercase letters.
    • If you are using a sort order that is not case-sensitive, such as “nocase,” you can enter identifiers and character data with any combination of uppercase or lowercase letters.

SAP® Replication Server® works with various components to enable replication between supported database such as, SAP® Adaptive Server® Enterprise (SAP® ASE), SAP HANA® database, SAP® IQ, Oracle, IBM DB2 UDB, and Microsoft SQL Server. SAP Replication Server uses SAP ASE for its Replication Server System Database (RSSD) or it uses SAP® SQL Anywhere® for its embedded Replication Server System Database (ERSSD).

Replication Agent™ is a generic term used to describe the Replication Agents for SAP ASE, SAP HANA database, Oracle, IBM DB2 UDB, and Microsoft SQL Server. The specific names are:
  • RepAgent – Replication Agent thread for SAP ASE
  • Replication Agent for Oracle
  • Replication Agent for Microsoft SQL Server
  • Replication Agent for UDB – for IBM DB2 on Linux, Unix, and Windows
  • Replication Agent for DB2 for z/OS