COBOL Copybook File - Import - 7.1

Talend Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Data Catalog

Note: This file format needs to be imported with the File System (CSV, Excel, XML, JSON, Avro, Parquet, ORC, COBOL Copybook), Apache Hadoop Distributed File System (HDFS Java API) or Amazon Web Services (AWS) S3 Storage bridges.

Bridge Specifications

Vendor ISO
Tool Name COBOL Copybook File
Tool Version 1985
Tool Web Site http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=51416
Supported Methodology [File System] Data Store (Physical Data Model, Logical Data Model) via Cobol Copybook File
Incremental Harvesting
Remote Repository Browsing for Model Selection
Data Profiling
Multi-Model Harvesting

SPECIFICATIONS
Tool: ISO / COBOL Copybook File version 1985 via Cobol Copybook File
See http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=51416
Metadata: [File System] Data Store (Physical Data Model, Logical Data Model)
Component: CobolCopybook version 11.0.0

OVERVIEW
This bridge can only import the COBOL COPYBOOK files (which contain the data definitions), therefore does not detect (reverse engineer) metadata from actual COBOL data files.
The detection of such COBOL COPYBOOK File is not based on file extensions (such as .CPY) but rather by sampling the file content.

This bridges creates a 'Physical Hierarchical Model' which reflects a truly flat, byte-position defined, record structure, which is useful for stitching to the DI/ETL processes. Therefore, the physical model has all the physical elements required to define a flat record, which is ONE table with all the elements (including multiple columns for OCCURS elements when the proper bridge parameter is set).

Note that this bridge does not currently support the COPY verb, and reports a parsing error at the line and position at which the COPY statement begins. In order to import Copybooks with the Copy Statement, create an expanded Copybook file with the included sections already in place (replacing the COPY verb). Most COBOL compilers have the option to output only the preprocessed Copybooks with the COPY and REPLACE statements expanded.

Frequently Asked Questions:
Q: Why is the default start column '6' (six) and the default end column '72' (seventy-two)?
A: The bridge parser counts columns starting at 0 (zero), rather than 1 (one). Thus, the defaults leave the standard first six columns for line numbers, next column for comment indicators, and last 8 columns (out of 80) for additional line comment information.


Bridge Parameters

Parameter Name Description Type Values Default Scope
File Bridge reads metadata from the COBOL copybook file or COBOL File Description (CFD). FILE
*.txt
*.cfd
  Mandatory
Encoding Specify the encoding of the text in the COBOL file. ENUMERATED
Central and Eastern European (iso-8859-2)
Central and Eastern European (windows-1250)
Chinese Traditional (big5)
Chinese Simplified (GB18030)
Chinese Simplified (GB2312)
Cyrillic (iso-8859-5)
Cyrillic (windows-1251)
DOS (ibm-850)
Greek (iso-8859-7)
Greek (windows-1253)
Hebrew (iso-8859-8)
Hebrew (windows-1255)
Japanese (shift_jis)
Korean (ks_c_5601-1987)
Thai (TIS620)
Thai (windows-874)
Turkish (iso-8859-9)
Turkish (windows-1254)
UTF 8 (utf-8)
UTF 16 (utf-16)
Western European (iso-8859-1)
Western European (iso-8859-15)
Western European (windows-1252)
Locale encoding
No encoding conversion
utf-8  
Import model as Specifies how to import the model.

'Physical hierarchical model'
represent a Copybook as a Hierarchical file. This is the default.

'Logical data model'
represent a Copybook as a data modeling.
ENUMERATED
Physical hierarchical model
Logical data model
Physical hierarchical model  
Run COBOL copybook parser in verbose mode Run COBOL copybook parser in verbose mode if there are parsing problems arrise. This setting will help to identify causes of the warnings and errors reported by the bridge. BOOLEAN
False
True
False  
Expand multiply occuring records Expand multiply occuring records into multiple attributes.

For example record:
30 OCCURS-TEST PIC X OCCURS 3 TIMES.

will be represented as list of attributes with names like:
OCCURS-TEST(1)
OCCURS-TEST(2)
OCCURS-TEST(3)

Occurence within occurence:
30 OCCURS-GROUP OCCURS 3 TIMES.
40 OCCURS-TEST PIC X OCCURS 2 TIMES.

is represented as:
OCCURS-TEST(1,1)
OCCURS-TEST(1,2)
OCCURS-TEST(2,1)
OCCURS-TEST(2,2)
OCCURS-TEST(3,1)
OCCURS-TEST(3,2)
BOOLEAN
False
True
False  
Import fillers Specifies whether filler field names should be imported.

'True'
Filler field names are imported.

'False'
Filler field names are ignored. This is the default value.
BOOLEAN
False
True
False  
Miscellaneous Specify miscellaneous options identified with a -option followed by a value if required:

GENERAL OPTIONS
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -Dname=value -Xms1G
The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript "script.bat arg1 arg2"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

COBOL COPYBOOK OPTIONS
-s <column number>
Start column index in the COBOL copybook file for the parser, e.g.
-s 6

-e <column number>
End column index in the COBOL copybook file for the parser, e.g.
-e 72
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"COBOL Copybook File"
Metamodel
CobolCopybook
Mapping Comments
     
Attribute Record Records that do not have any sub-record.
Name Name  
PhysicalName Name  
Position   Caclucated based on the record offsets and lengths
BaseType Picture Cacluated from picture. See DerivedType.
Class Record Record that has sub-records.
Name Name  
PhysicalName Name  
ClassDiagram   All records are included into default diagram automatically.
DerivedType Picture  
Length Picture  
Name Picture  
Scale Picture  
DesignPackage Record Created for records that have sub-records to display hierarchy.
Name Name  
FileDirectory COBOL Copybook file  
Name File name  
Generalization Record Created for records that have sub-records and parentrecord.
Name name  
GeneralizationRole Record  
StoreModel COBOL Copybook file  
Name File name