Variant Definition File - USAP

Overview

Universal Connector for SAP variant definition files contain statements that specify the attributes of variants.

These variant definitions are used by the SUBMIT and MODIFY commands to define or modify variants in an SAP system.

This page provides a detailed description of the syntax options and requirements for variant definition files.

Variant Definition File Syntax

The USAP variant definition file is used to create or modify a variant in an SAP system. There are three types of statements used to define a variant:

  1. Variant Header Statement
  2. Variant Text Statement
  3. Variant Content Statement

A variant definition requires a Variant Header statement followed by Text and Content statements. Statements are made up of keyword = value assignments and are terminated with a semi-colon (;). Each statement type has a specific unique keyword that is required to start the keyword = value assignment list.

The following figure illustrates the syntax of a Universal Connector for SAP variant definition.


Variant_Header_Statement Variant_Text_Statement Variant_Content_Statement [Variant_Content_Statements]

Variant Definition File Statement Keywords

The following tables list the keywords available for each statement, the maximum length of the associated values, whether or not they are required, and any restricted value sets. The first keyword in each table is the keyword required to start the corresponding statement.

Keywords for Variant Header Statement

The following table identifies the keywords for a Variant Header statement.

Keyword

Length

Required

Restricted Values

VARIANT_NAME

14

Yes

Variant name.

REPORT

40

Yes

ABAP report for which variant is defined.

Keywords for Variant Text Statement

The following table identifies the keywords for a Variant Text statement.

Keyword

Length

Required

Restricted Values

VARIANT_TEXT

30

Yes


LANGUAGE

2

Yes


Keywords for Variant Content Statement

The following table identifies the keywords for a Variant Content statement.

Keyword

Length

Required

Restricted Values

SELNAME

8

Yes


KIND

1

Yes

Field type:

  • 'P' = Field type is a parameter.
  • 'S' = Field type is a selection option.

SIGN

1

Yes

Selection sign:

  • 'I' = Include values based on field selection criteria.
  • 'E' = Exclude values based on field selection criteria.

OPTION

2

Yes

Selection option:

  • 'CP' = Pattern.
  • 'EQ' = Single value.
  • 'GE' = Greater than or equal to.
  • 'LE' = Less than or equal to.
  • 'GT' = Greater than.
  • 'LT' = Less than.
  • 'NE' = Not equal to.

LOW

45

No

Selection value.

HIGH

45

No

Selection value.

PROTECTED

1

No

  • 'X' = Field is protected.
  • ' ' = Field is not protected.

APPENDAGE

1

No

  • *'X' = Appendage.
  • ' ' = Not appendage.

VNAME

30

No

Name of variant variable.

VTYPE

1

No

Variant variable type:

  • 'T' = Table variable from TVARV.
  • 'D' = Dynamic date calculation.
  • 'B' = User defined variables.

INVISIBLE

1

No

Hide field:

  • 'X' = Invisible.
  • ' ' = Not invisible.

NOINT

1

No

Hide field 'BIS':

  • 'X' = Invisible.
  • ' ' = Not invisible.

SCREENNR

4

No

Screen number.

NO_IMPORT

1

No

Save field without values:

  • 'X' = Yes
  • ' ' = No

OBLI

1

No

Required field:

  • 'X' = Yes
  • ' ' = No

Sample Variant Definition File

The following figure illustrates a sample variant definition file.

This file will define variant SAMPLE_1 for ABAP report RSUSR002. The USER field will contain value S*.


/* Variant Header statement. */
VARIANT_NAME   = "SAMPLE_1"
   REPORT      = "RSUSR002"
;

/* Variant text statement. */
VARIANT_TEXT   = "SAMPLE_1"
   LANGUAGE    = "EN"
;

/* User */
SELNAME        = "USER"
   KIND        = "S"
   SIGN        = "I"
   OPTION      = "CP"
   LOW         = "S*"
   HIGH        = ""
   PROTECTED   = ""
   APPENDAGE   = ""
   VNAME       = ""
   VTYPE       = ""
   INVISIBLE   = ""
   SCREENNR    = ""
  NO_IMPORT   = ""
   SPAGPA      = ""
   OBLI        = ""
   NOINT       = ""
;