Wed 29 April 2020 4 min(s)

Check out vcmcemtex's latest documentation at https://github.com/dalikewara/vcmcemtex

npm package

versionbuildlanguagedownloaddependentsissuelast_commitlicense

An universal & customable cemtext generator for batch transactions

Cemtext file format is a format used by banks to allow for batch transactions. Some bank have adopted this format by default, but each others can have a different format style. This module allows you to create a cemtext format by your own style—that means you can use it to meet your bank cemtext requirements. This module is fast, easy to understand, and more humanable.

Installation

NPM

npm install vcmcemtex --save

Browser

// Bower
bower install vcmcemtex --save

Initialization

NPM

const vcmcemtex = require('vcmcemtex');

Browser

// Bower
<script src="bower_components/vcmcemtex/dist/vcmcemtex.min.js"></script>

Quickstart

vcmcemtex(params, options[optional]).then(cemtex => {
  console.log(cemtex);
});

Each successful generated row in a cemtext has length that equal to charlen—default is 160 characters. So it is 160 header length, 160 detail length (per 1 row), and 160 footer length. Example:

// string | length 4
'char'
// string | length 8
'username'

// and the cemtext output will be like this (in single string/one row):

'charusername                                                                                                                                                    '

You can change default charlen value by passing an options in second argument.

A simple cemtext format can be done like this:

vcmcemtex({
  header: {
    header1: { type: 'lps', length: 10, value: 'header' }
  },
  detail: {
    keys: {
      detail1: { type: 'lps', length: 10 }
    },
    data: [
      {
        detail1: 'detail'
      }
    ]
  },
  footer: {
    footer1: { type: 'lps', length: 10, value: 'footer' }
  }
}).then(cemtex => {
  console.log(cemtex);
});

// output
// '    header                                                                                                                                                          detail                                                                                                                                                          footer                                                                                                                                                      '

params object has 3 main keys; header, detail, and footer. You don't have to use them (optional), but it's always good to use them for best practice style.

If you prefer to use key detail, the key must have key keys and data. keys is an object, and the data must be an array object. The object keys between keys and data should be same, for example if keys has a key called detail1, then key data should contains a key called detail1—similliar to attribute value in header and footer.

You can see other examples bellow:

var data = [
  {
    name: 'John Doe',
    username: 'johndoe',
    email: 'johndoe@email.com',
    accountNumber: '123456789',
    testAmount: '12500'
  },
  {
    name: 'John Smith',
    username: 'johnsmith',
    email: 'johnsmith@email.com',
    accountNumber: '123456789',
    testAmount: '12500'
  },
  {
    name: 'John Adam',
  }
];

vcmcemtex({
  header: {
    record: { type: 'lps', length: 1, value: '1' },
    branch: { type: 'lpz', value: '1234' },
    name: { type: 'rps', value: 'HEADER NAME' },
    date: { type: 'lpz', value: '20190211' },
    test1: { type: 'rps', value: 'test1' },
    test2: { type: 'rps', value: 'test2' }
  },
  detail: {
    keys: {
      name: { type: 'rps', length: 10, default: '' },
      username: { type: 'rps', length: 10, default: '' },
      email: { type: 'rps', length: 20, default: '' },
      accountNumber: { type: 'lpz', length: 10, default: '' },
      testAmount: { type: 'lpz', length: 10, default: '' }
    },
    data: data
  },
  footer: {
    record: { type: 'lpz', length: 1, value: '3' },
    totalData: { type: 'lpz', length: 11, countAllData: true },
    totalAmount: { type: 'lpz', length: 11, countFromDetail: 'testAmount' }
  }
}, {
  charlen: 200
}).then(cemtex => {
  console.log(cemtex);
});

// output
// '11234HEADER NAME20190211test1test2                                                                                                                                                                      John Doe  johndoe   johndoe@email.com   01234567890000012500                                                                                                                                            John Smithjohnsmith johnsmith@email.com 01234567890000012500                                                                                                                                            John Adam                               00000000000000000000                                                                                                                                            30000000000300000025000                                                                                                                                                                                 '

Using an option enter:

vcmcemtex({
  header: {
    testHeader: { type: 'lps', length: 1, value: '1' },
    branch: { type: 'lpz', value: '1234' },
    name: { type: 'rps', value: 'HEADER NAME' },
    date: { type: 'rpz', value: '20190211' },
    test1: { type: 'rps', value: 'test1' },
    test2: { type: 'rps', value: 'test2' }
  },
  footer: {
    thisIsFooter: { type: 'lps', length: 1, value: '3' },
    footer1: { type: 'lpz', value: '1000000' },
    footer2: { type: 'rps', value: '2000000' }
  }
}, {
  enter: true
}).then(cemtex => {
  console.log(cemtex);
});

// output
// 11234HEADER NAME20190211test1test2                                                                                                                              
// 310000002000000                                                                                                                                                 

Release

Changelog

See https://github.com/dalikewara/vcmcemtex/blob/master/CHANGELOG.md.

Credits

Copyright © 2019 Dali Kewara.

License

MIT License

Cover image

Article history:

>> Friday 08:41 PM, May 01 2020 | "add articles description"
>> Thursday 07:10 PM, April 30 2020 | "update scripts"