BINETIX NETWORK

The overall concept behind the development of Erlang/OTP solutions for BINETIX® AGE™ is to keep your existing implementation untouched and to extend the Erlang's App specifications to support the AGE API. You should take into consideration that AGE's node configuration is also Erlang/OTP compliant and provides powerful functionality to centralize and maintain the configuration of your App (solution). Consequently, you can "inherit" these benefits just by starting the AGE's node as standard Erlang application automatically with your own App into the same BEAM virtual machine.

But first things first! We shall use the MAKE_APP Toolset to (re)configure your Erlang's Solution in order to automate the compilation and the integration with AGE's node using one single make_app.config file.

The "Prerequisites" section below explains how to prepare the development environment to use external libraries, like AGE application.

1)Your new or existing Erlang solution is deployed into one root directory named "trunk".

2)Your Erlang solution has to have directory structure for development environment compliant with Erlang/OTP design principles;

3)Your make_app.config file is deployed in the root of this directory structure;

4)The MAKE_APP Toolset is installed and ready for use;

5)All external libraries and applications are installed into a dedicated directory named "lib". This directory could hold AGE Node App, Plug-in applications and other external libraries. This directory could be shared with other Erlang Apps, however for this description it shall be positioned on the same level of your current solution.

       Directory tree of Erlang solution for BINETIX AGEâ„¢

Your Erlang solution has to have make_app.config aligned with the following instructions:

a)The Erlang extension should be activated. It is recommended to activate also the Files extension in order to secure the required directory structure.

b)The libs section of solution configuration element should refer as minimum to the latest AGE node distribution package. In this section you could add more AGE plug-ins or other external libraries.

c)The spec section of solution configuration element should include the following standard configuration options of your Erlang app - id, vsn, description.

Note: Take into consideration that MAKE_APP tool-set is generating automatically the Erlang's application resource file and the configuration options modules and applications will be completely overwritten, so it is not recommended to apply these options into your spec section.

d)The solution configuration element has to have as minimum one software project.

e)You could organize your software project at your discretion, however, it is recommended the directory structure to be aligned with Erlang/OTP best practices. Therefore, we're considering that the source code of your application is stored into src sub-directory.

f)To perform compilation, deployment and execution activities you have to define tasks in accordance with your particular needs. In order to help you get started we've provided some commonly used predefined tasks into the following template of make_app.config file.

{include, files}.
{include, erlang}.
 
{solution, my_solution, #{
  name      => "New Erlang solution for BINETIX AGE",
  projects  => [project_core],
  libs      => [
    {age,      "../lib/age-2019.1/ebin"},
    {cryptela, "../lib/cryptela-1.5.7/ebin"},
    {postgres, "../lib/postgres-9.6.3/ebin"}
  ],
 
  spec => [
    {id,           "MY_SOLUTION"},
    {vsn,          "1.0.0"},
    {description,  "Application for BINETIX AGE"},
    {registered,   []},
    {start_phases, []},
    {env,          []}
  ]
}}.
 
{project, project_core, #{
  name   => "PROJECT (Core)",
  source => [
    "src",
    {"tests", [eunit, warnings_as_errors]}
  ],
 
  tasks => [
    {delete, [{file, "my_solution.rel"}, {file, "my_solution.script"}]},
    {create, [{dir,  "ebin"},    {dir, "logs"}, {dir, "data"}, {dir, "config"}]},
    {verify, [{dir,  "include"}, {dir, "doc"},  {dir, "priv"}, {dir, "src"}]},
    {verify, [
      {file,  "../lib/age-2019.1/ebin/age.app"},
      {files, "../lib/age-2019.1/ebin/*.beam"},
      {files, "../lib/age-2019.1/include/*.hrl"}
    ]},
 
    {debug,  [{outdir, "ebin"}, {i, "include"}, {i, "../lib/age-2019.1/include"}, {d, '_ENABLE_TESTS'}, {d, '_DEBUG'}]},
    {make,   [local]},
    {epack,  [{dirs, [config]}]},
    {edoc,   []},
    {run,    [{sname, my_solution@localhost}, {setcookie, my_solution}]}
  ]
}}.
 
{task, delete, #{command => delete_files, call => [compile, release, build, deploy]}}.
{task, create, #{command => create_files, call => [compile, release, build, deploy]}}.
{task, verify, #{command => verify_files, call => [compile, release, build, deploy, run]}}.
{task, copy,   #{command => copy_files,   call => [compile, release, build, deploy]}}.
 
{task, debug, #{
  label   => "Erlang: DEBUG (compiler)",
  call    => [compile, build],
  command => erlc,
  args    => [
    return_errors,            % Reports compilation errors.
    return_warnings,          % Reports compilation warnings.
    warn_export_all,          % Causes a warning to be emitted if the export_all option has also been given.
    warn_export_vars,         % Causes warnings to be emitted for all implicitly exported variables.
    warn_shadow_vars,         % Causes warnings to be emitted for "fresh" variables in functional objects.
    warn_obsolete_guard,      % Causes warnings to be emitted for calls to old type testing BIFs.
    warn_deprecated_function, % Causes warnings to be emitted for every call to a function known by the compiler as deprecated.
    warn_unused_function,     % Causes warnings to be emitted for unused functions.
    warn_unused_records,      % Causes warnings to be emitted for unused records.
    warn_unused_vars,         % Causes warnings to be emitted for unused variables.
    warn_unused_import,       % Causes warnings to be emitted for unused imported functions.
    {warn_format, 2},         % Causes warnings to be emitted for malformed format strings as arguments to io:format functions.
    debug_info,               % Include debug information in the form of abstract code in the compiled beam module.
    verbose                   % Causes more verbose information from the compiler
  ]
}}.
 
{task, release, #{
  label   => "Erlang: RELEASE (compiler)",
  call    => [release, build],
  command => erlc,
  args    => [
    rebuild,                  % Rebuilds source files.
    return_errors,            % Reports compilation errors.
    return_warnings,          % Reports compilation warnings.
    warnings_as_errors,       % Causes warnings to be treated as errors.
    verbose                   % Causes more verbose information from the compiler
  ]
}}.
 
{task, edoc, #{
  label   => "Erlang: Generate documentation",
  call    => [build, deploy],
  command => edoc,
  args    => [no_packages]
}}.
 
{task, make, #{
  label   => "Erlang: Generate boot script",
  call    => [build, deploy],
  command => emake,
  args    => [no_warn_sasl],
  apps    => [
    {kernel,     permanent},
    {stdlib,     permanent},
    {sasl,       permanent},
    {asn1,       permanent},
    {crypto,     permanent},
    {public_key, permanent},
    {ssl,        permanent},
    {inets,      permanent}
  ]
}}.
 
{task, epack, #{
  label   => "Erlang: Create release package",
  call    => deploy,
  command => epack,
  args    => []
}}.
 
{task, run, #{
  label   => "Erlang: RUN (shell)",
  call    => run,
  command => eshell,
  args    => [
    {smp, enable}, {shutdown_time, 5000},
    "+a 8192 +A 200 +SDio 200 +B i +d +r"
  ]
}}.