Descripteurs de l'API SOAP

Un descripteur est un objet URL spécial qui référence une instance d'objet particulière dans une instance d'Unica Plan . Le type de composant, l'identificateur des données interne et une URL de base d'instance sont des descripteurs.

Les descripteurs utilisés ou générés par les API peuvent être externalisés vers une adresse URL complète. Vous pouvez utiliser cette URL de différentes manières, par exemple pour ouvrir une vue du composant dans l'interface graphique Unica Plan, l'envoyer dans des courriers électroniques ou l'utiliser dans une autre procédure en tant que paramètre.

Les descripteurs sont uniquement valides pour une instance de service ou une instance en cluster Unica Plan donnée, mais leur validité est garantie pour toute la durée de vie du service déployé. Par conséquent, les descripteurs peuvent être sauvegardés dans un fichier pour une référence ultérieure, mais ils ne peuvent pas être utilisés pour accéder à des composants sur une autre instance Unica Plan. Cette restriction s'applique également aux instances présentes sur le même serveur hôte physique. Toutefois, Unica Plan ne fournit pas de mécanisme de mappage de différentes URL de base à l'instance en cours en vue de permettre le déplacement d'une instance sur une autre serveur (par exemple, si le matériel présente un dysfonctionnement).

Les descripteurs sont indépendants du client. Par exemple, un déclencheur peut transmettre un descripteur à une procédure, qui l'utilise ensuite en tant que paramètre dans un appel SOAP vers un système tiers. Le système tiers peut ensuite renvoyer une demande SOAP à Unica Plan pour démarrer une procédure de mise à jour d'un attribut.

Les membres de la classe Handle comportent des méthodes de fabrique destinées à créer des descripteurs pour divers types d'URL. Exemples :

Approbation
http://mymachine:7001/plan/affiniumplan.jsp?cat=approvaldetail&
approvalid=101
Document
http://mymachine:7001/plan/affiniumplan.jsp?cat=asset&
assetMode=VIEW_ASSET&assetid=101
Dossier de documents
http://mymachine:7001/plan/affiniumplan.jsp?cat=folder&id=101
Bibliothèque de documents
http://mymachine:7001/plan/affiniumplan.jsp?cat=library&id=101
Pièce jointe
http://mymachine:7001/plan/affiniumplan.jsp?cat=attachmentview&
attachid=101&parentObjectId=101&parentObjectType=project
Compte financier
http://mymachine:7001/plan/affiniumplan.jsp?cat=accountdetails&
accountid=101
Dossier
http://mymachine:7001/plan/affiniumplan.jsp?cat=grouping_folder&
folderid=1234
Facture
http://mymachine:7001/plan/affiniumplan.jsp?cat=invoicedetails&
invoiceid=134
Ligne de facture
http://mymachine:7001/plan/affiniumplan.jsp?cat=invoicedetails&
invoiceid=134&line_item_id=101
Objet marketing
http://mymachine:7001/plan/affiniumplan.jsp?cat=componenttabs&
componentid=creatives&componentinstid=1234
Grille d'objet marketing
http://mymachine:7001/plan/affiniumplan.jsp?cat=componenttabs&
componentid=creatives&componentinstid=1234&gridid=grid
Ligne de grille d'objet marketing
http://mymachine:7001/plan/affiniumplan.jsp?cat=componenttabs&
componentid=creatives&componentinstid=1234&gridid=grid&gridrowid=101
Equipe de plan
http://mymachine:7001/plan/affiniumplan.jsp?cat=teamdetails&
func=edit&teamid=100001
Utilisateur du plan
http://mymachine:7001/plan/affiniumplan.jsp?cat=adminuserpermissions&
func=edit&userId=101
Programme
http://mymachine:7001/plan/affiniumplan.jsp?cat=programtabs&programid=125
Grille de programme
http://mymachine:7001/plan/affiniumplan.jsp?cat=programtabs&
programid=1234&gridid=grid
Ligne de grille de programme
http://mymachine:7001/plan/affiniumplan.jsp?cat=programtabs&
programid=1234&gridid=grid&gridrowid=101
Projet
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs&
projectid=1234
Grille de projet
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs&
projectid=1234&gridid=grid
Ligne de grille de projet
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs&
projectid=1234&gridid=grid&gridrowid=101
Ligne de projet
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs&
projectid=1234&projectlineitemid=123&projectlineitemisversionfinal=false 
Etat de workflow
http://mymachine:7001/plan/affiniumplan.jsp?cat=projectworkflow&
projectid=1234&taskid=5678
Tâche de workflow
http://mymachine:7001/plan/affiniumplan.jsp?cat=projectworkflow&
projectid=1234&taskid=5678