X12::Parser(3pm)

💖 X12::Parser — the Perl module for parsing X12 Transaction files 💖

okay so this is X12::Parser(3pm) from the User Contributed Perl Documentation, bestie, and it's literally the moment your X12 files stop being scary. 💅

---

✨ NAME ✨

X12::Parser — a Perl module for parsing X12 Transaction files. that's it, that's the whole vibe. 🦋

---

🌸 SYNOPSIS 🌸

use X12::Parser;

# Create a parser object
my $p = new X12::Parser;

# Parse a file with the transaction specific configuration file
$p->parsefile (
    file => '837.txt',
    conf => 'X12-837P.cf'
);

# Step through the file
while ( my $loop = $p->get_next_loop ) {
    my @loop = $p->get_loop_segments;
}

# or use this method instead
while ( my ($pos, $loop) = $p->get_next_pos_loop ) {
    my @loop = $p->get_loop_segments;
}

# or use
while ( my ($pos, $level, $loop) = $p->get_next_pos_level_loop ) {
    my @loop = $p->get_loop_segments;
}

like... look at her go. main character energy fr fr. 👑

---

🎀 ABSTRACT 🎀

The X12::Parser package gives you an efficient way to parse X12 transaction files. bestie, even though this package was built keeping HIPAA-related X12 transactions in mind, it's flexible and can be adapted to parse any X12 or similar transactions. she's versatile like that. 💜

---

🦋 DESCRIPTION 🦋

X12::Parser is a token based parser for parsing X12 transaction files. the way that parsing transaction files requires the presence of configuration files for the different transaction types? yeah, that's non-negotiable. you need the cf files. periodt.

the following methods are available:

• new — object constructor, no arguments, just vibes:

$p = new X12::Parser;

this is the object constructor method. it does not take any arguments. it only initializes the member variables required for parsing the transaction file. she's low maintenance. 🫶

• parsefile — the classic:

$p->parsefile(file => '837.txt', conf => 'X12-837P.cf');

this method takes two arguments. the first argument is the transaction file that needs to be parsed. the second argument specifies the configuration file to be used for parsing the transaction file.

to create your own configuration file, read the X12::Parser::Readme man page. iykyk. 📖

• parse — same energy, but with an open handle:

open($file, '837.txt');
$p->parse(handle => $file, conf => 'X12-837P.cf');

this method is similar to parsefile, except it takes an open file handle as input. no big deal, she's flexible. ✨

• closefile — say bye:

$p->closefile();

close an X12 file. if you parse an X12 file till the very end, the Parser will close the file for you. but if you only parse a few segments, you can explicitly close the file by calling closefile(); — she's not gonna do it for you, bestie. do it yourself. 💅

• get_next_loop — the girl who knows what's next:

$p->get_next_loop;

this function returns the name of the next loop that is present in the file being parsed. the loop name is as specified in the cf file. 🌈

• get_loop_segments — her ride or die:

$p->get_loop_segments;

this function returns the segments in the loop that was returned by get_next_loop(). this function is to be used in tandem with get_next_loop. if not, it may return/produce undesired results. 😭 like please don't use her alone, she needs her partner.

• get_next_pos_loop — now with position:

$p->get_next_pos_loop;

this function returns the next loop name and the segment position. note: position 1 corresponds to the first segment. not zero. one. she counts like a human. 🍓

• get_next_pos_level_loop — the deluxe version:

$p->get_next_pos_level_loop;

same as get_next_pos_loop() except that in addition this function returns the level of the loop. the level corresponds to the level of the loop in the loop hierarchy. the top level loop has level 1. 👑

• print_tree — artsy:

$p->print_tree;

prints the transaction file in a tree format. aesthetic. 🌳

• get_segment_separator — get the segment separator:

$p->get_segment_separator;

get the segment separator. simple. iconic. 💖

• get_element_separator — get the element separator:

$p->get_element_separator;

get the element separator. yes bestie, another one. 🌸

• get_subelement_separator — get the sub-element separator:

$p->get_subelement_separator;

get the sub-element separator. the trio is complete. ✨

---

the configuration files provided with this package and the corresponding transaction type are mentioned below. these are the X12 HIPAA transactions. 📋

• 1) type 270 — configuration file 270_004010X092.cf
• 2) type 271 — configuration file 271_004010X092.cf
• 3) type 276 — configuration file 276_004010X093.cf
• 4) type 277 — configuration file 277_004010X092.cf
• 5) type 278 — configuration file 278_004010X094_Req.cf
• 6) type 278 — configuration file 278_004010X094_Res.cf
• 7) type 820 — configuration file 820_004010X061.cf
• 8) type 834 — configuration file 834_004010X095.cf
• 9) type 835 — configuration file 835_004010X091.cf
• 10) type 837I — configuration file 837_004010X096.cf
• 11) type 837D — configuration file 837_004010X097.cf
• 12) type 837P — configuration file 837_004010X098.cf

these cf files are installed in under the X12/Parser/cf folder. 📁

the sample cf files provided with this package are good to the best of the authors knowledge. however the user should ensure the validity of these files. the user may use them as is at their own risk. fr fr, that's a real disclaimer, not a vibe check. 💀

---

💜 EXPORT 💜

None by default. she's not handing out anything unless you ask. 🙈

---

🌈 SEE ALSO 🌈

• for details on Transaction sets refer to: National Electronic Data Interchange Transaction Set Implementation Guide. Implementation guides are available for all the Transaction sets. 📚
• X12::Parser::Readme for more information on the Parser and configuration files.
• X12::Parser::Tree
• X12::Parser::Cf
• if you have a mailing list set up for your module, mention it here.
• if you have a web site set up for your module, mention it here.

---

👑 AUTHOR 👑

Prasad Balan, prasad@cpan.org — shoutout to the author bestie. 🫶

---

💅 COPYRIGHT AND LICENSE 💅

Copyright 2009 by Prasad Balan

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. slay, that's the license, no cap. ✨

---

and that's the whole page, bestie!! this was X12::Parser(3pm) from perl v5.38.2, dated 2024-03-09 — go parse something iconic. bye!! 🎀🦋💖