vCard Input transform Icon vCard Input

Description

The vCard Input transform reads vCard (.vcf) files and outputs one row per contact card.

Each configured vCard property is mapped to a stream field. Supported properties include formatted name, structured name parts, UID, organization, title, email, telephone, URL, categories, and notes.

For EMAIL and TEL properties you can optionally filter on TYPE parameters (for example INTERNET,WORK). Companion mappings such as email_type and tel_type extract the TYPE values from the vCard.

More information on the vCard format is available on Wikipedia

Supported Engines

Hop Engine

Supported

Spark

Maybe Supported

Flink

Maybe Supported

Dataflow

Maybe Supported

Options

File Tab

Option Description

Transform name

Name of the transform. This name has to be unique in a single pipeline.

File or directory

Specifies the location and/or name of the input vCard file or directory.

Add

Adds the file, directory, or wildcard combination to the list of selected files.

Browse

Select a file or directory from the local filesystem.

Regular expression

Regular expression used to select files in the specified directory.

Exclude regular expression

Regular expression used to exclude files from the selection.

Selected files

List of files or wildcard selections and whether each file is required.

Delete

Removes the selected file or wildcard from the list.

Edit

Edits the selected file or wildcard.

Show filename(s)

Previews the files that will be read.

Accept filenames from previous transforms

Read vCard files from filenames received in the input stream instead of the static file list.

Transform to read from

The upstream transform that provides the filename field.

Filename field

The field in the input stream that contains the filename.

Pass through fields from source transform

When accepting filenames from a previous transform, copy all fields from that transform to the output.

Include filename in output

Adds the filename to each output row.

Filename output field

The name of the field that receives the filename.

Encoding

Character encoding used to read the vCard files.

Ignore empty files

Skip empty files instead of failing.

Do not fail if no files

Do not raise an error when no files match the selection.

Add files to result filenames

Adds the read filenames to the pipeline result.

Fields Tab

Option Description

Field mappings

Maps vCard properties to output stream fields.

Stream field

The name of the output field.

vCard property

The vCard property to read (for example FN, EMAIL, TEL).

TYPE parameters

Optional TYPE filter for EMAIL and TEL properties (comma-separated, for example INTERNET,WORK).

Get fields

Reads vCard properties from the configured sample files and suggests field mappings.

Use cases

  • Import contacts from .vcf exports (mail clients, CRM systems, mobile devices).

  • Enrich pipelines with contact data alongside other sources.

  • Round-trip testing with vCard Output.

Metadata injection support

All fields of this transform support metadata injection. You can use this transform with ETL Metadata Injection to pass metadata to your pipeline at runtime.