README.md

Tools for AbraFlexi

Set of commandline tools for interaction with AbraFlexi server

AbraFlexi Get

Obtain record data from AbraFlexi

Usage:

fbget -eevidence-name -iRowID [-u] [-cpath] [column names to show] 

-p path to custom config file -u show record URL

Example:

~$ fbget -v -u -c /etc/abraflexi/localhost-client.json -e adresar -i 666 kod nazev
https://localhost:5434/c/spoje_net_s_r_o_/adresar/666&detail=custom:kod,nazev

{
    "external-ids": [
        "ext:subreg:36699",
        "ext:ipex:58487"
    ],
    "id": "666",
    "kod": "VITEX",
    "nazev": "V\u00edt\u011bzslav Dvo\u0159\u00e1k",
    "kontakty": [
        {
            "id": "2371"
        }
    ]
}

AbraFlexi PUT

Insert or update record data in AbraFlexi

Usage:

fbput -eevidence -iRowID [-cpath] [-u] [--colum-name=value] [--colum-name2=value2] ...

-p path to custom config file -u show record URL

Example:

fbput.php --evidence adresar -i 333 -u --nazev=Zmeneno

https://demo.abraflexi.eu:5434/c/demo/adresar/333
{"winstrom":{"@version":"1.0","success":"true","stats":{"created":"0","updated":"1","deleted":"0","skipped":"0","failed":"0"},"results":[{"id":"333","request-id":"333","ref":"

AbraFlexi company Copy

Copy one AbraFlexi company to another AbraFlexi

Usage:

fbcp https://user:password@abraflexi.source.cz:5434/c/firma_a_s_  https://user:password@abraflexi.destination.cz:5434/c/firma_a_s_  [production] 

Use production parameter to keep EET, Auto Sending Mails and WebHooks enabled in restored company.

Example:

fbcp https://lgn:pwd@company.abraflexi.eu:5434/c/company_name https://lgn2:pwd2@vitexsoftware.abraflexi.eu:5434/c/company_name
04/14/18 13:57:18 `FlexiPeeHP\Company`  ⓘ saving backup
04/14/18 13:57:25 `FlexiPeeHP\Company`  ❁ backup saved
04/14/18 13:57:26 `FlexiPeeHP\Company`  ⓘ Remove company before restore
04/14/18 13:57:27 `FlexiPeeHP\Company`  ☠ JSON Decoder: Syntax error
04/14/18 13:57:27 `FlexiPeeHP\Company`  ⚙ ok
04/14/18 13:57:27 `FlexiPeeHP\Company`  ❁ restore begin
04/14/18 13:57:58 `FlexiPeeHP\Company`  ❁ backup restored

Create New Company in AbraFlexi

    fbnc  new_company_name
    fbnc  https://user:password@abraflexi.source.cz:5434/c/nova_firma_a_s_

Delete Company in AbraFlexi

    fbdc company_to_delete
    fbdc https://user:password@abraflexi.source.cz:5434/c/smazat_firma_a_s_

Configuration file example

{
    "ABRAFLEXI_URL": "https:\/\/demo.abraflexi.eu:5434",
    "ABRAFLEXI_LOGIN": "winstrom",
    "ABRAFLEXI_PASSWORD": "winstrom",
    "ABRAFLEXI_COMPANY": "demo"
}

Default config file location is /etc/abraflexi/client.json ( also provided by abraflexi-client-config debian package )

WebHooks Wipe

Drop all webHooks

    fbwhwipe [custom config file] 

WebHook establish

Register new webhook in AbraFlexi

    fbwh  http://webhook.processor/url [xml|json] [custom/config.json]

Fake Address Generator

abraflexi-fake-address --config=../tests/client.json -i 10

create 10 fake address

Benchmark

Options:

• -p - prepare database for test
• -c - num of cycles
• -s - sleep x seconds after each operation

abraflexi-benchmark -p -c 10 -d 10

Count time of several operations speed upon given company/database.

Certificate Updater

Generate or renew HTTPS certificate

abraflexi-certbot

Installation

To install tools into vendor/bin please use composer:

composer require vitexsoftware/abraflexi-tools

For Debian or Ubuntu please use repo:

sudo apt install lsb-release wget
echo "deb http://repo.vitexsoftware.cz $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/vitexsoftware.list
sudo wget -O /etc/apt/trusted.gpg.d/vitexsoftware.gpg http://repo.vitexsoftware.cz/keyring.gpg
sudo apt update
sudo apt install abraflexi-tools

We use:

• PHP Language
• PHP AbraFlexi - Library for Interaction with AbraFlexi
• Ease Core - Glue & Tool Set

Thanks to:

• PureHTML & Spoje.Net for support
• Abra for AbraFlexi