lulzzz/cbe

Common Business Entities - Persistence, Schema, API

Common Business Entities (CBE)

CBE provides RESTful CRUD and administration for common business entities persisted on a relational DB. The rationale is discussed in the Wiki

The CBE projects goal is to provide a generic schema/API/persistence layer which can be used for all the common functions in an enterprise and extended for each industry/business. CBE can be used to underpin microservice, SOA, EDA or MDM architecture.

Industry Specific Extension Projects

• Retail
• Utilities (Telco/Energy/Media)

Sources: TM Fourum SID (Telco), IBM IFW (Finance/Banking), IAA (Insurance)

To run

git clone https://github.com/Semprini/cbe.git
cd cbe
pip install -r requirements.txt
python manage.py migrate (will use a default sqllite db)
python manage.py createsuperuser <username> <email> <password>
python manage.py runserver
browse to http://localhost:8000/admin for the admin interface
browse to http://localhost:8000/api for the api interface

How is this different to an API from a product?

The API/Persistence/Admin uses techniques like generic foreign keys to express relationships that provide consistent schema for use in multiple contexts. A product will rightly store data for it's own purpose and we then use architectures like SOA to expose and adjust the semantics for different contexts. The CBE persistence layer has pointers to abstract classes which provides a faithful realization of the data model rather than through a transformation layer.

Entity Domains:

• Party - Entities relating to individuals, organizations, how to contact them and the roles they play
• Location - Entities for addresses and places
• Business interaction - Entities for how parties interact in the business
• Customer - The parties that a business sells products or services to
• Trouble - Tracking problems and issues

Coming soon to a data model near you:

• More roles for PartyRole and BusinessInteraction
• Product

The data model is designed to be extended for each industry. In Party, the PartyRole class is the main abstract entity from which concrete classes like Customer or Supplier should be derived.

Check the Wiki for more info. The data model is held in the Docs folder as a Sparx EA model

Virtual Desktop Environment

To use a virtual environment requires VirtualBox and Vagrant, from the workspace run:

vagrant up

Direct PowerShell Access

To access the buildserver using native remote PowerShell. Allow credential delegation, on-off step needed on the host when using VirtualBox/Vagrant.

./automation/provisioning/runner.bat CredSSP.ps1 client

Once delegation configured, the build emulation can be executed.

$securePassword = ConvertTo-SecureString 'vagrant' -asplaintext -force
$cred = New-Object System.Management.Automation.PSCredential ('vagrant', $securePassword)
enter-pssession 127.0.0.1 -port 15985 -Auth CredSSP -credential $cred
cd C:\vagrant
.\automation\cdEmulate.bat

Make your own fork

git clone https://github.com/cdaf/cbe.git
cd cbe
git remote add upstream https://github.com/Semprini/cbe.git

Once established, use the following to synchronise

git fetch upstream
git pull upstream master