Suivi des utilisations étendues

La fonctionnalité Rights Management (RM) peut suivre divers événements personnalisés pouvant être effectués sur un document protégé. Vous pouvez activer le suivi des événements depuis le serveur de Rights Management au niveau global ou au niveau stratégique. Vous pouvez ensuite configurer un JavaScript pour capturer les actions spécifiques effectuées dans un fichier PDF protégé tel qu’un clic sur un bouton ou l’enregistrement du document. Ces données d’utilisation sont envoyées sous la forme d’un fichier XML de paires clé/valeur, que vous pouvez utiliser pour une analyse ultérieure.

Les utilisateurs finaux accédant aux documents protégés peuvent autoriser ou refuser un tel suivi à partir de l’application cliente. Dans Rights Management Administration Console, les objets blob sont affichés comme « Données détaillées du suivi de l’utilisation » pour le document protégé.

Remarque : pour afficher les événements suivis, un SPI de contrôle doit être déployé. Pour plus d’informations sur le contrôle externe, voir Contrôle d’événements.

Objet RightsManagement

Cet objet sert de point d’entrée pour l’ensemble des objets, méthodes et propriétés liées à Rights Management. Une instance d’objet RightsManagement peut être obtenue à partir de l’objet doc. Par exemple :

var obj = doc.rightsManagement;

Propriétés de l’objet RightsManagement

Nom de la propriété	Type	Type d’accès	Description
serverUrl	String	READONLY	URL du serveur LiveCycle RM.
serverVersion	String	READONLY	Version du serveur LiveCycle RM.
visitorID	String	READONLY	Identifie une installation Acrobat unique.
isOffline	Boolean	READONLY	L’utilisateur tente-t-il d’accéder au document en mode hors connexion ?
policyInfo	Objet RMPolicy	READONLY	Informations relatives à la stratégie RM associée au document.
userInfo	Objet RMUser	READONLY	Informations relatives à l’utilisateur RM authentifié.
documentInfo	Objet RMDocument	READONLY	Informations relatives au document RM ouvert.

Méthodes de l’objet RightsManagement

Nom de la méthode

Type de retour

Description

captureEvent(eventID de la chaîne, eventVal facultatif)

Boolean

Capture un événement de suivi et le stocke dans la mémoire. Les événements sont envoyés au serveur uniquement dans les conditions suivantes :

1. La file d’attente des événements est complète (25 en cours).

2. L’utilisateur appelle explicitement la méthode flushEvents.

3. Un autre événement se produit et doit être envoyé immédiatement au serveur.

4. L’utilisateur ferme le document.

Renvoie la valeur false si le suivi n’est pas activé.

flushEvents()

Boolean

Force l’envoi des événements de suivi au serveur RM. Si le document est ouvert en mode hors connexion, cette méthode enregistre les événements en cache dans une base de données sur l’ordinateur de l’utilisateur.

Les événements de suivi sont envoyés au serveur lorsque l’utilisateur rouvre le document en mode en ligne.

Cette méthode renvoie la valeur false, si le suivi n’est pas activé.

getTrackingStatus()

Entier

Cette méthode peut être utilisée pour vérifier si le suivi est activé pour le document.

Les valeurs de retour possibles sont les suivantes :

0 : refusé par le serveur LC RM

1 : refusé par l’utilisateur Acrobat

2 : autorisé

Exemple de code

var RMobj=this.rightsManagement;

RMobj.captureEvent("ServerURL",RMobj.serverURL);

RMobj.captureEvent("VisitorID",RMobj.visitorID);

RMobj.captureEvent("userInfo ",RMobj.userInfo.ID);

RMobj.flushEvents();

Objet RMDocument

L’objet RMDocument contient les propriétés d’un document protégé par LiveCycle RM.

Propriétés de l’objet RMDocument

Nom de la propriété	Type	Type d’accès	Description
ID	String	READONLY	ID (GUID) du document protégé par RM.
expiryDate	String	READONLY	Date d’expiration du document au format UTC. Renvoie « Toujours valable » pour les documents à licence perpétuelle.
offlineLeasePeriod	Entier	READONLY	Période d’ouverture hors connexion.
Les filigranes au format	Array	READONLY	Tableau d’objets RMWatermark

Exemple de code

var RMobj=this.rightsManagement;

RMobj.captureEvent("Document ID ", RMobj.documentInfo.ID);

RMobj.captureEvent("VisitorID",RMobj.documentinfo.expiryDate);

RMobj.captureEvent("userInfo ",RMobj. documentinfo.offlineLeasePeriod);

RMobj.flushEvents();

Objet RMUser

RMUser correspond à l’utilisateur actuel authentifié.

Propriétés de l’objet RMUser

Nom de la propriété	Type	Type d’accès	Description
ID	String	READONLY	Nom d’utilisateur de l’utilisateur authentifié. Vide pour un utilisateur non authentifié.
name	Chaîne	READONLY	Nom d’affichage de l’utilisateur authentifié. Vide pour un utilisateur non authentifié.
isAnonymous	String	READONLY	Dans le cas d’un utilisateur non authentifié.
hasEditPerm	Boolean	READONLY	L’utilisateur peut modifier le contenu.
hasCopyPerm	Boolean	READONLY	L’utilisateur peut copier le contenu.
hasCollabPerm	Boolean	READONLY	L’utilisateur peut collaborer.
hasAlterPagesPerm	Boolean	READONLY	L’utilisateur peut supprimer ou ajouter des pages.
hasFillAndSignPerm	Boolean	READONLY	La signature numérique est autorisée.
hasPrintPerm	Boolean	READONLY	L’utilisateur peut imprimer le contenu.
hasPrintLowResPerm	Boolean	READONLY	L’utilisateur peut imprimer le document en basse résolution.
hasChangePolicyPerm	Boolean	READONLY	L’utilisateur peut supprimer la protection ou modifier la stratégie.

Exemple de code

var RMobj=this.rightsManagement;

RMobj.captureEvent("ServerURL",RMobj.serverURL);

RMobj.captureEvent("userInfo ",RMobj.userInfo.ID);

RMobj.flushEvents();

Objet RMPolicy

Un objet RMPolicy contient les propriétés de la stratégie RM associée au document.

Propriétés de l’objet RMPolicy

Nom de la propriété	Type	Type d’accès	Description
ID	String	READONLY	ID (GUID) de la stratégie.
name	Chaîne	READONLY	Nom convivial de la stratégie
description	Chaîne	READONLY	Description de la stratégie

Exemple de code

var RMobj=this.rightsManagement;

RMobj.captureEvent("Policy Name",RMobj.policyInfo.name);

RMobj.captureEvent("Policy ID",RMobj.policyInfo.ID);

RMobj.flushEvents();

Objet RMWatermark

Filigranes associés au document.

Propriétés de l’objet RMWatermark

Nom de la propriété	Type	Type d’accès	Description
vertAlign	Entier	READONLY	Alignement vertical du filigrane. Les valeurs possibles sont les suivantes : align.top, align.center, align.bottom
horizAlign	String	READONLY	Alignement horizontal du filigrane. Les valeurs possibles sont les suivantes : align.left, align.center, align.right
vertOffset	Flottant	READONLY	Décalage vertical du filigrane.
horizOffset	Flottant	READONLY	Décalage horizontal du filigrane.
scale	Flottant	READONLY	Taille de la police des filigranes.
rotation	Flottant	READONLY	De 0 à 359. Rotation (en degrés) du filigrane.
opacity	Flottant	READONLY	De 0.0 à 1.0. Opacité du filigrane.
isFixed	Boolean	READONLY	Si la valeur est false, le filigrane doit être mis à l’échelle pour tenir sur la page. Dans le cas contraire, l’échelle par défaut doit être utilisée.
startPage	Entier	READONLY	Première page à partir de laquelle le filigrane est appliqué (soit page 0)
endPage	Flottant	READONLY	Dernière page jusqu’à laquelle le filigrane est appliqué (-1 pour indiquer toutes les pages)
pageSelection	String	READONLY	Le filigrane sera appliqué sur les pages « impaires » ou « paires », ou sur « toutes » les pages.
isOnScreen	Boolean	READONLY	Le filigrane s’affiche lorsque le document est visualisé sur écran.
isOnPrint	Boolean	READONLY	Le filigrane est imprimé avec le document.
percentage	Boolean	READONLY	Les valeurs spécifiées pour les décalages verticaux et horizontaux sont indiquées en pourcentage.
customText	Boolean	READONLY	Texte personnalisé inclus dans le filigrane.
isCustomTextEnabled	Boolean	READONLY	Texte personnalisé inclus dans le filigrane.
isUserIDEnabled	Boolean	READONLY	Détermine si le filigrane comprend des informations d’identification de l’utilisateur qui ouvre le document associé.
isUserNameEnabled	Boolean	READONLY	Détermine si le filigrane comprend le nom de l’utilisateur qui ouvre le document associé.
isCurrentDateEnabled	Boolean	READONLY	Détermine si le filigrane comprend la date d’ouverture du document associé.
isPolicyEnabled	Boolean	READONLY	Détermine si le filigrane comprend la stratégie de protection du document.
fontName	string	READONLY	Nom de la police à utiliser pour le texte du filigrane.
fontSize	Flottant	READONLY	Taille de la police à utiliser pour le texte du filigrane.
colorSpace	String	READONLY	Espace colorimétrique de la couleur.
color	Tableau de nombres	READONLY	Couleur du texte du filigrane.

Exemple de code

var RMobj=this.rightsManagement;

console.println("Watermarks Info");

RMobj.captureEvent("Vertical Alignment" , obj1.watermarks[0].vertAlign);

RMobj.captureEvent("Watermark Type" , obj1.watermarks[0].type);

RMobj.flushEvents();