Utilisation des classes P5 dans les scripts OJS

Le 23/02/2012 Par Thibault Goninplaniswareopx2p5ojsscript

Lorsque l’on développe des fonctionnalités en script OJS il est souvent nécessaire de connaitre les classes d’objet présentes dans P5. En effet, de nombreuses fonctions OJS utilisent les classes d’objet P5 nécessitent de connaitre la dénomination exacte de la classe en OJS.

Par exemple pour obtenir un projet sous forme d’objet P5 grâce à son ID on pourra utiliser une syntaxe du type :

var mon_projet = "OpxProject".get("ID_DE_MON_PROJET"

Le mot clé « OpxProject » permet de préciser la classe de l’objet sur laquelle va porter la fonction get(). Ce mot clé est construit de la manière suivante :

"Opx" + <em>Nom de la classe P5 ou de la table additionnelle.</em>

Par __exemple pour créer une nouvelle alerte dans la table additionnelle des alertes intranet nommée « _AL_PT_AL », la syntaxe serait :

mon_alerte = new "Opx_AL_PT_AL" ( "NOM" , "nom_de_mon_alerte" , "CLASSE_A_SURVEILLER" , "classe_de_mon_alerte" , "COMMENT" , "libellé_de_mon_alerte" )

 

Difficulté d’utilisation des classes P5 en OJS

S’il est en général facile de retrouver la classe P5 à partir de sa dénomination en OJS, il est parfois difficile de connaître facilement la dénomination exacte de la classe en OJS à partir de son nom dans P5. Par exemple une AFFECTATION dans P5 se traduit en OJS « OpxPlannedHours ».

Cet article liste donc les classes P5 en donnant la traduction en OJS correspondante. Etant donné le nombre important de classes dans P5 cette liste ne sera pas exhaustive mais sera enrichie au fil du temps.

 

Classe P5Descriptif de la classeNom de la classe en OJS
FICHIER_ENVIRONFichier d’environnementOpxEnvironmentFile
FICHIER_COMMUNFichier communOpxCommonFile
PROJETProjetOpxProject
RESPONSABLEResponsableOpxObsElement
TACHETâcheOpxTask
SOUS_PROJETSous-projetOpxNetwork
RESSOURCERessourceOpxResource
AFFECTATIONAffectationOpxPlannedHours

 

Astuce pour retrouver le nom d’une classe P5 en OJS

La méthode suivante permet de retrouver ou vérifier rapidement la dénomination OJS d’une classe P5. Il s’agit de créer une macro d’actions multiples sur la classe concernée puis de transformer en OPX2 Script via la fonction standard prévue à cet effet.

  1. Créer une nouvelle macro d’action multiple :
Données > Actions multiples > Actions multiples…

image11.jpg

Etape 1 : Créer une nouvelle macro

 

  1. Renseigner la classe sur laquelle va porter la macro P5

image2.jpg

Etape 2 : Sélection de la classe et archivage

 

  1. Archiver la macro (par exemple sous le nom « AAAA »)

image3.jpg

Etape 3 : Archivage de la macro

 

  1. Ouvrir la table des objets d’environnement et rechercher la macro précédemment créée (dans notre exemple filtrer sur ID= »AAAA »).
 Fichier > Administration > Environnement…

Sélectionner la macro et cliquer sur le bouton de transformation de la macro en script.

image4.jpg

Etape 4 : Sélection et transformation de la macro

  5) Sélectionner le script puis l&rsquo;ouvrir.

image5.jpg

Etape 5 : Sélection du script

 

  1. Retrouver le nom de la classe en OJS (ici « OpxObsElement »).

image6.jpg

Etape 6 : Consultation de la syntaxe du script

 

À voir aussi

Tous les articles