Référence du SDK Web Modeler

Description du SDK du web modeler#Lien direct vers 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#Lien direct vers 1 - Softyflow

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

Utilisation#Lien direct vers 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#Lien direct vers getSF_mode

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

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

let currentMode = this.SF.getSF_mode();

getSF_Version#Lien direct vers getSF_Version

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

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

let currentVersion = this.SF.getSF_Version();

queryParams#Lien direct vers queryParams

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

startProcess#Lien direct vers startProcess

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

validateCaptcha#Lien direct vers validateCaptcha

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

saveNew#Lien direct vers saveNew

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

saveTask#Lien direct vers saveTask

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

validateTask#Lien direct vers validateTask

Permet de valider une tâche

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

getUserPendingTask#Lien direct vers getUserPendingTask

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

uploadImage#Lien direct vers uploadImage

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

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

setListFromCollection#Lien direct vers setListFromCollection

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

setListFromCollectionAggregation#Lien direct vers 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#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers 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#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

setListFromReportAggregation#Lien direct vers 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#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers setListFromSQL

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

setListFromCustomList#Lien direct vers setListFromCustomList

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

aggregateQuery#Lien direct vers aggregateQuery

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

deleteFile#Lien direct vers deleteFile

Permet de supprimer un fichier en utilisant son identifiant.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

2 - Projects#Lien direct vers 2 - Projects

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

Utilisation#Lien direct vers Utilisation

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

aggregate#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

3 - Users#Lien direct vers 3 - Users

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

Utilisation#Lien direct vers Utilisation

const users = new Users();

create#Lien direct vers create

Permet de créer un nouvel utilisateur.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Data#Lien direct vers Data

Voici les données utilisateur autorisées :

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Permet de mettre à jour un utilisateur

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Data#Lien direct vers Data

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

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

Permet de supprimer un utilisateur.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

await users.delete("userId");

findById#Lien direct vers findById

Permet d'obtenir un utilisateur par identifiant.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

find#Lien direct vers find

Permet de lister les utilisateurs.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

count#Lien direct vers count

Permet d'obtenir le nombre d'utilisateurs.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

findAndCount#Lien direct vers findAndCount

Obtenir une liste et le nombre d'utilisateurs

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Options#Lien direct vers Options

Ces options sont optionnelles

Exemples#Lien direct vers 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#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers addRole

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

removeRole#Lien direct vers removeRole

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

4 - Groups#Lien direct vers 4 - Groups

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

Utilisation#Lien direct vers Utilisation

const groups = new Groups();

findById#Lien direct vers findById

Trouve un groupe par son identifiant unique.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

find#Lien direct vers find

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

count#Lien direct vers count

Compte le nombre de groupes correspondant aux critères.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

findAndCount#Lien direct vers findAndCount

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

aggregate#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

create#Lien direct vers create

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Met à jour un groupe existant par identifiant.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

Supprime un groupe par identifiant.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

await groups.delete("groupId123");

groupUsers#Lien direct vers groupUsers

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

5 - Collection#Lien direct vers 5 - Collection

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

Utilisation#Lien direct vers 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#Lien direct vers insert

Permet d'insérer un json dans une collection

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

insertMany#Lien direct vers insertMany

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

updateMany#Lien direct vers updateMany

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Permet de mettre à jour un document dans la collection

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

Permet de supprimer un document de la collection

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

await collection.delete("documentId");

findById#Lien direct vers findById

Permet d'obtenir un objet par identifiant depuis la collection

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

let document = await collection.findById(id);

find#Lien direct vers find

Permet de sélectionner les documents dans une collection

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Options#Lien direct vers Options

Ces options sont optionnelles

Exemples#Lien direct vers 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#Lien direct vers count

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

aggregate#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

6 - SQLDatabase#Lien direct vers 6 - SQLDatabase

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

Utilisation#Lien direct vers Utilisation

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

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

findOne#Lien direct vers findOne

Obtient les données d'une ligne de tableau

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

find#Lien direct vers find

Liste plusieurs lignes d'un tableau SQL

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

count#Lien direct vers count

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

execute#Lien direct vers execute

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

insert#Lien direct vers insert

Insère une ligne dans un tableau.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

insertMany#Lien direct vers insertMany

Insère plusieurs lignes dans un tableau

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Met à jour les lignes.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

7 - SoftyTables#Lien direct vers 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#Lien direct vers Utilisation

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

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

findById#Lien direct vers findById

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

find#Lien direct vers find

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Options#Lien direct vers Options

Ces options sont optionnelles

Exemples#Lien direct vers 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#Lien direct vers count

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers findAndCount

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers insert

Crée une seule ligne dans une SoftyTable.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers insertMany

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers update

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

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

updateMany#Lien direct vers updateMany

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers delete

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

await softyTable.delete('12345');

deleteMany#Lien direct vers deleteMany

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers clear

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

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

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

getOptions#Lien direct vers getOptions

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

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

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

execute#Lien direct vers execute

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

Paramètres#Lien direct vers Paramètres

Objet Options#Lien direct vers Objet Options

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers 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#Lien direct vers migrate

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

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

let result = await softyTable.migrate();

8 - CustomList#Lien direct vers 8 - CustomList

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

Utilisation#Lien direct vers 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#Lien direct vers get

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

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

let customListData = await customList.get();

9 - Report#Lien direct vers 9 - Report

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

Utilisation#Lien direct vers 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#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

10 - Instance#Lien direct vers 10 - Instance

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

Utilisation#Lien direct vers Utilisation

const inctance = new Instance();

findById#Lien direct vers findById

Obtient une instance par identifiant

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

let oneInctance = await inctance.findById(id);

find#Lien direct vers find

Liste les instances

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

count#Lien direct vers count

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

findAndCount#Lien direct vers findAndCount

Obtient une liste et le nombre d'instances

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Options#Lien direct vers Options

Ces options sont optionnelles

Exemples#Lien direct vers 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#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Met à jour une instance

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

Supprime une instance

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

await inctance.delete(id);

history#Lien direct vers history

Obtient l'historique de l'instance.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

11 - Task#Lien direct vers 11 - Task

La classe Task contient les méthodes qui vous permettront de gérer les tâches

Utilisation#Lien direct vers Utilisation

const task = new Task();

findById#Lien direct vers findById

Obtient une tâche par identifiant

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

let oneTask = await task.findById(id);

find#Lien direct vers find

Liste les tâches

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

count#Lien direct vers count

Permet d'obtenir le nombre de tâches qui correspondraient à une requête

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

findAndCount#Lien direct vers findAndCount

Obtient une liste et le nombre de tâches

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Options#Lien direct vers Options

Ces options sont optionnelles

Exemples#Lien direct vers Exemples

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#Lien direct vers aggregate

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

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Met à jour une tâche

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

Supprime une tâche

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

await task.delete(id);

getNextValue#Lien direct vers getNextValue

Obtient la valeur suivante d'une tâche.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

history#Lien direct vers history

Obtient l'historique d'une tâche par son identifiant.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

12 - Api#Lien direct vers 12 - Api

La classe Api contient les méthodes qui vous permettront de gérer vos Apis.

Utilisation#Lien direct vers Utilisation

const api = new Api();

invoke#Lien direct vers invoke

Invoque une API.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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);

13 - Email#Lien direct vers 13 - Email

La classe Email contient les méthodes qui vous permettront de gérer vos emails.

Utilisation#Lien direct vers Utilisation

const email = new Email();

send#Lien direct vers send

Envoie un email.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

14 - DataSource#Lien direct vers 14 - DataSource

La classe DataSource fournit des méthodes génériques de manipulation de données pour diverses sources telles que les collections, les tableaux ou les rapports.

Utilisation#Lien direct vers Utilisation

const ds = new DataSource();

findOne#Lien direct vers findOne

Récupère un seul document d'une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

list#Lien direct vers list

Liste plusieurs documents d'une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

count#Lien direct vers count

Compte le nombre de documents dans une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

update#Lien direct vers update

Met à jour des documents dans une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

insert#Lien direct vers insert

Insère un seul document dans une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

insertMany#Lien direct vers insertMany

Insère plusieurs documents dans une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

delete#Lien direct vers delete

Supprime des documents d'une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

execute#Lien direct vers execute

Exécute une action ou commande personnalisée sur une source de données.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Exemples#Lien direct vers Exemples

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

15 - File#Lien direct vers 15 - File

La classe File fournit des méthodes pour générer des fichiers PDF à partir de modèles HTML stockés et de contextes de variables en utilisant des endpoints API.

generatePDF#Lien direct vers generatePDF

Génère un fichier PDF en récupérant le contenu HTML d'un fichier et en le publiant avec des données contextuelles.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Example#Lien direct vers Example

const file = new File();
file.generatePDF("output.pdf", "605c72...", { variables: { user: "Alice" } });

genratePDFWithVar#Lien direct vers genratePDFWithVar

Génère du contenu PDF en utilisant des variables directement en publiant vers un endpoint de génération de contenu spécifique.

Paramètres#Lien direct vers Paramètres

Retourne#Lien direct vers Retourne

Example#Lien direct vers Example

const file = new File();
file.genratePDFWithVar("Invoice", "605c72...", { variables: { amount: 100, user: "Alice" } });