Fonctions

Cette section présente les différentes fonctions disponibles dans le language de script SASL.

conversion

Date(obj) - $fonctions.Date(obj)

Construit une date à partir de l’objet spécifié

String(obj) - $fonctions.String(obj)

Construit une chaîne de caractère à partir de l’objet spécifié.

Float(obj) - $fonctions.Float(obj)

Construit un nombre à virgule flottante à partir de l’objet spécifié.

Int(obj) - $fonctions.Int(obj)

Construit un nombre entier à partir de l’objet spécifié.

DateTime - $fonctions.DateTime :

database

EntryCV(column, value) - $fonctions.EntryCV(column, value) :

EntryC(column) - $fonctions.EntryC(column) :

getEntryV(column) - $fonctions.getEntryV(column) :

createOrUpdateEntry(entry) - $fonctions.createOrUpdateEntry(entry) :

readEntry(entry) - $fonctions.readEntry(entry) :

readEntries(filter, columns) - $fonctions.readEntries(filter, columns) :

countEntries(entries) - $fonctions.countEntries(entries) :

deleteEntry(entry) - $fonctions.deleteEntry(entry) :

copyEntry(from, to, overwrite) - $fonctions.copyEntry(from, to, overwrite) :

date

roundTimeToNearestQuarter(date) - $fonctions.roundTimeToNearestQuarter(date)

Retourne une nouvelle date correspondant au trimestre le plus proche.

getEndOfYearDate(date) - $fonctions.getEndOfYearDate(date)

Retourne une nouvelle date représentant la date de fin de l’année dans laquelle se trouve la date donnée.

yearsBetween(date1, date2) - $fonctions.yearsBetween(date1, date2)

Retourne le nombre d’années entre deux dates.

getYear(date) - $fonctions.getYear(date)

Retourne l’année de la date donnée.

currentMilliSec() - $fonctions.currentMilliSec()

Retourne le timestamp système courant en millisecondes.

isValidDate(date) - $fonctions.isValidDate(date)

Vérifie si la date donnée est valide.

getMonth(date) - $fonctions.getMonth(date)

Retourne le mois de la date donnée.

incMonths(date) - $fonctions.incMonths(date)

Retourne une nouvelle date qui est exactement un mois dans le futur de la date donnée.

CompareDates - $fonctions.CompareDates :

currentDateTimeStr() - $fonctions.currentDateTimeStr()

Retourne la date courante au format 27/02/2013 12:00:00.

getDateTimeISO() - $fonctions.getDateTimeISO()

Retourne la date courante au format 2013-02-27 12:00:00.

getDateTimeSAI() - $fonctions.getDateTimeSAI()

Retourne la date courante au format 27/02/2013 12:00:00.

getStartOfWeekDate(date) - $fonctions.getStartOfWeekDate(date)

Retourne une nouvelle date représentant la date de début de la semaine dans laquelle se trouve la date donnée.

getEndOfWeekDate(date) - $fonctions.getEndOfWeekDate(date)

Retourne une nouvelle date représentant la date de fin de la semaine dans laquelle se trouve la date donnée.

getStartOfMonthDate(date) - $fonctions.getStartOfMonthDate(date)

Retourne une nouvelle date représentant la date de début du mois dans lequelle se trouve la date donnée.

getEndOfMonthDate(date) - $fonctions.getEndOfMonthDate(date)

Retourne une nouvelle date représentant la date de fin du mois dans lequelle se trouve la date donnée.

getStartOfYearDate(date) - $fonctions.getStartOfYearDate(date)

Retourne une nouvelle date représentant la date de début de l’année dans laquelle se trouve la date donnée.

roundTimeToNextQuarter(date) - $fonctions.roundTimeToNextQuarter(date)

Retourne une nouvelle date correspondant au trimestre suivant la date spécifiée.

fields

getFieldValue(id) - $fonctions.getFieldValue(id)

Retourne la valeur courante du champ spécifié.

setFieldValue(id, value) - $fonctions.setFieldValue(id, value)

Modifie la valeur du champ spécifié. L’identifiant peut être soit l’identifiant du champ à l’écran ou du datafield.

setFieldEnabled(id, enabled) - $fonctions.setFieldEnabled(id, enabled)

Active ou désactive le champ spécifié en fonction de l’argument enabled.

getDataFieldValue(datafieldId) - $fonctions.getDataFieldValue(datafieldId)

Retourne la valeur du champ pointant sur le datafield spécifié.

getDataFieldLabel(datafieldId) - $fonctions.getDataFieldLabel(datafieldId)

Retourne le libellé du champ pointant sur le datafield spécifié.

updateNoteOnField([tab]) - $fonctions.updateNoteOnField([tab])

Ouvre l’éditeur de note pour l’entrée actuellement ouverte, avec le tab spécifié sélectionné.

Les tabs possibles sont “text”, “image” ou “link”.

showWarningOnField(id) - $fonctions.showWarningOnField(id)

Affiche le symbole d’avertissement à côté du champ spécifié.

Par défaut, le symbole est une astérisque rouge.

file

isValidDirectoryName(dirName) - $fonctions.isValidDirectoryName(dirName)

Vérifie si le nom de répertoire donné est valide.

uploadFile(fileName, [metadata]) - $fonctions.uploadFile(fileName, [metadata])

Envoie le fichier spécifié sur le serveur.

L’arguement metadata optionel permet de définir une chaîne de caractères envoyée telle quelle vers le serveur.

Cette fonction retourne un booléen qui vaut true si aucune erreur n’est retournée par le serveur.

uploadFileAsTask(taskId, filePath, [metadata]) - $fonctions.uploadFileAsTask(taskId, filePath, [metadata])

Envoie le fichier spécifié sur le serveur en utiklisant la tâche donnée au lieu de la tâche courante.

L’arguement metadata optionel permet de définir une chaîne de caractères envoyée telle quelle vers le serveur.

Cette fonction retourne un booléen qui vaut true si aucune erreur n’est retournée par le serveur.

uploadFileToXML - $fonctions.uploadFileToXML

Envoie le fichier spécifié sur le serveur.

L’arguement metadata optionel permet de définir une chaîne de caractères envoyée telle quelle vers le serveur.

Cette fonction retourne la réponse XML du serveur qui peut ensuite être utilisée afin d’extraire le statut, un message, …

downloadFile(gedFile, [filePath], [metadata]) - $fonctions.downloadFile(gedFile, [filePath], [metadata])

Télécharge le fichier spécifié de la ged du serveur.

Si le chemin est donné, le client télécharge le fichier à l’emplacement précisé sur le disque. Le dossier parent doit exister pour que le téléchargement se fasse.

L’arguement metadata optionel permet de définir une chaîne de caractères envoyée telle quelle vers le serveur.

downloadFileAsTask - $fonctions.downloadFileAsTask :

unzipFile(zipFile, destinationFolder) - $fonctions.unzipFile(zipFile, destinationFolder)

Extrait le fichier ZIP donné vers l’emplacement spécifié.

Le dossier parent doit exister.

editTemplateFile - $fonctions.editTemplateFile :

getFileLastModification(filePath) - $fonctions.getFileLastModification(filePath)

Récupère la date de dernière modification du fichier spécifié.

setFileLastModification(filePath). - $fonctions.setFileLastModification(filePath).

Modifie la date de dernière modification du fichier spécifié pour la date courante.

openURL(url, [args]) - $fonctions.openURL(url, [args])

Ouvre l’adresse spécifié avec le navigateur par défaut.

L’argument optionel args permet de définir un comportement différent. Si “internal” est passé, le navigateur embarqué de SAINet est utilisé.

openFilePreview(filePath) - $fonctions.openFilePreview(filePath)

Ouvre le fichier spécifié avec l’aperçu de documents interne SAINet.

Cette fonction est prévue pour ouvrir des fichiers au format MHT ou HTML.

openImagePreview(filePath) - $fonctions.openImagePreview(filePath)

Ouvre le fichier spécifié avec l’aperçu de photos interne SAINet.

Cette fonction est prévue pour ouvrir des fichiers images.

openSAIDocument(filePath) - $fonctions.openSAIDocument(filePath)

Ouvre un document dans le répertoire “Documents” de l’utilisateur.

createFile(fileName, content) - $fonctions.createFile(fileName, content)

Crée un nouveau fichier à l’emplacement spécifié contenant le texte donné en argument.

readFile(filePath) - $fonctions.readFile(filePath)

Ouvre le fichier spécifié et retourne son contenu en chaîne de caractères.

Cette fonction est prévue pour lire des fichiers textes et non des fichiers binaires.

writeFile(filePath, fileContent) - $fonctions.writeFile(filePath, fileContent)

Ecrit la chaîne de caractère dans le fichier spécifié

copyFile(sourcePath, destinationPath) - $fonctions.copyFile(sourcePath, destinationPath)

Copie le fichier spécifé vers la destination donnée.

renameFile(sourcePath, destinationPath) - $fonctions.renameFile(sourcePath, destinationPath)

Déplace le fichier spécifé vers la destination donnée.

deleteFile(filePath) - $fonctions.deleteFile(filePath)

Supprime le fichier spécifié.

extractFileName(filePath) - $fonctions.extractFileName(filePath)

Retourne le nom de fichier du chemin spécifié.

Cette fonction supprime le chemin d’accès et les répertoires parents.

extractFileExt(filePath) - $fonctions.extractFileExt(filePath)

Retourne l’extension de fichier du chemin spécifié.

Cette fonction supprime tout le chemin d’accès, répertoires parents et le nom du fichier avant l’extension.

fileExists(filePath) - $fonctions.fileExists(filePath)

Vérifie l’existance du fichier spécifié.

isValidFileName(fileName) - $fonctions.isValidFileName(fileName)

Vérifie si le nom de fichier donné est valide.

directoryExists(filePath) - $fonctions.directoryExists(filePath)

Vérifie l’existance du répertoire spécifié.

getSystemImageResource(imageName) - $fonctions.getSystemImageResource(imageName)

Retourne le chemin d’accès à partir d’un nom d’image.

Cette fonction cherche dans les paquets à disposition afin de retrouver le fichier qui serait utilisé pour cette image.

openFile(filePath) - $fonctions.openFile(filePath)

Ouvre le fichier spécifié avec le programme par défaut pour l’extension.

input

removePageFromNewPageList(datapageId) - $fonctions.removePageFromNewPageList(datapageId)

Cache la page spécifié de la liste des pages sélectionnables lors de la création d’une nouvelle page.

clearPagesFromNewPageList() - $fonctions.clearPagesFromNewPageList()

Cache toutes les pages de la liste des pages sélectionnables lors de la création d’une nouvelle page.

removeThemeFromNewPageList(themeId) - $fonctions.removeThemeFromNewPageList(themeId)

Cache le thème spécifié de la liste des thèmes sélectionnables lors de la création d’une nouvelle page.

clearThemesFromNewPageList() - $fonctions.clearThemesFromNewPageList()

Cache tous les thèmes de la liste des thèmes sélectionnables lors de la création d’une nouvelle page.

addThemeToNewPageList(themeId) - $fonctions.addThemeToNewPageList(themeId)

Ajoute le thème spécifié dans la liste des thèmes sélectionnables lors de la création d’une nouvelle page.

addPageToNewPageList(datapageId) - $fonctions.addPageToNewPageList(datapageId)

Ajoute la page spécifiée dans la liste des pages sélectionnables lors de la création d’une nouvelle page.

createNewPage(datapageId) - $fonctions.createNewPage(datapageId)

Crée une nouvelle page avec l’identifiant de page spécifié.

validatePage() - $fonctions.validatePage()

Valide la page en cours de saisie.

selectPage(datapageId, pageId) - $fonctions.selectPage(datapageId, pageId)

Sélectionne la page spécifiée par son identifiant de page et son occurrence.

deletePage(datapageId, pageId) - $fonctions.deletePage(datapageId, pageId)

Supprime la page spécifiée par son identifiant de page et son occurrence.

getNbPages([datapageId]) - $fonctions.getNbPages([datapageId])

Retourne le nombre de pages ayant le datapage spécifié. Si l’identifiant de database est vide, retourne le nombre total de pages dans le dossier actuellement ouvert.

macros

executeAction - $fonctions.executeAction

Exécute une action de type Macro sur l’interface.

Voir la documentation des macros pour plus d’informations.

macroWaitForProcessTag - $fonctions.macroWaitForProcessTag

Exécute une attente pour un signal pour les macros.

Voir la documentation des macros pour plus d’informations.

assert - $fonctions.assert

Exécute une vérification pour les macros.

Voir la documentation des macros pour plus d’informations.

misc

getDataPageTheme - $fonctions.getDataPageTheme :

refreshView - $fonctions.refreshView :

getCurrentTaskTitle - $fonctions.getCurrentTaskTitle :

getSessionVar(variableName) - $fonctions.getSessionVar(variableName)

Retourne la valeur associée à la variable dans les Session Vars.

Si la variable n’existe pas, cette fonction retourne une chaîne vide.

lookupConfigurationFile(fileName) - $fonctions.lookupConfigurationFile(fileName)

Recherche et retourne le chemin complet pour accéder à la ressource correspondant au nom spécifié.

sendUsersSiteData - $fonctions.sendUsersSiteData :

getLastFormName() - $fonctions.getLastFormName()

Récupère le nom de la dernière fenêtre ouverte.

closeStartMenu - $fonctions.closeStartMenu :

openDashboard - $fonctions.openDashboard :

getDataFieldFormat(datafieldId) - $fonctions.getDataFieldFormat(datafieldId)

Retourne le format du datafield spécifié.

Les formats possibles sont ceux disponibles dans le paramétrage, voir l’aide sur la configuration XML pour plus d’informations.

getThemeLabel - $fonctions.getThemeLabel :

getDataPageLabel - $fonctions.getDataPageLabel :

openStartMenu - $fonctions.openStartMenu :

simplifyTask - $fonctions.simplifyTask :

getLocalGridCell(row, col) - $fonctions.getLocalGridCell(row, col)

Retourne la valeur de la grille courante à l’emplacement row, col.

updateLocalGridCell(row, col, value) - $fonctions.updateLocalGridCell(row, col, value)

Modifie le contenu de la grille à l’emplacement row, col avec la valeur value.

setConsoleCheckColumnPos - $fonctions.setConsoleCheckColumnPos :

getListViewItemsData - $fonctions.getListViewItemsData

Retourne la liste de prooriétés des éléments de la TListView, séparées par des points-virgules.

createDesktopShortcut - $fonctions.createDesktopShortcut :

downloadTemplate - $fonctions.downloadTemplate :

convertDateToAgeInCurrentGrid - $fonctions.convertDateToAgeInCurrentGrid :

consoleBeginCheckLine - $fonctions.consoleBeginCheckLine :

consoleEndCheckLine - $fonctions.consoleEndCheckLine :

countErrors() - $fonctions.countErrors()

Retourne le nombre d’erreurs.

updateCurrentChartSubTitle - $fonctions.updateCurrentChartSubTitle :

runChartForCurrentGrid - $fonctions.runChartForCurrentGrid :

runStatsForCurrentGrid - $fonctions.runStatsForCurrentGrid :

getHistoryViewerLegendColor - $fonctions.getHistoryViewerLegendColor :

getHistoryViewerEventDataFieldValue - $fonctions.getHistoryViewerEventDataFieldValue :

getCurrentPlanningEventsCount - $fonctions.getCurrentPlanningEventsCount :

setCurrentPlanningTitle - $fonctions.setCurrentPlanningTitle :

setTitleForCurrentPlanning - $fonctions.setTitleForCurrentPlanning

Modifie le titre du planning ouvert actuellement.

eval(codeStr) - $fonctions.eval(codeStr)

Evalue le code passé en argument comme script.

Par exemple, il est possible de passer, en string, “2 + 3”, ce qui retournera, en string, “5”.

varExists(var) - $fonctions.varExists(var)

Vérifie l’existance d’une variable.

Cette fonction retourne true si la variable existe. False sinon.

setConsoleBufferWidth - $fonctions.setConsoleBufferWidth :

getNavigatorSQLFilter - $fonctions.getNavigatorSQLFilter :

closeDashboard - $fonctions.closeDashboard :

grid - $fonctions.grid :

openScanPanel - $fonctions.openScanPanel :

refreshStatusBar - $fonctions.refreshStatusBar :

updateCurrentDomainVar - $fonctions.updateCurrentDomainVar :

getGridRowAsCSVString - $fonctions.getGridRowAsCSVString :

setDatesForCurrentPlanning - $fonctions.setDatesForCurrentPlanning

Modifie la plage de dates utilisée dans le planninng ouvert actuellement.

setDateForCurrentPlanning - $fonctions.setDateForCurrentPlanning

Modifie la date courante utilisée dans le planning ouvert actuellement.

getTaskVar - $fonctions.getTaskVar :

chainExists(chainId) - $fonctions.chainExists(chainId)

Vérifie l’existance de la chaîne spécifiée.

tableExists(tableId) - $fonctions.tableExists(tableId)

Vérifie l’existance de la table spécifiée.

showOnlyConfigs - $fonctions.showOnlyConfigs :

loadConfigForCurrentTask - $fonctions.loadConfigForCurrentTask :

showSelectGrid - $fonctions.showSelectGrid

Ouvre une fenêtre de saisie permettant la sélection d’une ou plusieurs entrées à partir d’une grille retournée par le serveur.

Cette fonction retourne les entrées sélectionnées par l’utilisateur afin, par exemple, d’être traitées par le script par la suite.

disableScripting - $fonctions.disableScripting :

getCurrentRecordNoteLinks - $fonctions.getCurrentRecordNoteLinks :

enableScripting - $fonctions.enableScripting :

updateDomainInfos - $fonctions.updateDomainInfos :

createNewInstance - $fonctions.createNewInstance :

openWorkflowEditor - $fonctions.openWorkflowEditor

Ouvre l’éditeur de Workflows.

setTaskVar - $fonctions.setTaskVar :

macroWaitOnActiveTasks - $fonctions.macroWaitOnActiveTasks :

cancelCurrentProcess - $fonctions.cancelCurrentProcess :

getCoupleItemsList(fieldId, reserved, separator) - $fonctions.getCoupleItemsList(fieldId, reserved, separator)

Retourne les identifiants sélectionnés dans le champ spécifié.

Les valeurs sont retournées au format chaîne de caractères et séparées par le séparateur spécifié.

showConvUnitsDialog - $fonctions.showConvUnitsDialog :

findTextInGrid - $fonctions.findTextInGrid :

setSessionVar(variableName, value) - $fonctions.setSessionVar(variableName, value)

Modifie la variable de session spécifiée avec la valeur donnée.

Si la variable n’existe pas, elle est automatiquement créée dans les Session Vars.

extractUserMessageFromServerReply(reply) - $fonctions.extractUserMessageFromServerReply(reply)

Extrait et retourne le message de la réponse serveur, s’il existe. Si aucun message n’est précisé, cette fonction retourne une chaîne vide.

extractOperationStatusFromServerReply(reply) - $fonctions.extractOperationStatusFromServerReply(reply)

Extrait et retourne le statut de la réponse serveur.

Les valeurs possibles sont SUCCESS, WARNING ou FAILURE.

readComboXMLProperty - $fonctions.readComboXMLProperty :

handleServerReply - $fonctions.handleServerReply :

clearTableCache(tableId) - $fonctions.clearTableCache(tableId)

Vide le cache de la table spécifiée.

L’appel à cette méthode sert si des entrées ont été créées automatiquement dans une table afin que les couples soient immédiatement mis à jour.

sleep - $fonctions.sleep :

affectExternalVariables - $fonctions.affectExternalVariables :

setGenericWaitFormProgress(advancement) - $fonctions.setGenericWaitFormProgress(advancement)

Modifie l’avancmeent de la barre de progression actuellement affichée sur la tâche courante.

Les valeurs admises sont comprises entre 0 et 100.

navigateur

selectNextRecord() - $fonctions.selectNextRecord() :

readLastRecord() - $fonctions.readLastRecord()

Réouvre la dernière ligne saisie.

selectLastRecord() - $fonctions.selectLastRecord() :

selectFirstRecord() - $fonctions.selectFirstRecord() :

getSubNavigatorData - $fonctions.getSubNavigatorData :

getNavigatorColumn(column) - $fonctions.getNavigatorColumn(column)

Retourne les données d’une colonne spécifique du navigateur principal comme texte.

getNavigatorData() - $fonctions.getNavigatorData()

Retourne le contenu de la grille du navigateur principal sous forme de chaîne de caractères.

updateSubNavigator() - $fonctions.updateSubNavigator()

Force la mise à jour du contenu du sous-navigateur dans la tâche courante. Cette fonction ne fait rien si la tâche n’est pas une tâche à deux niveaux.

updateNavigator() - $fonctions.updateNavigator()

Force la mise à jour du contenu du navigateur principal dans la tâche courante. Cette fonction ne fait rien si la tâche n’est pas une tâche de saisie.

selectPreviousRecord() - $fonctions.selectPreviousRecord() :

notes

updateNoteOnRecord([tab]) - $fonctions.updateNoteOnRecord([tab])

Les tabs possibles sont “text”, “image” ou “link”.

forceDownloadRecordNote() - $fonctions.forceDownloadRecordNote() :

getRecordNoteText() - $fonctions.getRecordNoteText()

Retourne le contenu texte de la note de l’entrée actuellement sélectionée, si elle existe.

getCurrentRecordNoteImage - $fonctions.getCurrentRecordNoteImage :

getCurrentNoteSound - $fonctions.getCurrentNoteSound :

getCurrentNoteImage - $fonctions.getCurrentNoteImage :

getTextOfImage(imageFile) - $fonctions.getTextOfImage(imageFile)

Exécute une reconnaissance de caractères sur l’image spécifiée.

createNoteOnRecord([tab]) - $fonctions.createNoteOnRecord([tab])

Ouvre l’éditeur de note pour l’entrée actuellement ouverte, avec le tab spécifié sélectionné.

Les tabs possibles sont “text”, “image” ou “link”.

numbers

floatApproxRange - $fonctions.floatApproxRange :

output

showMessage(text) - $fonctions.showMessage(text)

Affiche un message à l’utilisateur dans un popup avec le texte spécifié.

showDialog2b(text) - $fonctions.showDialog2b(text)

Affiche un message à l’utilisateur dans un popup avec le texte spécifié. Le popup contient deux boutons: “Oui” et “Non”

“Oui” retourne 1, “Non” retourne 2.

showDialog2(text) - $fonctions.showDialog2(text)

Affiche un message à l’utilisateur dans un popup avec le texte spécifié. Le popup contient deux boutons: “Ok” et “Annuler”

“Ok” retourne 1, “Annuler” retourne 2.

showFinishMessage - $fonctions.showFinishMessage

Affiche un message à l’utilisateur dans un popup avec le texte spécifié.

showErrorMessage(text) - $fonctions.showErrorMessage(text)

Affiche un message à l’utilisateur dans un popup avec le texte spécifié. L’icône dans le popup est une erreur.

showWarningMessage(text) - $fonctions.showWarningMessage(text)

Affiche un message à l’utilisateur dans un popup avec le texte spécifié. L’icône dans le popup est un avertissement.

showOpenDialog(basedir, filter) - $fonctions.showOpenDialog(basedir, filter)

Ouvre le dialogue de sélection de fichiers de Windows dans le répertoire spécifié avec le filtre de sélection de fichiers spécifié.

Si le répertoire est “”, le dialogue s’ouvre sur le répertoire utilisateur Windows.

Le filtre est précisé au format ‘Documents PDF (*.pdf)|*.pdf’.

consoleError(text) - $fonctions.consoleError(text)

Ecrit le texte spécifié dans la console SAINet avec un niveau Erreur.

consoleWarning(text) - $fonctions.consoleWarning(text)

Ecrit le texte spécifié dans la console SAINet avec un niveau Avertissement.

consoleDebug(text) - $fonctions.consoleDebug(text)

Ecrit le texte spécifié dans la console SAINet.

showDialogFromServerReply(reply) - $fonctions.showDialogFromServerReply(reply) :

closeGenericWaitForm() - $fonctions.closeGenericWaitForm()

Cache la barre d’avancement actuellement affichée sur la tâche courante.

showSaveDialog(basedir, filter) - $fonctions.showSaveDialog(basedir, filter)

Ouvre le dialogue de sélection de fichiers de Windows dans le répertoire spécifié avec le filtre de sélection de fichiers spécifié.

Si le répertoire est “”, le dialogue s’ouvre sur le répertoire utilisateur Windows.

Le filtre est précisé au format ‘Documents PDF (*.pdf)|*.pdf’.

Le chemin sélectionné par l’utilisateur est retourné.

showGenericWaitForm() - $fonctions.showGenericWaitForm()

Affiche la barre de progression sur la tâche courante.

string

compareRegExp - $fonctions.compareRegExp :

replaceRegExp - $fonctions.replaceRegExp :

getLowerCase - $fonctions.getLowerCase :

getPropertyValue(text, attrib) - $fonctions.getPropertyValue(text, attrib) :

extractXMLNode(text, node, [nodeid]) - $fonctions.extractXMLNode(text, node, [nodeid]) :

extractXMLNodeContent(text, node, [nodeid]) - $fonctions.extractXMLNodeContent(text, node, [nodeid]) :

getUpperCase - $fonctions.getUpperCase :

countStringsInString(haystack, needle) - $fonctions.countStringsInString(haystack, needle)

Retourne le nombre d’occurences de la chaîne ‘needle’ dans la chaîne ‘haystack’.

split(text, sep, index) - $fonctions.split(text, sep, index)

Retourne l’élément à l’indice spécifié dans le texte. La chaîne est indicée à 1.

replaceAll(haystack, needle, replacement) - $fonctions.replaceAll(haystack, needle, replacement)

Remplace toutes les occurrences de ‘needle’ dans la chaîne de caractères ‘haystack’ par ‘replacement’.

getTextNormalized - $fonctions.getTextNormalized :

clearAccents - $fonctions.clearAccents :

random - $fonctions.random :

condStr(text, cond) - $fonctions.condStr(text, cond)

Retourne le texte spécifié si la condition est résolue à true. Si la condition est résolue à false, une chaîne vide est retournée.

randomString(count, format) - $fonctions.randomString(count, format) :

isNullOrEmpty(str) - $fonctions.isNullOrEmpty(str)

Helper pour vérifier si une chaîne de caractères est vide ou nulle.

tasks

run([taskId], [domainId], screenContent) - $fonctions.run([taskId], [domainId], screenContent)

Exécute la tâche courante ou la tâche spécifiée avec le modèle donné.

createNewRecord - $fonctions.createNewRecord :

selectRecord(xmlKey) - $fonctions.selectRecord(xmlKey)

Sélectionne le record avec la clé spécifiée.

closeRecord() - $fonctions.closeRecord()

Ferme la saisie en cours.

terminateRecord() - $fonctions.terminateRecord()

Termine la saisie en cours.

validateRecord() - $fonctions.validateRecord()

Valide la saisie en cours.

switchToSuperTaskTab(tabId) - $fonctions.switchToSuperTaskTab(tabId)

Dans une supertâche, sélectionne le tab avec l’identifiant spécifié.

Si aucune entrée n’est sélectionnée et le tab spécifié n’est pas accessible, cette méthode fait une erreur en console et ne change pas de tab.

callTask(taskId) - $fonctions.callTask(taskId)

Ouvre la tâche spécifiée.

callTaskAtPos(taskId, leftPos, topPos, width, height) - $fonctions.callTaskAtPos(taskId, leftPos, topPos, width, height)

Ouvre la tâche spécifiée à la position et taille donnée.

taskExists(taskId) - $fonctions.taskExists(taskId)

Vérifie l’existance de la tâche spécifiée.

getCurrentTaskClassName() - $fonctions.getCurrentTaskClassName()

Retourne le titre actuel de la tâche courante.

setCurrentTaskTitle(newTitle) - $fonctions.setCurrentTaskTitle(newTitle)

Modifie le titre de la tâche courante avec le texte spécifié.

run_back([taskId], [domainId], screenContent) - $fonctions.run_back([taskId], [domainId], screenContent) :

closeTask([activeTaskId]) - $fonctions.closeTask([activeTaskId])

Ferme une tâche basé sur l’identifiant de tâche. Si aucun identifiant n’est spécifié, ferme la tâche courante.

L’identifiant de tâche est l’identifiant retourné lors de l’appel à l’ouverture d’une tâche par script.

openTablesNavigator - $fonctions.openTablesNavigator :

restoreSpecInputInterfaces() - $fonctions.restoreSpecInputInterfaces()

Restaure les modes de saisies spécifiques qui ont été annulés par cancelAllSpecInputInterfaces.

cancelAllSpecInputInterfaces() - $fonctions.cancelAllSpecInputInterfaces()

Annule toutes les fenêtres et configurations spécifiques permettant de modifier le type de saisie de la tâche (en grille ou en historique par exemple) afin de forcer l’ouverture en mode saisie normal.

callTaskWithDomain(taskId, domainId) - $fonctions.callTaskWithDomain(taskId, domainId)

Ouvre la tâche spécifiée dans le domaine spécifié au lieu du domaine courant.

callSameTaskWithModel(taskId, model) - $fonctions.callSameTaskWithModel(taskId, model)

Ouvre la tâche spécifiée et applique le modèle. Si la tâche est déjà ouverte, le modèle est appliqué sur la tâche déjà ouverte et aucune nouvelle tâche n’est ouverte.

callTaskWithModel(taskId, model) - $fonctions.callTaskWithModel(taskId, model)

Ouvre la tâche spécifiée et applique le modèle sur cette tâche.

callTaskAndSelectRecord(taskID, recordKey) - $fonctions.callTaskAndSelectRecord(taskID, recordKey)

Ouvre la tâche spécifiée et sélectionne l’entrée identifiée par la clé donnée.

callTaskWithDataFilterAndDomain - $fonctions.callTaskWithDataFilterAndDomain :

callTaskWithDataFilterAndSubFilter - $fonctions.callTaskWithDataFilterAndSubFilter :

callTaskWithDataFilter(taskID, filter, [autoselect], [sessionvars]) - $fonctions.callTaskWithDataFilter(taskID, filter, [autoselect], [sessionvars])

Appelle la tâche spécifiée avec le filtre donné.

Si l’argument autoselect est spécifié et true, la première entrée disponible est automatiquement ouverte.

L’arguement optionnel sessionvars permet de passer des variables supplémentaires pour les appels effectués pour cette tâche.

timer

createTaskTimer(timerId, script, interval, start) - $fonctions.createTaskTimer(timerId, script, interval, start)

Créé un timer identifié par timerId qui exécute le script à intervalles réguliers défini en millisecondes par interval.

Le dernier argument permet de définir si le timer s’exécute dès sa création ou s’il doit être démarré par un appel à startTaskTimer.

startTaskTimer(timerId) - $fonctions.startTaskTimer(timerId)

Démarre le timer ayant l’identifiant timerId.

stopTaskTimer(timerId) - $fonctions.stopTaskTimer(timerId)

Arrête le timer ayant l’identifiant timerId.

Si le timer est en cours d’exécution lorsque cette fonction est appelée, il termine son opération avant de s’arrêter.