SIE file reader/writer
npm install sieThis documentation is in swedish since SIE is a local standard for transferring accounting information.
Mer information om SIE hittar du på SIE-gruppens hemsida.
- Installation
- Modulobjekt
- readFile(sökväg, callback)
- readBuffer(buffert)
- Klass: SieFile
- Lista av poster
- list(etikett)
- getKonto(kontonr)
- getObjekt(dimensionsnr, objektnr)
- Exempel
- Licensvillkor
``bash`
$ npm install sie-reader
För att kunna använda läsaren måste du lägga till modulen i din lösning:
`js`
var sie = require('sie-reader');
Din callback behöver ta två argument err och data. Om inget fel inträffat innehåller data-argumentet ett SieFile-objekt.
`js`
sie.readFile('minFil.SIE', function(err, data){
if (err) throw err;
// Använd data
});
Argumentet original_data måste vara en instans av klassen Buffer, se dokumentationen för node.js
`js`
var sieFile = sie.readBuffer(original_data);
SieFile innehållande en objektstruktur med SIE-poster. SieFile-objektet erbjuder dessutom ett antal hjälpmetoder för vanligt förekommande, eller besvärliga, uppgifter.
SieFile har en lista med objekt, poster, motsvarande posterna i SIE-filen. Underposter återfinns inte i listan utan lagras i en lista i den post de hör till.Objekten listan motsvarar de objekt som finns i SIE-formatet och objektens attribut har samma namn som motsvarande postargument i SIE, t.ex. innehåller kontoobjektet attributen kontonr och kontonamn.
För att avgöra vilken typ av post ett objekt motsvarar finns ett alltid extra attribut, etikett. Attributet innehåller postens etikett i gemener och exklusive det inledande #-tecknet. Ett exempel på ett kontoobjekt:
`js`
{ "etikett": "KONTO", "kontonr": "1790", "kontonamn": "Övr interimsfordringar" }
Om objektet har underobjekt finns finns dessutom ett poster-attribut innehållande underobjekten. Således har objekt med etikett == "ver" en lista med transaktionsposter.
list kan användas för att filtrera listan av poster. Endast poster med den angivna etiketten returneras. Följande exempel ger en lista innehållande samtliga verifikat:
`js`
var verifikat = sieFile.list("ver");
Du kan dessutom ange ytterligare argument, utöver etikett, i form av namn/värde-par för att filterera på posternas attribut.
Följande exempel ger en lista innehållande verifikaten i serie A:
`js`
var verifikat = sieFile.list("ver", "serie", "A");
getKonto är en ren bevämlighetsfunktion som returnerar ett enda objekt, d.v.s. inte en lista med ett element. Dessutom slår den upp ytterligare information för kontot som kontotyp och SRU-kod och lägger till denna som attribut i det returnerade objektet.Följande visar hur kontots namn kan slås upp om kontonumret är känt:
`js`
var kontonamn = sieFile.getKonto("1790").kontonamn;
getObjekt hjälper dig att slå upp ett föräldraobjekt m.h.a. SIE-filens dimensionsangivelser.Metoden returnerar ett objekt som, utöver de attribut som hör till poster av typen #OBJEKT, inkluderar extra attributen namn, innehållande det sammansatta (konkaternerade) namnet, och parent som är en pekare till föräldraobjektet.
Konkateneringen sker genom att lägga till föräldernsnamn framför objektets eget namn med ett separatortecken mellan. Standardseparatorn är ett blanksteg. Du kan ändra separator genom att ange ett tredje argument till metoden.
Om SIE-filen innehåller nedanstående data så är sieFile.getObjekt("21, "0102") == "Barnavd Barn 1-3 år".
`
#DIM 20 "Avdelning"
#UNDERDIM 21 "Underavdelning" 20
#OBJEKT 20 "01" "Barnavd"
#OBJEKT 20 "02" "Ungdomsavd"
#OBJEKT 21 "0101" "Spädbarn"
#OBJEKT 21 "0102" "Barn 1-3 år"
o.s.v.
`js``
var express = require('express');
var sie = require('sie-reader');
var sieFileName = './FAKT.SI';
var app = express();
app.use(express.bodyParser());
app.all('*', function(req, res, next){
sie.readFile(sieFileName, function(err, sieFile){
if (err) next(err);
else {
sieFile.list('ver').forEach(function(v) {
v.poster.forEach(function(t) {
t.kontonamn = sieFile.getKonto(t.kontonr).kontonamn;
if (t.objektlista) t.objektlista.forEach(function(o) {
var od = sieFile.getObjekt(o.dimensionsnr, o.objektnr);
o.objektnamn = od.objektnamn;
o.namn = od.namn;
});
});
});
res.json(sieFile.list('ver'));
}
});
});
app.listen(3000, '127.0.0.1');
Exemplet använder Express som webbramverk.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.