Web modeler SDK

Description du SDK du web modeler​

Le SDK du web modeler est disponible dans le web modeler. Il permet aux utilisateurs d'accéder aux ressources depuis l'interface utilisateur et d'exécuter des calculs complexes lors de l'exécution de l'interface utilisateur.

Le SDK possède les classes suivantes

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

Dans les sections suivantes, nous allons détailler chaque classe et les méthodes autorisées.

1 - Softyflow​

La classe Softyflow contient les méthodes système de Softyflow

Utilisation​

Cette classe est instanciée par défaut comme un objet nommé SF lorsque l'interface utilisateur est chargée, vous pouvez donc utiliser les méthodes directement en les appelant via l'objet "SF"

//utilisation de l'objet SF
let currentMode = this.SF.getSF_mode();

getSF_mode​

Est une fonction qui retourne le mode de l'interface utilisateur en cours d'exécution

Retourne​

Exemples​

let currentMode = this.SF.getSF_mode();

getSF_Version​

Est une fonction qui retourne la version de l'interface utilisateur en cours d'exécution

Retourne​

Exemples​

let currentVersion = this.SF.getSF_Version();

queryParams​

Est une fonction qui retourne les paramètres de requête

Paramètres​

Retourne​

Exemples​

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

startProcess​

Est une fonction qui démarre un processus spécifique

Paramètres​

Retourne​

Exemples​

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

validateCaptcha​

Est une fonction qui valide une action Google reCAPTCHA v3 et retourne le jeton généré.

Paramètres​

Retourne​

Exemples​

let token = await SF.utils.validateCaptcha("login_form");
// retourne: '03AFcWeA... (une longue chaîne de jeton de Google)'

saveNew​

Est une fonction qui vous permet de sauvegarder l'état de l'interface utilisateur

Paramètres​

Retourne​

Exemples​

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

saveTask​

Est une fonction qui vous permet de sauvegarder l'état de l'interface de tâche

Paramètres​

Retourne​

Exemples​

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

validateTask​

Permet de valider une tâche

Paramètres​

Retourne​

Exemples​

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

getUserPendingTask​

Permet d'obtenir les tâches en attente assignées à l'utilisateur connecté.

Paramètres​

Retourne​

Exemples​

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

uploadImage​

Est une fonction qui télécharge une image sur le serveur en utilisant une requête POST multipart/form-data.

Paramètres​

Retourne​

Exemples​

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

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

setListFromCollection​

Permet de définir une liste de données à partir d'une collection spécifique.

Paramètres​

Retourne​

Exemples​

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

setListFromCollectionAggregation​

Est une fonction qui effectue une opération d'agrégation sur une collection spécifiée en utilisant le pipeline d'agrégation fourni.

Paramètres​

Retourne​

Exemples​

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

setListFromReport​

Est une fonction qui effectue une requête d'agrégation dynamique sur une collection de rapport, en utilisant des filtres, un tri et des options de limite.

Paramètres​

Retourne​

Exemples​

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

setListFromReportAggregation​

Est une fonction qui effectue une agrégation personnalisée sur une instance de rapport en utilisant un pipeline d'agrégation fourni.

Paramètres​

Retourne​

Exemples​

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

setListFromSQL​

Permet de définir une liste de données à partir de la base de données cliente.

Paramètres​

Retourne​

Exemples​

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

setListFromCustomList​

Permet de définir une liste de données à partir de CustomList.

Paramètres​

Retourne​

Exemples​

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

aggregateQuery​

Permet de définir une liste de données à partir de CustomList.

Paramètres​

Retourne​

Exemples​

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

deleteFile​

Permet de supprimer un fichier en utilisant son identifiant.

Paramètres​

Retourne​

Exemples​

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

2 - Projects​

La classe Projects contient les méthodes qui vous permettront de gérer les projets.

Utilisation​

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

aggregate​

Les opérations d'agrégation traitent les enregistrements de données et retournent des résultats calculés

Paramètres​

Retourne​

Exemples​

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

3 - Users​

La classe Users contient les méthodes qui vous permettront de gérer les utilisateurs.

Utilisation​

const users = new Users();

create​

Permet de créer un nouvel utilisateur.

Paramètres​

Retourne​

Data​

Voici les données utilisateur autorisées :

Exemples​

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

update​

Permet de mettre à jour un utilisateur

Paramètres​

Retourne​

Data​

Les mêmes données autorisées lors de la création d'un utilisateur. Les champs sont optionnels.

Exemples​

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

delete​

Permet de supprimer un utilisateur.

Paramètres​

Retourne​

Exemples​

await users.delete("userId");

findById​

Permet d'obtenir un utilisateur par identifiant.

Paramètres​

Retourne​

Exemples​

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

find​

Permet de lister les utilisateurs.

Paramètres​

Retourne​

Exemples​

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

count​

Permet d'obtenir le nombre d'utilisateurs.

Paramètres​

Retourne​

Exemples​

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

findAndCount​

Obtenir une liste et le nombre d'utilisateurs

Paramètres​

Retourne​

Options​

Ces options sont optionnelles

Exemples​

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​

Les opérations d'agrégation traitent les enregistrements de données et retournent des résultats calculés

Paramètres​

Retourne​

Exemples​

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

addRole​

Ajoute un rôle à l'utilisateur en utilisant l'identifiant utilisateur et l'identifiant du groupe.

Paramètres​

Retourne​

Exemples​

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

removeRole​

Retire un rôle de l'utilisateur en utilisant l'identifiant utilisateur et l'identifiant du groupe.

Paramètres​

Retourne​

Exemples​

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

4 - Groups​

La classe Groups contient les méthodes qui vous permettront de gérer les groupes d'utilisateurs.

Utilisation​

const groups = new Groups();

findById​

Trouve un groupe par son identifiant unique.

Paramètres​

Retourne​

Exemples​

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

find​

Trouve les groupes en fonction d'un critère de filtre.

Paramètres​

Retourne​

Exemples​

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

count​

Compte le nombre de groupes correspondant aux critères.

Paramètres​

Retourne​

Exemples​

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

findAndCount​

Trouve les groupes et retourne à la fois les résultats et le nombre total.

Paramètres​

Retourne​

Exemples​

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

aggregate​

Les opérations d'agrégation traitent les enregistrements de données et retournent des résultats calculés.

Paramètres​

Retourne​

Exemples​

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

create​

Crée un nouveau groupe avec les données fournies.

Paramètres​

Retourne​

Exemples​

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

update​

Met à jour un groupe existant par identifiant.

Paramètres​

Retourne​

Exemples​

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

delete​

Supprime un groupe par identifiant.

Paramètres​

Retourne​

Exemples​

await groups.delete("groupId123");

groupUsers​

Récupère les utilisateurs appartenant à un groupe spécifique.

Paramètres​

Retourne​

Exemples​

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

5 - Collection​

La classe Collection contient les méthodes qui vous permettront de gérer votre collection

Utilisation​

Vous pouvez instancier une classe Collection avec l'identifiant ou le nom de la collection. Vous pouvez ajouter l'option mode

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

insert​

Permet d'insérer un json dans une collection

Paramètres​

Retourne​

Exemples​

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

insertMany​

Permet d'insérer un tableau de json dans une collection.

Paramètres​

Retourne​

Exemples​

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

updateMany​

Met à jour tous les documents qui satisfont les critères de requête spécifiés.

Paramètres​

Retourne​

Exemples​

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

update​

Permet de mettre à jour un document dans la collection

Paramètres​

Retourne​

Exemples​

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

delete​

Permet de supprimer un document de la collection

Paramètres​

Retourne​

Exemples​

await collection.delete("documentId");

findById​

Permet d'obtenir un objet par identifiant depuis la collection

Paramètres​

Retourne​

Exemples​

let document = await collection.findById(id);

find​

Permet de sélectionner les documents dans une collection

Paramètres​

Retourne​

Options​

Ces options sont optionnelles

Exemples​

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​

Permet d'obtenir le nombre de documents qui correspondraient à une requête pour la collection

Paramètres​

Retourne​

Exemples​

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

aggregate​

Les opérations d'agrégation traitent les enregistrements de données et retournent des résultats calculés

Paramètres​

Retourne​

Exemples​

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

6 - SQLDatabase​

Gérez vos bases de données SQL externes via la classe SQLDatabase.

Utilisation​

Vous pouvez instancier une classe SQL avec l'identifiant et le mode (optionnel).

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

findOne​

Obtient les données d'une ligne de tableau

Paramètres​

Retourne​

Exemples​

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

find​

Liste plusieurs lignes d'un tableau SQL

Paramètres​

Retourne​

Exemples​

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

count​

Obtient le nombre de lignes pour un tableau avec un critère

Paramètres​

Retourne​

Exemples​

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

execute​

Exécute une requête personnalisée sur la base de données.

Paramètres​

Retourne​

Exemples​

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

insert​

Insère une ligne dans un tableau.

Paramètres​

Retourne​

Exemples​

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

insertMany​

Insère plusieurs lignes dans un tableau

Paramètres​

Retourne​

Exemples​

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

update​

Met à jour les lignes.

Paramètres​

Retourne​

Exemples​

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

delete​

Supprime une/des ligne(s) dans votre tableau.

Paramètres​

Retourne​

Exemples​

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

7 - SoftyTables​

La classe SoftyTables fournit des méthodes pour interagir avec les ressources SoftyTable, vous permettant d'effectuer des opérations CRUD, d'exécuter des requêtes et de gérer les données de tableau depuis l'interface web.

Utilisation​

Vous pouvez instancier une classe SoftyTables avec les options id et mode.

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

findById​

Récupère une seule ligne d'une SoftyTable par son identifiant.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});
let row = await softyTable.findById('12345');

find​

Liste les lignes d'une SoftyTable avec filtrage, tri et pagination optionnels.

Paramètres​

Retourne​

Options​

Ces options sont optionnelles

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

// Liste toutes les lignes
let rows = await softyTable.find({});

// Liste avec filtres et pagination
let body = {
  criteria: {
    where: { status: 'active' }
  },
  limit: 50,
  page: 0,
  sortby: 'createdAt',
  direction: -1
}
let activeRows = await softyTable.find(body);

count​

Compte le nombre de lignes dans une SoftyTable avec filtrage optionnel.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

// Compte toutes les lignes
let result = await softyTable.count({});
// retourne: { count: 150 }

// Compte avec filtre
let result = await softyTable.count({
  criteria: { where: { status: 'active' } }
});
// retourne: { count: 75 }

findAndCount​

Obtient à la fois une liste de lignes et le nombre total correspondant aux critères.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

let body = {
  criteria: {
    where: { status: 'active' }
  },
  limit: 10,
  page: 0,
  sortby: 'createdAt',
  direction: -1
}
let result = await softyTable.findAndCount(body);
let rows = result.data;
let count = result.count;

insert​

Crée une seule ligne dans une SoftyTable.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

let newRow = await softyTable.insert({
  name: 'John Doe',
  email: 'john@example.com',
  age: 30,
  status: 'active'
});

insertMany​

Crée plusieurs lignes dans une SoftyTable en une seule fois.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

let newRows = await softyTable.insertMany([
  { name: 'John Doe', email: 'john@example.com', age: 30 },
  { name: 'Jane Smith', email: 'jane@example.com', age: 25 },
  { name: 'Bob Johnson', email: 'bob@example.com', age: 35 }
]);

update​

Met à jour une seule ligne dans une SoftyTable par son identifiant.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

let updated = await softyTable.update('12345', {
  status: 'inactive',
  updatedAt: new Date()
});

updateMany​

Met à jour plusieurs lignes dans une SoftyTable qui correspondent à des critères spécifiques.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

// Met à jour toutes les lignes où le statut est 'pending'
let result = await softyTable.updateMany(
  { status: 'pending' },
  { status: 'active', processedAt: new Date() }
);

delete​

Supprime une seule ligne d'une SoftyTable par son identifiant.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

await softyTable.delete('12345');

deleteMany​

Supprime plusieurs lignes d'une SoftyTable qui correspondent à des critères spécifiques.

Paramètres​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

// Supprime toutes les lignes inactives
await softyTable.deleteMany({ status: 'inactive' });

// Supprime les lignes plus anciennes qu'une certaine date
await softyTable.deleteMany({
  createdAt: { $lt: new Date('2024-01-01') }
});

clear​

Efface toutes les lignes d'une SoftyTable (supprime toutes les données).

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

// Supprime toutes les lignes du tableau
await softyTable.clear();

getOptions​

Récupère les options pour les champs de sélection dans une SoftyTable.

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

let options = await softyTable.getOptions();
// retourne: [{ label: 'Active', value: 'active' }, { label: 'Inactive', value: 'inactive' }]

execute​

Exécute une requête SQL personnalisée sur la SoftyTable.

Paramètres​

Objet Options​

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

// Exécute une requête SELECT
let results = await softyTable.execute(
  'SELECT * FROM my_table WHERE status = :status',
  {
    replacements: { status: 'active' },
    type: 'SELECT'
  }
);

// Exécute une requête personnalisée
let results = await softyTable.execute(
  'UPDATE my_table SET status = "processed" WHERE created_at < NOW() - INTERVAL 30 DAY',
  { type: 'UPDATE' }
);

migrate​

Migre les lignes dans une SoftyTable (pour les opérations de migration de données).

Retourne​

Exemples​

const softyTable = new SoftyTables({id: 'tableId', mode: 'test'});

let result = await softyTable.migrate();

8 - CustomList​

La classe CustomList contient les méthodes qui vous permettront de gérer votre liste personnalisée

Utilisation​

Vous pouvez instancier une classe CustomList avec l'identifiant de la liste personnalisée. Vous pouvez ajouter d'autres options (mode, versionId)

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

get​

Obtient les données d'une liste personnalisée

Retourne​

Exemples​

let customListData = await customList.get();

9 - Report​

La classe Report vous permettra de manipuler un rapport spécifique

Utilisation​

Vous pouvez instancier une classe Report avec l'identifiant du rapport. Vous pouvez ajouter l'option mode

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

aggregate​

Les opérations d'agrégation traitent les enregistrements de données et retournent des résultats calculés

Paramètres​

Retourne​

Exemples​

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

10 - Instance​

La classe Instance contient les méthodes qui vous permettront de gérer les instances

Utilisation​

const inctance = new Instance();

findById​

Obtient une instance par identifiant

Paramètres​

Retourne​

Exemples​

let oneInctance = await inctance.findById(id);

find​

Liste les instances

Paramètres​

Retourne​

Exemples​

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

count​

Permet d'obtenir le nombre d'instances qui correspondraient à une requête

Paramètres​

Retourne​

Exemples​

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

findAndCount​

Obtient une liste et le nombre d'instances

Paramètres​

Retourne​

Options​

Ces options sont optionnelles

Exemples​

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​

Les opérations d'agrégation traitent les enregistrements de données et retournent des résultats calculés

Paramètres​

Retourne​

Exemples​

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

update​

Met à jour une instance

Paramètres​

Retourne​

Exemples​

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

delete​

Supprime une instance

Paramètres​

Retourne​

Exemples​

await inctance.delete(id);

history​

Obtient l'historique de l'instance.

Paramètres​