# objectum-ee
> Objectum Enterprise Edition - Javascript app platform
Latest version **3.8.49** (published 2024-04-08) · GPLv3 license · 0 weekly downloads
## Install
```sh
npm install objectum-ee
pnpm add objectum-ee
yarn add objectum-ee
bun add objectum-ee
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; large bundle.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.8.49 |
| Published | 2024-04-08 |
| First published | 2016-09-11 |
| Weekly downloads | 0 |
| License | GPLv3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 30 |
| Unpacked size | 44 MB |
| Known vulnerabilities | 0 (+35 in 10 direct dependencies) |
| Install scripts | no |
| Author | Dmitriy Samortsev |
| Maintainers | objectum |
| Keywords | objectum, orm, javascript, platform |
## Links
- npm: https://www.npmjs.com/package/objectum-ee
- Repository: https://github.com/objectum/objectum-ee
- Homepage: https://github.com/objectum/objectum-ee#readme
- Issues: https://github.com/objectum/objectum-ee/issues
- npm.io page: https://npm.io/package/objectum-ee
## Dependencies (30)
- [pg](https://npm.io/package/pg.md) ^8.5.1
- [ajv](https://npm.io/package/ajv.md) ^4.1.0
- [cors](https://npm.io/package/cors.md) ^2.8.5
- [imap](https://npm.io/package/imap.md) ^0.8.16
- [soap](https://npm.io/package/soap.md) ^0.19.0
- [xlsx](https://npm.io/package/xlsx.md) ^0.8.0
- [async](https://npm.io/package/async.md) ^1.5.0
- [jszip](https://npm.io/package/jszip.md) ^2.6.1
- [redis](https://npm.io/package/redis.md) ^2.3.0
- [bunyan](https://npm.io/package/bunyan.md) ^1.5.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [verror](https://npm.io/package/verror.md) ^1.6.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.15
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.4.7
- [express](https://npm.io/package/express.md) ^4.13.3
- [request](https://npm.io/package/request.md) ^2.81.0
- [backbone](https://npm.io/package/backbone.md) ^1.2.3
- [mustache](https://npm.io/package/mustache.md) ^2.2.1
- [formidable](https://npm.io/package/formidable.md) ^1.0.17
- [mailparser](https://npm.io/package/mailparser.md) ^0.5.3
- [nodemailer](https://npm.io/package/nodemailer.md) 0.7.1
- [simplesmtp](https://npm.io/package/simplesmtp.md) ^0.3.35
- [underscore](https://npm.io/package/underscore.md) ^1.9.1
- [xlsx-chart](https://npm.io/package/xlsx-chart.md) ^0.3.0
- [docxtemplater](https://npm.io/package/docxtemplater.md) ^1.0.8
- [elasticsearch](https://npm.io/package/elasticsearch.md) ^10.1.3
- [activedirectory](https://npm.io/package/activedirectory.md) ^0.7.0
- [pg-copy-streams](https://npm.io/package/pg-copy-streams.md) ^1.2.0
- [pg-query-stream](https://npm.io/package/pg-query-stream.md) ^1.1.1
- [connect-multiparty](https://npm.io/package/connect-multiparty.md) ^2.0.0
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 3.8.49 (latest) — 2024-04-08
- 3.8.48 — 2024-03-14
- 3.8.47 — 2023-12-28
- 3.8.46 — 2023-06-05
- 3.8.45 — 2023-03-31
- 3.8.44 — 2023-03-30
- 3.8.43 — 2023-03-30
- 3.8.42 — 2022-03-25
- 3.8.41 — 2021-10-01
- 3.8.40 — 2021-10-01
- 3.8.39 — 2021-09-29
- 3.8.38 — 2021-09-10
- 3.8.37 — 2021-08-23
- 3.8.36 — 2021-07-13
- 3.8.35 — 2021-07-13
- … 180 more at https://npm.io/package/objectum-ee/versions
## README
# Objectum Enterprise Edition - javascript app platform
Deprecated.
Русская версия
Objectum platform makes it easy to create realtime single page applications that run in both Node.js and browsers.
Objectum includes a powerful user interface constructor called Visual Objectum that creates grids, tree grids, forms, etc. Automatically generates source code for CRUD (create, read, update, delete) functions.
## Learn by Example project "To-Do list"
* [Initialization](#init)
* [Build user interface by Visual Objectum](#visual-objectum)
* [Class](#class)
* [Card](#card)
* [Query](#query)
* [Layout](#layout)
* [Menu](#menu)
* [Building](#building)
* [Advanced learning](#advanced)
* [Dictionary](#dictionary)
* [Table](#table)
* [Deployment](#deployment)
* [Objectum API](#api)
* [Client](#api-client)
* [Server](#api-server)
* [Sync (only client side)](#api-sync)
* [Reports (only client side)](#reports)
* [Locale](#locale)
* [Cluster](#cluster)
* [Objectum Firewall](#firewall)
Complete project https://github.com/objectum/todo
## Initialization
Create directories:
```bash
mkdir /opt/objectum/node
mkdir /opt/objectum/projects
mkdir /opt/objectum/projects/todo
mkdir /opt/objectum/projects/todo/bin
```
Install:
```bash
cd /opt/objectum/node
npm install objectum-ee
```
You must have installed [PostgreSQL 9.x](https://www.postgresql.org/download/) (datestyle = dmy)
Add project configuration (postgres password: 12345):
```bash
cat > /opt/objectum/projects/todo/config.json
{
"rootDir": "/opt/objectum/projects/todo",
"adminPassword": "D033E22AE348AEB5660FC2140AEC35850C4DA997",
"database": "postgres",
"host": "localhost",
"port": 5432,
"db": "todo",
"dbUser": "todo",
"dbPassword": "1",
"dbaUser": "postgres",
"dbaPassword": "12345",
"dbEngine": {
"enabled": 1
},
"visualObjectum": {
"menuConstructor": 1,
"accessConstructor": 1,
"projectConstructor": 1
}
}
```
Add platform configuration:
```bash
cat > /opt/objectum/node/config.js
module.exports = {
"rootDir": "/opt/objectum/node",
"projectsDir": "/opt/objectum/projects",
"port": 8100,
"storages": {
"todo": require ("/opt/objectum/projects/todo/config.json")
}
}
```
Add script:
```bash
cat > /opt/objectum/node/objectum.js
var objectum = require ("objectum-ee");
var config = require ("./config");
module.exports = new objectum.Objectum (config);
```
Add script:
```bash
cat > /opt/objectum/node/index.js
var objectum = require ("objectum-ee");
objectum.start (require ("./config"));
```
Add script:
```bash
cat > /opt/objectum/projects/todo/bin/init.js
var $o = require ("/opt/objectum/node/objectum");
$o.db.execute ({
code: "todo",
fn: "init",
name: "To-Do list",
locale: "en" // en, ru
});
```
Init project folder:
```bash
cd /opt/objectum/projects/todo/bin
node init.js
```
Prepare tablespace folder:
```bash
mkdir /opt/objectum/projects/todo/db
chown postgres:postgres /opt/objectum/projects/todo/db
```
Add script:
```bash
cat > /opt/objectum/projects/todo/bin/create.js
var $o = require ("/opt/objectum/node/objectum");
$o.db.execute ({
code: "todo",
fn: "create",
path: "/opt/objectum/projects/todo/db"
});
```
Create storage:
```bash
cd /opt/objectum/projects/todo/bin
node create.js
```
Add script:
```bash
cat > /opt/objectum/projects/todo/bin/import.js
var $o = require ("/opt/objectum/node/objectum");
$o.db.execute ({
code: "todo",
fn: "import",
file: "/opt/objectum/projects/todo/schema/schema-app.js" // parent storage
});
```
Import storage structure:
```bash
cd /opt/objectum/projects/todo/bin
node import.js
```
Start platform:
```bash
cd /opt/objectum/node
node index.js:
```
Start platform with forever:
```bash
forever start -a -l /opt/objectum/node/objectum.log -o /dev/null -e /opt/objectum/node/objectum-error.log --sourceDir /opt/objectum/node index.js
```
Stop platform with forever:
```bash
forever stop index.js
```
Open URL: http://localhost:8100/projects/todo/
Login: admin
Password: admin
Add script:
```bash
cat > /opt/objectum/projects/todo/bin/remove.js
var $o = require ("/opt/objectum/node/objectum");
$o.db.execute ({
code: "todo",
fn: "remove"
});
```
You can remove storage (drop tablespace, role, user from PostgreSQL):
```bash
cd /opt/objectum/projects/todo/bin
node remove.js
```
## Build user interface by Visual Objectum
1. Create class
2. Create class attribute
3. Create card
3.1. Open action layout
3.2. Open card
3.3. Add field to card
4. Create view
5. Create query
6. Create layout
7. Add table to layout
8. Create menu
9. Create menu item
10. Create admin account (login: adm) and select administrator menu
11. Build project
12. Reload browser page. Login as "adm". You can add, remove and open tasks.
## Advanced learning
### Dictionary
1. Create dict "status"
2. On message "Create standard dictionary (card, view)?" press "Yes".
3. Create menu item for dictionary
4. Create items
5. Create class attribute "status" in "task"
6. Open action layout and add field
7. Add column to view query
8. Build project and reload browser page
### Table
1. Create class "comment" with attributes: text, task
2. Open action "comment.card" layout and add field
3. Change action "task.create"
4. Create view "comments" and query for comments
5. Open action "task.card" layout and convert card to splitter
6. Add table for comments
7. Add option
8. Build project and reload browser page
### Deployment
Add script:
```bash
cat > /opt/objectum/projects/todo/bin/export.js
var $o = require ("/opt/objectum/node/objectum");
$o.db.execute ({
code: "todo",
fn: "export",
file: "../schema/schema-todo.js",
filterClasses: ["task", "comment"]
});
```
Export storage:
```bash
cd /opt/objectum/projects/todo/bin
node export.js
```
Add script:
```bash
cat > /opt/objectum/projects/todo_my/bin/import.js
var $o = require ("/opt/objectum/node/objectum");
$o.db.execute ({
code: "todo_my",
fn: "import",
file: "/opt/objectum/projects/todo/schema/schema-todo.js" // parent storage
});
```
Import your storage "todo" to new created storage "todo_my":
```bash
cd /opt/objectum/projects/todo_my/bin
node import.js
```
Just export "todo" and import "todo" to "todo_my" for update to new version of storage "todo". Stop platform before import storage.
### Objectum API
startTransaction - start transaction. Only one transaction for one session allowed.
commitTransaction - commit transaction.
rollbackTransaction - rollback transaction.
createObject - create object
getObject - get object
set - set attribute value
sync - save object changes to storage
remove - remove object
execute - execute SQL query (only SELECT)
### Client
```bash
storage.startTransaction ("description", function (err) {
});
```
```bash
storage.commitTransaction (function (err) {
});
```
```bash
storage.rollbackTransaction (function (err) {
});
```
```bash
storage.createObject ("class", function (err, object) {
var id = object.get ("id");
});
```
```bash
storage.getObject (id, function (err, object) {
object.set ("text", "Changed text");
object.sync (function (err) {
});
});
```
```bash
object.remove ();
object.sync (function (err) {
});
```
```bash
storage.execute ({
asArray: true,
select: [
{"a": "id"}, "id",
{"a": "name"}, "name",
{"b": "name"}, "status"
],
from: [
{"a": "task"},
"left-join", {"b": "spr.status"}, "on", [{"a": "status"}, "=", {"b": "id"}]
],
where: [
{"a": "name"}, "like", "Buy%", "and", {"a": "id"}, "in", [1000, 1002, 1003, 1004, 1005].join (".,.").split (".")
],
order: [
{"a": "name"}
]
}, function (err, recs) {
_.each (recs, function (rec) {
console.log (rec.id, rec.name, rec.status);
});
});
```
### Server
```bash
storage.startTransaction ({session: session, description: "description"}, function (err) {
});
```
```bash
storage.commitTransaction ({session: session}, function (err) {
});
```
```bash
storage.rollbackTransaction ({session: session}, function (err) {
});
```
```bash
storage.createObject ({session: session, code: "class"}, function (err, object) {
var id = object.get ("id");
});
```
```bash
storage.getObject ({session: session, id: id}, function (err, object) {
object.set ("text", "Changed text");
object.sync ({session: session}, function (err) {
});
});
```
```bash
object.remove ();
object.sync ({session: session}, function (err) {
});
```
```bash
storage.execute ({session: session, sql: {
asArray: true,
select: [
{"a": "id"}, "id",
{"a": "name"}, "name",
{"b": "name"}, "status"
],
from: [
{"a": "task"},
"left-join", {"b": "spr.status"}, "on", [{"a": "status"}, "=", {"b": "id"}]
],
where: [
{"a": "name"}, "like", "Buy%", "and", {"a": "id"}, "in", [1000, 1002, 1003, 1004, 1005].join (".,.").split (".")
],
order: [
{"a": "name"}
]
}}, function (err, recs) {
_.each (recs, function (rec) {
console.log (rec.id, rec.name, rec.status);
});
});
```
### Sync (only client side)
```bash
$o.startTransaction ("description");
```
```bash
$o.commitTransaction ();
```
```bash
$o.rollbackTransaction ();
```
```bash
$o.createObject ("class");
var id = object.get ("id");
```
```bash
var object = $o.getObject (id);
object.set ("text", "Changed text");
object.sync ();
```
```bash
object.remove ();
object.sync ();
```
```bash
var recs = $o.execute ({
asArray: true,
select: [
{"a": "id"}, "id",
{"a": "name"}, "name",
{"b": "name"}, "status"
],
from: [
{"a": "task"},
"left-join", {"b": "spr.status"}, "on", [{"a": "status"}, "=", {"b": "id"}]
],
where: [
{"a": "name"}, "like", "Buy%", "and", {"a": "id"}, "in", [1000, 1002, 1003, 1004, 1005].join (".,.").split (".")
],
order: [
{"a": "name"}
]
});
```
### Reports (only client side)
```bash
var rows = [{
cells: [{
text: "Cell 1 1", style: "border", rowspan: 2
}, {
text: "Cell 1 2", style: "border", colspan: 2
}]
}, {
startIndex: 2, cells: [{
text: "Cell 2 2", style: "border"
}, {
text: "Cell 2 3", style: "border"
}]
}];
var report = new $report.xmlss ();
report.sheets = [
new $report.sheet ({
name: "Sheet1",
orientation: "landscape",
autoFitHeight: true,
margins: {
left: 15,
top: 15,
right: 15,
bottom: 15
},
columns: [15, 15, 15],
rows: rows
})
];
report.preview ();
```
### Locale
You can add another locale file in this folder
https://github.com/objectum/objectum-ee/tree/master/www/client/extjs4/locale
Change "locale" in projects/todo/index.html
```bash
```
### Cluster
Install [Redis](https://redis.io/download)
Change platform configuration:
```bash
module.exports = {
"rootDir": "/opt/objectum/node",
"projectsDir": "/opt/objectum/projects",
"port": 8100,
"storages": {
"todo": require ("/opt/objectum/projects/todo/config.json")
},
"redis": {
"enabled": true,
"host": "127.0.0.1",
"port": 6379,
"resetCache": true,
"db": 1
},
"cluster": {
"www": {
"port": 8100,
"workers": 3
},
"app": {
"workers": 3
}
}
}
```
www-worker - work on cluster.www.port
app.worker - work on cluster.www.port ++ (8101, 8102, 8103). Service worker on 8101, not used for user requests.
Change index.js for start in cluster mode:
```bash
var objectum = require ("objectum-ee");
objectum.startCluster (require ("./config"));
```
Cluster architecture:
### Objectum Firewall
Install firewall https://github.com/objectum/objectum-firewall
Example for role "Commentator"
Can CRUD comments for tasks. Other functions blocked on API level.
Create configuration config.js:
```bash
```
## Author
**Dmitriy Samortsev**
+ http://github.com/objectum
## Copyright and license
GPLv3
---
_Source: https://npm.io/package/objectum-ee · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._