Configuration du transcodeur

Vous pouvez configurer le transcodeur Mainframe Connector en ajoutant la configuration requise dans un fichier JSON. Ce fichier est appelé fichier de configuration du transcodeur. Vous devez définir la configuration comme indiqué dans la section Configuration. Les commandes qsam encode et qsam decode utilisent le fichier de configuration du transcodeur pour effectuer le transcodage des données.

Cette page décrit les différentes manières de configurer le transcodeur Mainframe Connector.

Configuration

L'objet Configuration est la racine de la configuration du transcodeur. Il contient toutes les options de configuration du transcodeur.

Représentation JSON
{ "defaults": object (DefaultsSection), "field_suffixes": object (FieldSuffix), "field_overrides": object (FieldOverride), "transformations": object (Transformation), "schema_validation_mode": enum (SchemaValidationMode), "header_records_to_skip": long, "record_filter_condition": string }

Champs
defaults	object (DefaultsSection) Spécifiez les modificateurs de champ par défaut pour les archétypes Cobol.
field_suffixes	object (FieldSuffix) Spécifiez les suffixes de champ.
field_overrides	object (FieldOverride) Spécifiez les remplacements de champs.
transformations	object (Transformation) Spécifiez les transformations de champ.
schema_validation_mode	enum (SchemaValidationMode) Spécifiez le mode de validation du schéma.
header_records_to_skip	long Spécifiez le nombre d'enregistrements à ignorer au début.
record_filter_condition	string Spécifiez une condition de filtre pour les enregistrements. Le filtre est compatible avec les opérateurs suivants : Opérateurs de comparaison : `==`, `!=`, `<`, `<=`, `>`, `>=`. Opérateurs logiques : `&&` (AND), `||` (OR). Contenue dans la liste : `in` (pour vérifier si une valeur est présente dans une variable de liste). Opérateurs arithmétiques : `+`, `-`, `*`, `/`, `%`. Fonctions de chaîne et de liste : size() : renvoie la longueur d'une chaîne ou d'une liste. contains(substring) : vérifie si une chaîne contient une sous-chaîne spécifiée. Les comparaisons et les opérations doivent être effectuées entre des variables ou des constantes du même type de données. Exemple : "record_filter_condition": "(DATE > '2025-01-12' ) && ((SCORE_A + SCORE_B) > 134)

DefaultsSection

L'objet DefaultsSection peut être utilisé pour spécifier les modifications par défaut par types COBOL. Elles sont appliquées avant toute modification de suffixe ou de remplacement.

Représentation JSON
{ "alpha_numeric_display": object (FieldModifier), "numeric_display": object (FieldModifier), "binary": object (FieldModifier), "packed_decimal": object (FieldModifier), "national": object (FieldModifier), "utf8": object (FieldModifier), "dbcs": object (FieldModifier), "hexadecimal_floating_point": object (FieldModifier) }

Champs
alpha_numeric_display	object (FieldModifier) Spécifiez les valeurs par défaut pour les champs alphanumériques (PIC X).
numeric_display	object (FieldModifier) Spécifiez les valeurs par défaut pour les champs d'affichage numérique (décimal zoné).
binary	object (FieldModifier) Spécifiez les valeurs par défaut pour les champs de nombres binaires (COMP).
packed_decimal	object (FieldModifier) Spécifiez les valeurs par défaut pour les champs décimaux compressés (COMP-3).
national	object (FieldModifier) Spécifiez les valeurs par défaut pour les champs nationaux (PIC N).
utf8	object (FieldModifier) Spécifiez les valeurs par défaut pour les champs UTF-8 (PIC U).
dbcs	object (FieldModifier) Valeur par défaut pour les champs DBCS (DISPLAY-1).
hexadecimal_floating_point	object (FieldModifier) Valeur par défaut pour les champs hexadécimaux à virgule flottante (COMP-1, COMP-2).

FieldSuffix

Les suffixes de champ s'appliquent à tous les champs qui en comportent un.

Les champs sont mis en correspondance s'ils se terminent par un trait d'union (-) ou un trait de soulignement (_) suivi du suffixe.

Les suffixes ne sont pas sensibles à la casse.

Le modificateur FieldSuffix est appliqué après le modificateur FieldOverride.

Par exemple, le modificateur défini pour le suffixe NID sera appliqué au champ nommé FLD-NID, mais pas au champ FUNID.

Représentation JSON
{ "suffix": string, "is_inverse": boolean, "modifier": object (FieldModifier) }

Champs
suffix	string Le modificateur sera appliqué au champ portant ce suffixe.
is_inverse	boolean Indiquez si le modificateur est un modificateur de champ inverse ou non. Un modificateur de champ inverse applique le modificateur à un autre champ portant le même nom que le champ avec le modificateur sans le modificateur. Par exemple, si les champs FLD-NID et FLD existent dans le même enregistrement, le modificateur sera appliqué à FLD. Lorsque vous utilisez un modificateur de champ inverse, l'identifiant spécial $self peut être utilisé chaque fois qu'un nom de champ peut traditionnellement être utilisé pour faire référence au champ avec le suffixe. Par exemple, pour créer un champ d'indicateur de valeur nulle, vous pouvez utiliser le modificateur de champ null_if avec is_inverse défini sur true. Pour en savoir plus, consultez NullIf.
modifier	object (FieldModifier) Spécifiez le modificateur à appliquer aux champs correspondants.

FieldOverride

Remplace ou modifie la chaîne de décodage et d'encodage pour le champ spécifié.

Représentation JSON
{ "field": string, "modifier": object (FieldModifier) }

Champs
field	string Spécifiez le nom du champ auquel appliquer le modificateur.
modifier	object (FieldModifier) Spécifiez le modificateur à appliquer au champ correspondant.

Transformation

Les transformations de vue permettent de modifier la relation entre la table et le fichier QSAM. Les transformations sont toujours formulées du point de vue des données. Le concept est semblable à celui des tables de vues dans BigQuery.

Représentation JSON
{ "exclude": object (Exclude), "unnest": object (Unnest), "move": object (Move), "rename": object (Rename) }

Champs
exclude	object (Exclude)
unnest	object (Unnest)
move	object (Move)
rename	object (Rename)

FieldModifier

Un modificateur de champ vous permet de modifier l'encodage ou le décodage d'un champ spécifique. Notez que tous les modificateurs ne peuvent pas être appliqués à tous les champs. Pour en savoir plus, consultez la documentation sur les modificateurs spécifiques.

Représentation JSON

{ "filler": object (Filler), "null_if": object (NullIf), "format_date": object (FormatDate), "chain": object (ModifierChain), "zoned_decimal": object (ZonedDecimal), "binary": object (Binary), "packed_decimal": object (PackedDecimal), "null_if_invalid": object (NullIfInvalid), "bytes": object (Bytes), "varlen": object (VarLen), "string": object (String), "null_if_empty": object (NullIfEmpty), "format_timestamp": object (FormatTimestamp), "hfp": object (HFP), "decode_as_null": object (DecodeAsNull), "encode_null_as": object (EncodeNullAs) }

Champs
filler	object (Filler) Exclut le champ du traitement et de la sortie.
null_if	object (NullIf) Définit conditionnellement le champ sur "null" en fonction de la valeur d'un autre champ.
format_date	object (FormatDate) Met en forme un champ de chaîne en tant que date.
chain	object (ModifierChain) Enchaîne plusieurs modificateurs à appliquer de manière séquentielle.
zoned_decimal	object (ZonedDecimal) Remplace la configuration par défaut des champs décimaux zonés.
binary	object (Binary) Remplace la configuration par défaut des champs numériques binaires.
packed_decimal	object (PackedDecimal) Remplace la configuration par défaut des champs décimaux compressés.
null_if_invalid	object (NullIfInvalid) Définit le champ sur "null" en cas d'erreur de transcodage, ce qui empêche le débordement des enregistrements.
bytes	object (Bytes) Traite le champ comme une séquence d'octets bruts, en ignorant les informations de type précédentes.
varlen	object (VarLen) Définissez l'enregistrement en tant que champ de longueur variable.
string	object (String) Remplace la configuration par défaut des champs de chaîne.
null_if_empty	object (NullIfEmpty) Définit le champ sur "null" si son contenu est considéré comme vide.
format_timestamp	object (FormatTimestamp) Formate un champ de chaîne en tant qu'horodatage.
hfp	object (HFP) Interprète le champ comme un nombre hexadécimal à virgule flottante (HFP).
decode_as_null	object (DecodeAsNull) Définit la façon dont les valeurs nulles doivent être décodées.
encode_null_as	object (EncodeNullAs) Définit la façon dont les valeurs nulles doivent être encodées.

Exclure

Excluez un champ de la table résultante, mais effectuez quand même le décodage ou l'encodage. Cela est utile lorsque le champ n'a pas besoin d'être transféré vers la table, mais qu'il est requis pour le transcodage. Par exemple, les champs de longueur ou d'indicateur null peuvent être omis dans le tableau.

Pour contourner complètement le transcodage, appliquez le modificateur de remplissage.

Représentation JSON
{ "field": string }

Champs
field	string Spécifiez le champ à exclure.

Désimbriquer

Supprimez l'imbrication du champ.

Représentation JSON
{ "field": string, "format": string }

Champs
field	string Spécifier le champ à supprimer de l'imbrication
format	string Spécifiez le nouveau format du champ. Le ${parent} sera publié avec le nom du champ qui est supprimé. Pour les structs non imbriqués, ${field} est remplacé par le nom du champ des structs. Pour les tableaux et les listes non imbriqués, ${index} est remplacé par les index du tableau.

Déplacer

Déplacez un champ dans l'enregistrement.

Représentation JSON
{ "field": string, "offset": int }

Champs
field	string Spécifiez le champ à déplacer.
offset	int Spécifiez le nombre de positions (vers l'avant ou vers l'arrière) vers lesquelles le champ doit être déplacé.

Renommer

Renommez un ou plusieurs champs en fonction d'une correspondance d'expression régulière.

Par exemple, pour remplacer tous les tirets par des traits de soulignement, utilisez le format JSON suivant : {"find": "\\-", "replace":"_"}.

Représentation JSON
{ "find": string, "replace": string }

Champs
find	string Spécifie un modèle d'expression régulière Java pour identifier le ou les champs à renommer. Le modèle est mis en correspondance avec le nom complet du champ. Si le modèle correspond à une partie du nom du champ, le champ est considéré comme une correspondance. Exemples : "\\-" (correspond à n'importe quel champ contenant un tiret) "^field_name$" (correspond aux champs portant exactement le nom field_name) "^field_(.*)$" (correspond à tous les champs commençant par field_ et capture le reste) "part_of_name" (correspond à n'importe quel champ contenant part_of_name)
replace	string Spécifie le nouveau nom du ou des champs correspondants. Les groupes de capture de l'expression régulière find peuvent être utilisés dans la chaîne replace à l'aide de références arrières telles que $1 et $2. Cela permet des transformations plus complexes basées sur des parties du nom de champ d'origine. Exemples : "new_field_name" (remplace le champ par un nom fixe) "new_$1" (utilise le premier groupe de capture de find) "${1}_new" (syntaxe alternative pour les groupes de capture) "prefix_$1_suffix" (utilise un groupe de capture et ajoute des préfixes/suffixes)

Complément alimentaire

Indique qu'un champ sera ignoré lors du traitement. Le champ ne sera pas décodé à partir de l'entrée ni encodé dans la sortie. Il sera exclu du schéma et du tableau de données résultants lors du décodage. Vous pouvez appliquer ce modificateur à n'importe quel champ dont la taille statique est connue.

Fournissez un objet JSON vide comme suit :

Représentation JSON
{ }

NullIf

Définissez un champ sur "null" si une condition est remplie. Vous devez spécifier null_value, non_null_value ou les deux.

Pour créer un champ d'indicateur de valeur nulle, vous pouvez utiliser un FieldSuffix avec un modificateur de champ null_if et définir is_inverse sur true, comme illustré dans les exemples suivants :

Exemple : indicateur Null

Pour créer un champ d'indicateur de valeur nulle, vous pouvez utiliser le modificateur de champ null_if comme suit.

 {
  "field_suffixes": [
   {
     "suffix": "NID",
     "is_inverse": true,
     "modifier": {
     "null_if": {
       "null_value": "?",
       "target_field": "$self"
     }
    }
   }
  ]
 }

Cela permet à tous les champs portant le suffixe NID d'être des indicateurs de valeur nulle, comme le montre l'extrait de copybook suivant :

 01 REC.
   02 FIELD     PIC X(10).
   02 FIELD-NID PIC X(1).

Exemple : indicateur de valeur nulle binaire

Pour créer un champ indicateur de valeur nulle binary, nous pouvons utiliser les modificateurs de champ binary et null_if comme suit.

 {
  "field_suffixes": [
   {
     "suffix": "NID",
     "modifier": {
       "binary": {}
     }
   },
   {
     "suffix": "NID",
     "is_inverse": true,
     "modifier": {
     "null_if": {
       "null_value": "15",
       "target_field": "$self"
     }
    }
   }
  ]
 }

Cela permet à tous les champs portant le suffixe NID d'être effectivement des indicateurs de valeur nulle binary à l'aide du même copybook que dans l'exemple précédent.

Exemple : Indicateur Null (octets)

Pour créer un champ indicateur de valeur nulle bytes, nous pouvons utiliser les modificateurs de champ bytes et null_if comme suit. Les valeurs pour null et non null sont exprimées sous la forme HEX.

 {
  "field_suffixes": [
   {
     "suffix": "NID",
     "modifier": {
       "bytes": {}
     }
   },
   {
     "suffix": "NID",
     "is_inverse": true,
     "modifier": {
     "null_if": {
       "null_value": "FF",
       "target_field": "$self"
     }
    }
   }
  ]
 }

Cela permet à tous les champs portant le suffixe NID d'être effectivement un indicateur null bytes à l'aide du même copybook que dans l'exemple précédent.

Représentation JSON
{ "target_field": string, "null_value": string, "null_values": string, "non_null_value": string, "non_null_values": string }

Champs
target_field	string Spécifiez le champ dont vous souhaitez vérifier la valeur. Le champ doit être dans le champ d'application.
null_value	string Si target_field est égal à cette valeur, le champ n'est pas décodé ni encodé, et la valeur est définie sur "null".
null_values	string Si target_field est égal à l'une de ces valeurs, le champ n'est pas décodé ni encodé, et la valeur est définie sur "null".
non_null_value	string Si target_field n'est pas égal à cette valeur, le champ n'est pas décodé ni encodé, et la valeur est définie sur "null".
non_null_values	string Si target_field est spécifié et n'est égal à aucune de ces valeurs, le champ n'est pas décodé ni encodé, et la valeur est définie sur "null".

FormatDate

Mettez en forme une chaîne en tant que date à l'aide de l'un des formats compatibles. Vous ne pouvez appliquer ce modificateur qu'aux champs dimensionnés. Lors du processus de décodage, les formats sont testés dans l'ordre jusqu'à ce que l'un d'eux corresponde à la chaîne. Lors du processus d'encodage, le premier format est utilisé et les autres sont ignorés.

Représentation JSON
{ "formats": object (DateTimeFormat) }

Champs
formats	object (DateTimeFormat) Liste des formats de date.

ModifierChain

Spécifiez une chaîne de modificateurs pour appliquer plusieurs modificateurs en série. Les modificateurs sont appliqués dans l'ordre dans lequel ils sont spécifiés.

Représentation JSON
{ "modifiers": object (FieldModifier) }

Champs
modifiers	object (FieldModifier) Spécifiez la liste des modificateurs à appliquer.

ZonedDecimal

Définit différentes options liées à l'encodage et au décodage des nombres décimaux zonés. Vous ne pouvez appliquer ce modificateur qu'à un champ décimal.

Représentation JSON
{ "logical_type": enum (DecimalLogicalType), "encoding": enum (ZonedDecimalEncoding) }

Champs
logical_type	enum (DecimalLogicalType) Spécifiez le type logique à utiliser lors du décodage ou de l'encodage du champ.
encoding	enum (ZonedDecimalEncoding) Encodage du champ.

Binaire

Ignorez les modificateurs précédents et traitez ce champ comme un nombre binaire.

Représentation JSON
{ "signedness": enum (BinarySignedness) }

Champs
signedness	enum (BinarySignedness) Signe du nombre.

PackedDecimal

Définissez ce champ sur PackedDecimal.

Représentation JSON
{ "logical_type": enum (DecimalLogicalType) }

Champs
logical_type	enum (DecimalLogicalType) Remplacez le type logique. Par défaut, Mainframe Connector utilise le type logique optimal en fonction de la précision et de l'échelle.

NullIfInvalid

Traitez la valeur comme nulle si le transcodage échoue. Vous ne pouvez appliquer ce modificateur qu'aux champs dimensionnés. L'erreur est ignorée et n'est pas consignée dans l'ensemble de données sur le débordement. Lors du processus de décodage, la valeur de ce champ sera nulle pour cet enregistrement. Si les données ne peuvent pas être écrites lors du processus d'encodage, l'intégralité du champ sera remplie d'octets nuls.

Fournissez un objet JSON vide comme suit :

Représentation JSON
{ }

Octets

Traite le champ comme une séquence d'octets bruts. Ce modificateur remplace toute information de type antérieure, ce qui permet de conserver les données brutes en octets du champ telles quelles, sans encodage de caractères ni interprétation numérique spécifiques. Vous pouvez appliquer ce modificateur à n'importe quel champ, quels que soient son type ou sa taille d'origine.

Fournissez un objet JSON vide comme suit :

Représentation JSON
{ }

VarLen

Représente un champ de longueur variable.

Un champ de longueur variable comporte trois parties :

1. Élément de groupe contenant deux sous-champs.
2. Champ de l'élément de groupe contenant la longueur des données de transaction.
3. Champ de l'élément de groupe contenant les données.

Le nom du champ de longueur variable sera le nom du groupe.

Fournissez un objet JSON vide comme suit :

Représentation JSON
{ }

Chaîne

Définit les différentes options liées au décodage et à l'encodage des chaînes. Ne peut être appliqué qu'à un champ de chaîne.

Représentation JSON
{ "encoding": string, "trim_suffix": boolean, "pad_char": string }

Champs
encoding	string Encodage du champ.
trim_suffix	boolean Si la valeur est définie sur "true", les espaces blancs à la fin de la chaîne sont supprimés. trim_suffix n'affecte que le décodage. L'encodage ignore trim_suffix. Notez que les chaînes composées uniquement d'espaces blancs deviendront des chaînes vides.
pad_char	string Lorsque des chaînes d'exportation de marge intérieure sont définies, elles sont complétées par pad_char. Si ce paramètre est défini, la longueur de pad_char doit être égale à 1. pad_char n'affecte que l'encodage. Le décodage ignore pad_char.

NullIfEmpty

Le champ doit être défini sur "null" si tous les octets de ce champ sont définis sur 0.

Fournissez un objet JSON vide comme suit :

Représentation JSON
{ }

FormatTimestamp

Mettez en forme une chaîne en tant qu'horodatage à l'aide de l'un des formats fournis. Cela ne peut être appliqué qu'aux champs dimensionnés. Lors du décodage, les formats sont testés dans l'ordre jusqu'à ce que l'un d'eux corresponde à la chaîne. Lors de l'encodage, le premier format sera utilisé et les autres seront ignorés.

Représentation JSON
{ "formats": object (DateTimeFormat) }

Champs
formats	object (DateTimeFormat) Liste des formats de code temporel.

HFP

Définissez ce champ sur "Nombre à virgule flottante hexadécimal".

Fournissez un objet JSON vide comme suit :

Représentation JSON
{ }

DecodeAsNull

Définit la façon dont les valeurs nulles sont interprétées lors du processus de décodage. Comme COBOL n'accepte pas les valeurs nulles de manière native, ce paramètre spécifie les valeurs qui doivent être traitées comme nulles.

Représentation JSON
{ "values": string, "hex_bytes": string }

Champs
values	string Liste de représentations de chaînes. Après le décodage initial du champ sous forme de chaîne, si le contenu du champ correspond à l'une de ces valeurs, il sera traité comme nul.
hex_bytes	string Liste de représentations hexadécimales d'un seul octet. Lorsqu'un champ contient des répétitions de l'un de ces octets, il est traité comme une valeur nulle. Par exemple, en utilisant FF pour toutes les valeurs élevées et 00 pour toutes les valeurs faibles (vide).

EncodeNullAs

Définit la façon dont les valeurs nulles sont représentées lors du processus d'encodage.

Représentation JSON
{ "value": string, "hex_byte": string }

Champs
value	string Encodez cette valeur spécifique lorsque la valeur source est nulle. Vérifiez que la chaîne est valide pour le type de champ.
hex_byte	string Encodez cette séquence d'octets spécifique (représentée sous forme de chaîne hexadécimale) lorsque la valeur source est nulle. Par exemple, FF pour un champ de deux octets à valeurs élevées. Vous pouvez appliquer cette méthode à n'importe quel champ dont la taille est connue. Les octets sont répétés pour correspondre à la taille du champ sous-jacent.

DateTimeFormat

Taille et format à utiliser lors de la conversion du champ en date.

Représentation JSON
{ "size": int, "pattern": string }

Champs
size	int Spécifiez la taille du champ auquel ce modèle s'applique.
pattern	string Spécifiez le format du formateur de date. Pour en savoir plus sur les modèles de mise en forme valides, consultez Class DateTimeFormatter.

ZonedDecimalEncoding

Spécifiez l'encodage à utiliser lors du décodage ou de l'encodage d'un champ décimal zoné.

Enums
UNSPECIFIED	Conservez l'encodage spécifié dans la chaîne de modificateurs. Si aucun modificateur n'est spécifié, EBCDIC est utilisé.
EBCDIC	Utilisez l'encodage EBCDIC.
ASCII	Utilisez l'encodage ASCII.

BinarySignedness

Type logique à utiliser pour un champ décimal.

Enums
UNSPECIFIED	Utilisez le type le plus adapté en fonction de l'échelle et de la précision.
SIGNED	Utilisez 64 bits pour stocker la valeur. Ce modificateur ne fonctionne que pour les nombres dont la précision est inférieure ou égale à 18 et dont l'échelle est égale à 0.
UNSIGNED	Utilisez 64 bits pour stocker la valeur. Ce modificateur ne fonctionne que pour les nombres dont la précision est inférieure ou égale à 18.

DecimalLogicalType

Type logique à utiliser pour un champ décimal.

Enums
AUTO	Utilisez le type le plus adapté en fonction de l'échelle et de la précision.
LONG	Utilisez 64 bits pour stocker la valeur. Ce modificateur ne fonctionne que pour les nombres dont la précision est inférieure ou égale à 18 et dont l'échelle est égale à 0.
DECIMAL64	Utilisez 64 bits pour stocker la valeur. Ce modificateur ne fonctionne que pour les nombres dont la précision est inférieure ou égale à 18.
BIG_DECIMAL	Stockez la valeur sous forme de valeur décimale illimitée. Il s'agit de l'option la plus lente, mais elle accepte n'importe quel nombre décimal, quelle que soit sa précision et son échelle.
BIG_INTEGER	Stockez la valeur en tant que valeur entière sans limite. Il s'agit de l'option la plus lente, mais elle accepte n'importe quel entier de n'importe quelle précision.

SchemaValidationMode

Spécifiez le mode de validation du schéma à utiliser lors de la compilation du copybook. Ce mode vérifie la compatibilité avec un format de données cible spécifique.

Enums
DEFAULT	Mode de validation du schéma par défaut. Ce mode vérifie que des noms de champs uniques figurent dans le copybook.
BIG_QUERY	Mode de validation du schéma pour la compatibilité avec BigQuery. Ce mode étend la validation par défaut pour vérifier que le schéma du copybook est compatible avec les types de données de BigQuery.
POSTGRES	Mode de validation du schéma pour la compatibilité avec PostgreSQL. Ce mode étend la validation par défaut pour vérifier que le schéma du copybook est compatible avec les types de données PostgreSQL.
MYSQL	Mode de validation du schéma pour la compatibilité avec MySQL. Ce mode étend la validation par défaut pour vérifier que le schéma du copybook est compatible avec les types de données MySQL.