Web modeler SDK

The web modeler SDK Description​

The web modeler SDK is available in the web modeler, It allows users access resources from user interface and execute complexe computational in the user interface run time.

The SDK has the following classes

class SoftyFlow {}
class Collection {}
class SQLDatabase {}
class CustomList {}
class Report {}
class Instance {}
class Task {}
class Api {}
class Email {}
class File {}

In the following sections we will explicit each class and the allowed methods.

1 - SoftyFlow​

The SoftyFlow class has the SoftyFlow system methods

Usage​

This class is instantiated by default as object named SF when the user interface is loaded, so you can use methods directly by calling them via object "SF"

//using SF object
let currentMode = this.SF.getSF_mode();

getSF_mode​

Is a function that return the mode of the running user interface

Returns​

Examples​

let currentMode = this.SF.getSF_mode();

getSF_Version​

Is a function that return the version of the running user interface

Returns​

Examples​

let currentVersion = this.SF.getSF_Version();

queryParams​

Is a function that return the query parameters

Parameters​

Returns​

Examples​

let currentMode = this.SF.getSF_mode('SF_mode SF_version');
console.log(currentMode)
// ?SF_mode=test&SF_version=versionId

startProcess​

Is a function that start specific process

Parameters​

Returns​

Examples​

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.startProcess('processId', variables);

validateCaptcha​

Is a function that validates a Google reCAPTCHA v3 action and returns the generated token.

Parameters​

Returns​

Examples​

let token = await SF.utils.validateCaptcha("login_form");
// returns: '03AFcWeA... (a long token string from Google)'

saveNew​

Is a function that allow to you to save the user interface state

Parameters​

Returns​

Examples​

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.saveNew('interfaceId', variables);

saveTask​

Is a function that allow to you to save the task interface state

Parameters​

Returns​

Examples​

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.saveTask('taskId', variables);

validateTask​

Is a function that allow to validate Task

Parameters​

Returns​

Examples​

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.validateTask('taskId', variables);

getUserPendingTask​

Is a function that allow to get pending Task assigned to connected user.

Parameters​

Returns​

Examples​

await this.SF.getUserPendingTask('limit', 'page', 'dueDate', 'fields');

uploadImage​

Is a function that uploads an image to the server using a multipart/form-data POST request.

Parameters​

Returns​

Examples​

const formData = new FormData();
formData.append("profileImage", file);

let response = await SF.utils.uploadImage(formData);
// returns: { success: true, imageUrl: "/uploads/user123.png" }

setListFromCollection​

Is a function that allow to set list of data from a specific collection.

Parameters​

Returns​

Examples​

let criteria = { 
  firstName: new RegExp("p", "i")
}
await this.SF.setListFromCollection('collectionId', criteria, 10, 'sort');

setListFromCollectionAggregation​

Is a function that performs an aggregation operation on a specified collection using the provided aggregation pipeline.

Parameters​

Returns​

Examples​

let results = await SF.utils.setListFromCollectionAggregation("users", [
  { $match: { age: { $gte: 18 } } },
  { $group: { _id: "$country", count: { $sum: 1 } } }
]);
// returns: [ { _id: "USA", count: 42 }, { _id: "FR", count: 18 } ]

setListFromReport​

Is a function that performs a dynamic aggregation query on a report collection, using filters, sorting, and limit options.

Parameters​

Returns​

Examples​

let result = await SF.utils.setListFromReport("monthly_sales", {
  SF_createdBy: "admin@example.com",
  region: "NA"
}, 10, { by: "createdAt", direction: -1 });
// returns: [ { ... }, { ... } ]

setListFromReportAggregation​

Is a function that performs a custom aggregation on a report instance using a provided aggregation pipeline.

Parameters​

Returns​

Examples​

let data = await SF.utils.setListFromReportAggregation("monthly_reports", [
  { $match: { status: "completed" } },
  { $group: { _id: "$region", total: { $sum: "$amount" } } }
]);
// returns: [ { _id: "Europe", total: 24000 }, { _id: "Asia", total: 18000 } ]

setListFromSQL​

Is a function that allow to set list of data from client database.

Parameters​

Returns​

Examples​

await this.SF.setListFromSQL('clientDatabaseID', "code='MMA'");

setListFromCustomList​

Is a function that allow to set list of data from CustomList.

Parameters​

Returns​

Examples​

await this.SF.setListFromCustomList('CustomListID');

aggregateQuery​

Is a function that allow to set list of data from CustomList.

Parameters​

Returns​

Examples​

await this.SF.aggregateQuery('collection', '610c0343f6ebc7ddcb49cc3b', {value : "it"});

deleteFile​

Is a function that allow to delete a file using it ID.

Parameters​

Returns​

Examples​

await this.SF.deleteFile('610c0343f6ebc7ddcb49cc3b');

2 - Projects​

The Projects class has the methods that will allow you to manage the projects.

Usage​

const projects = new Projects({ mode: 'test' });

aggregate​

Aggregation operations process data records and return computed results

Parameters​

Returns​

Examples​

let aggregation = [
  {
    "$match": { "status": "active" }
  },
  {
    "$group": {
      "_id": "$category",
      "total": { "$sum": 1 }
    }
  }
]
let results = await projects.aggregate(aggregation);

3 - Users​

The Users class has the methods that will allow you to manage the users.

Usage​

const users = new Users();

create​

Allow to create new user.

Parameters​

Returns​

Data​

This is the allowed user data:

Examples​

let user = {
  email: "email@softydev.com",
  lastName : "last name",
  firstName: "first name",
  group: [],
  metadata: {},
  ideAccess: true,
  blocked: false
}
await users.create(user);

update​

Allow to update a user

Parameters​

Returns​

Data​

The same allowed data in creation of user. The fields are optional.

Examples​

let newData = {
  ideAccess: false
}
await users.update("userId", newData);

delete​

Allow to delete a user.

Parameters​

Returns​

Examples​

await users.delete("userId");

findById​

Allow to get a user by id.

Parameters​

Returns​

Examples​

let user = await users.findById("userId");

find​

Allow to list the users.

Parameters​

Returns​

Examples​

let criteria = { 
  firstName: new RegExp("p", "i")
}
let usersList = await users.find(criteria);

count​

Allow to get the count of users.

Parameters​

Returns​

Examples​

let criteria = { 
  blocked: false
}
let count = await users.count(criteria);

findAndCount​

get a list and the count of users

Parameters​

Returns​

Options​

This options are optional

Examples​

let body = {
  criteria: { 
    firstName: new RegExp("p", "i")
  },
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let res = await users.findAndCount(body);
let usersList = res.data;
let count = res.count;

aggregate​

Aggregation operations process data records and return computed results

Parameters​

Returns​

Examples​

let aggregation = [
  {
    "$match": { "firstName": new RegExp("z", "i") }
  },
  {
    "$project" : {
                    "_id": 1,
                    "firstName": 1,
                    "lastName": 1,
                    "email": 1
                  }
  }
]
let usersList = await users.aggregate([aggregation]);

addRole​

Add role to user using user ID & group ID.

Parameters​

Returns​

Examples​

await users.addRole("userId","groupId","SF_mode");

removeRole​

Remove role from user using user ID & group ID.

Parameters​

Returns​

Examples​

await users.removeRole("userId","groupId","SF_mode");

4 - Groups​

The Groups class has the methods that will allow you to manage user groups.

Usage​

const groups = new Groups();

findById​

Find a group by its unique identifier.

Parameters​

Returns​

Examples​

let group = await groups.findById("groupId123");

find​

Find groups based on a filter criteria.

Parameters​

Returns​

Examples​

let list = await groups.find({ name: /admin/i });

count​

Count the number of groups that match the criteria.

Parameters​

Returns​

Examples​

let total = await groups.count({ type: "system" });

findAndCount​

Find groups and return both the results and the total count.

Parameters​

Returns​

Examples​

let result = await groups.findAndCount({ limit: 10, offset: 0 });

aggregate​

Aggregation operations process data records and return computed results.

Parameters​

Returns​

Examples​

let aggregation = [
  { $match: { type: "system" } },
  { $group: { _id: "$status", total: { $sum: 1 } } }
];
let stats = await groups.aggregate(aggregation);

create​

Create a new group with provided data.

Parameters​

Returns​

Examples​

let newGroup = await groups.create({ name: "Developers", type: "custom" });

update​

Update an existing group by ID.

Parameters​

Returns​

Examples​

let updated = await groups.update("groupId123", { name: "Admins Updated" });

delete​

Delete a group by ID.

Parameters​

Returns​

Examples​

await groups.delete("groupId123");

groupUsers​

Retrieve the users belonging to a specific group.

Parameters​

Returns​

Examples​

let users = await groups.groupUsers("groupId123");

5 - Collection​

The collection class has the methods that will allow you to manage your collection

Usage​

You can instantiate a Collection class with id or name of collection. You can add mode option

const collection = new Collection({ id: 'collectionId', mode: 'test' });

insert​

Allow to insert a json into a collection

Parameters​

Returns​

Examples​

await collection.insert({ name: "name1", type : "type1" });

insertMany​

Allow to insert an array of json in to a collection.

Parameters​

Returns​

Examples​

await collection.insertMany([{label : "IT", value : "it"}]);

updateMany​

update all the documents that satisfies the specified query criteria .

Parameters​

Returns​

Examples​

let criteria = { 
  firstName: new RegExp("p", "i")
}
await collection.updateMany(criteria, [{ type : "type2" }], { upsert: true });

update​

Allow to update a document in collection

Parameters​

Returns​

Examples​

await collection.update("documentId", { type : "type2" });

delete​

Allow to delete a document from collection

Parameters​

Returns​

Examples​

await collection.delete("documentId");

findById​

Allow to get a object by id from the collection

Parameters​

Returns​

Examples​

let document = await collection.findById(id);

find​

Allow to select the documents in a collection

Parameters​

Returns​

Options​

This options are optional

Examples​

let body = {
  criteria: { 
    name: new RegExp("p", "i"), 
    type: "type1" 
  },
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let documents = await collection.find(body);

count​

Allow to get the count of documents that would match a query for the collection

Parameters​

Returns​

Examples​

let count = await collection.count({ type: "type1" });

aggregate​

Aggregation operations process data records and return computed results

Parameters​

Returns​

Examples​

let aggregation = [
  {
    "$match": { "type": "type1" }
  },
  {
    "$project" : {
                    "_id": 1,
                    "name": 1
                  }
  }
]
let documents = await collection.aggregate([aggregation]);

6 - SQLDatabase​

Manage your external SQL Databases Through the SQLDatabase class.

Usage​

You can instantiate an SQL class with id and mode(optional).

const sql = new SQLDatabase({ id: '610c0343f6ebc7ddcb49cc3b', mode: 'test' });

findOne​

Get a table row data

Parameters​

Returns​

Examples​

let res = await sql.findOne("client", "code='MMA'"))

find​

list multiple rows from sql table

Parameters​

Returns​

Examples​

let res = sql.find("client", "code='MMA'")

count​

Get the row count for a table with a criteria

Parameters​

Returns​

Examples​

let count = await sql.count("client", "code='MMA'");

execute​

Execute a custom query on the database.

Parameters​

Returns​

Examples​

sql.execute("INSERT INTO client(code, intitule, representant, codepostal) VALUES('MDSX', 'holder', 'holder', 14000)")

insert​

Insert one row into a table.

Parameters​

Returns​

Examples​

sql.insert("client", {
    code: 'HelloWord',
    codepostal: 14000
}

insertMany​

Insert multiple rows into

Parameters​

Returns​

Examples​

sql.insertMany("client", [
  { code: '#1' },
  { code: '#2' }
])

update​

Update rows.

Parameters​

Returns​

Examples​

 sql.update('client',   "code='MMA'",
    {
        code: "MQS"
    })

delete​

Delete row/rows in your table.

Parameters​

Returns​

Examples​

sql.delete("client", "id=223")

7 - CustomList​

The CustomList class has the methods that will allow you to manage your Custom List

Usage​

You can instantiate a CustomList class with id of custom list. You can add other options (mode, versionId)

const customList = new CustomList({id: 'id', mode: 'test', versionId: "vId"});

get​

Get a custom list data

Returns​

Examples​

let customListData = await customList.get();

8 - Report​

The Report class will allow you to manipulate specific report

Usage​

You can instantiate a Report class with id of report. You can add mode option

const report = new Report({id: 'id', mode: 'test'});

aggregate​

Aggregation operations process data records and return computed results

Parameters​

Returns​

Examples​

let aggregation = [
  {
    "$match": { "SF_status": "Running" }
  },
  { 
    "$sort": { "SF_createdAt": -1 } 
  }
]
let instances = await report.aggregate(aggregation);  //report of instances

9 - Instance​

The Instance class has the methods that will allow you to manage the instances

Usage​

const inctance = new Instance();

findById​

Get a instance by id

Parameters​

Returns​

Examples​

let oneInctance = await inctance.findById(id);

find​

list the instances

Parameters​

Returns​

Examples​

let instances = await inctance.find({ status: "Running" });

count​

Allow to get the count of instances that would match a query

Parameters​

Returns​

Examples​

let count = await inctance.count({ status: "Running" });

findAndCount​

get a list and the count of instances

Parameters​

Returns​

Options​

This options are optional

Examples​

let body = {
  criteria: { 
    status: "Running" 
  },
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let res = await inctance.findAndCount(body);
let instances = res.data;
let count = res.count;

aggregate​

Aggregation operations process data records and return computed results

Parameters​

Returns​

Examples​

let aggregation = [
  {
    "$match": { "status": "End" }
  },
  {
    "$project" : {
                    "_id": 1,
                    "name": 1
                  }
  }
]
let inctances = await inctance.aggregate([aggregation]);

update​

Update an instance

Parameters​

Returns​

Examples​

await inctance.update(id, { status : "End" });

delete​

Delete an instance

Parameters​

Returns​

Examples​

await inctance.delete(id);

history​

Get instance history.

Parameters​

Returns​

Examples​

await inctance.history(id, { status : "End" });

10 - Task​

The Task class has the methods that will allow you to manage the tasks

Usage​

const task = new Task();

findById​

Get a task by id

Parameters​

Returns​

Examples​

let oneTask = await task.findById(id);

find​

list the tasks

Parameters​

Returns​

Examples​

let tasks = await task.find({ instanceId: "instanceId" });

count​

Allow to get the count of tasks that would match a query

Parameters​

Returns​

Examples​

let count = await task.count({ instanceId: "instanceId" });

findAndCount​

get a list and the count of tasks

Parameters​

Returns​

Options​

This options are optional

Examples​

let body = {
  criteria: { 
    status: "Running" 
  },
  assignedToConnected: true,
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let res = await task.findAndCount(body);
let tasks = res.data;
let count = res.count;

aggregate​

Aggregation operations process data records and return computed results

Parameters​

Returns​

Examples​

let aggregation = [
  {
    "$match": { "status": "End" }
  },
  {
    "$project" : {
                    "_id": 1,
                    "name": 1
                  }
  }
]
let tasks = await task.aggregate([aggregation]);

update​

Update an task

Parameters​

Returns​

Examples​

await task.update(id, { status : "End" });

delete​

Delete an task

Parameters​

Returns​

Examples​

await task.delete(id);

getNextValue​

Get next value of an task.

Parameters​

Returns​

Examples​

await task.getNextValue("name",5,"SF_mode");

history​

Get the history of a task by its ID.

Parameters​

Returns​

Examples​

let log = await task.history("taskId123", {});

11 - Api​

The Api class has the methods that will allow you to manage your Apis.

Usage​

const api = new Api();

invoke​

Invoke an api.

Parameters​

Returns​

Examples​

let body = {
  const myElement = document.getElementById("demo");

  function getLocation() {
    if (navigator.geolocation) {
      navigator.geolocation.getCurrentPosition(showPosition);
    } else {
      myElement.innerHTML = "Geolocation is not supported by this browser.";
    }
  }

  function showPosition(position) {
    myElement.innerHTML = "Latitude: " + position.coords.latitude +
    "<br>Longitude: " + position.coords.longitude;
  }
}
await api.invoke(body);

12 - Email​

The Email class has the methods that will allow you to manage your emails.

Usage​

const email = new Email();

send​

Send an email.

Parameters​

Returns​

Examples​

await email.send("assignee","subject",{"var1", "var2"},{"mailTemplate"},{"mailProvider"},"mail of user in cc", "senderMail","replyTo");

13 - DataSource​

The DataSource class provides generic data manipulation methods for various sources such as collections, tables, or reports.

Usage​

const ds = new DataSource();

findOne​

Retrieve a single document from a data source.

Parameters​

Returns​

Examples​

let doc = await ds.findOne("users", { filter: { email: "user@example.com" } });

list​

List multiple documents from a data source.

Parameters​

Returns​

Examples​

let docs = await ds.list("users", { filter: { active: true } });

count​

Count the number of documents in a data source.

Parameters​

Returns​

Examples​

let total = await ds.count("orders", { filter: { status: "delivered" } });

update​

Update documents in a data source.

Parameters​

Returns​

Examples​

await ds.update("products", { filter: { stock: 0 } }, { restock: true });

insert​

Insert a single document into a data source.

Parameters​

Returns​

Examples​

await ds.insert("logs", { action: "login", userId: "abc123" });

insertMany​

Insert multiple documents into a data source.

Parameters​

Returns​

Examples​

await ds.insertMany("logs", [{ action: "view" }, { action: "edit" }]);

delete​

Delete documents from a data source.

Parameters​

Returns​

Examples​

await ds.delete("sessions", { filter: { expired: true } });

execute​

Execute a custom action or command on a data source.

Parameters​

Returns​

Examples​

await ds.execute("jobs", { action: "resetAll" });