Comment : activer le suivi et la révocation de documentsHow-to: enable document tracking and revocation

Cette rubrique décrit les instructions de base pour implémenter le suivi des documents pour le contenu ainsi que l’exemple de code pour les mises à jour de métadonnées et la création d’un bouton Suivre l'utilisation pour votre application.This topic covers the basic guidance for implementing document tracking of content as well as example code for metadata updates and for creating a Track Usage button for your app.

Étapes pour implémenter le suivi des documentsSteps to implement document tracking

Les étapes 1 et 2 permettent au document d’être suivi.Steps 1 and 2 enable the document to be tracked. L’étape 3 permet aux utilisateurs de votre application d’atteindre le site de suivi des documents pour suivre et révoquer vos documents protégés.Step 3 enables your app users to reach the document tracking site in order to track and revoke your protected documents.

  1. Ajouter des métadonnées de suivi des documentsAdd document tracking metadata
  2. Inscrire le document auprès du service RMSRegister the document with the RMS service
  3. Ajouter un bouton Suivre l’utilisation à votre applicationAdd Track Usage button to your app

Les détails de l’implémentation de ces étapes suivent.The implementation details for these steps follow.

1. Ajouter des métadonnées de suivi des documents1. Add document tracking metadata

Le suivi de documents est une fonctionnalité du système Rights Management.Document tracking is a feature of the Rights Management system. En ajoutant des métadonnées spécifiques pendant le processus de protection d’un document, vous pouvez inscrire le document auprès d’un portail de services offrant différentes options de suivi.By adding specific metadata during the document protection process, a document can be registered with the tracking service portal which then provides several options for tracking.

Utilisez ces API pour ajouter/mettre à jour une licence de contenu avec les métadonnées de suivi des documents.Use these APIs to add/update a content license with document tracking metadata.

Du point de vue opérationnel, seules les propriétés nom du contenu et type de notification sont nécessaires pour le suivi des documents.Operationally, only the content name and the notification type properties are required for document tracking.

  • IpcCreateLicenseMetadataHandleIpcCreateLicenseMetadataHandle
  • IpcSetLicenseMetadataPropertyIpcSetLicenseMetadataProperty

    Vous définirez sans doute toutes les propriétés des métadonnées.We expect that you will set all of the metadata properties. Celles-ci, classées par type, sont répertoriées ci-dessous.Here they are, listed by type.

    Pour plus d’informations, consultez Types de propriétés des métadonnées de licence.For more information, see License metadata property types.

    • IPC_MD_CONTENT_PATHIPC_MD_CONTENT_PATH

      Permet d’identifier le document faisant l’objet d’un suivi.Use to identify the tracked document. S’il est impossible de fournir un chemin complet, indiquez simplement le nom du fichier.In cases where a full path is not possible, just provide the file name.

    • IPC_MD_CONTENT_NAMEIPC_MD_CONTENT_NAME

      Permet d’identifier le nom du document faisant l’objet d’un suivi.Use to identify the tracked document name.

    • IPC_MD_NOTIFICATION_TYPEIPC_MD_NOTIFICATION_TYPE

      Permet d’indiquer quand la notification est envoyée.Use to specify when notification will be sent. Pour plus d’informations, consultez Type de notification.For more information, see Notification type.

    • IPC_MD_NOTIFICATION_PREFERENCEIPC_MD_NOTIFICATION_PREFERENCE

      Permet d’indiquer le type de notification.Use to specify the type of notification. Pour plus d’informations, consultez Préférence de notification.For more information, see Notification preference.

    • IPC_MD_DATE_MODIFIEDIPC_MD_DATE_MODIFIED

      Nous vous suggérons de définir cette date chaque fois que l’utilisateur clique sur Enregistrer.We suggest that you set this date each time the user clicks Save.

    • IPC_MD_DATE_CREATEDIPC_MD_DATE_CREATED

      Permet de définir la date de création du fichier.Use to set the origination date of the file

  • IpcSerializeLicenseWithMetadataIpcSerializeLicenseWithMetadata

Utilisez l’API appropriée parmi celles-ci pour ajouter les métadonnées à votre fichier ou flux.Use the appropriate one of these APIs to add the metadata to your file or stream.

Enfin, utilisez cette API pour inscrire votre document faisant l’objet d’un suivi auprès du système de suivi.Lastly, use this API to register your tracked document with the tracking system.

2. Inscrire le document auprès du service RMS2. Register the document with the RMS service

Voici un exemple d’extrait de code illustrant la définition des métadonnées de suivi de document et l’appel utilisé pour inscrire le document auprès du système de suivi.Here's a code snippet showing an example of setting document tracking metadata and the call to register with the tracking system.

  C++
  HRESULT hr = S_OK;
  LPCWSTR wszOutputFile = NULL;
  wstring wszWorkingFile;
  IPC_LICENSE_METADATA md = {0};

  md.cbSize = sizeof(IPC_LICENSE_METADATA);
  md.dwNotificationType = IPCD_CT_NOTIFICATION_TYPE_ENABLED;
  md.dwNotificationPreference = IPCD_CT_NOTIFICATION_PREF_DIGEST;
  //file origination date, current time for this example
  md.ftDateCreated = GetCurrentTime();
  md.ftDateModified = GetCurrentTime();

  LOGSTATUS_EX(L"Encrypt file with official template...");

  hr =IpcfEncryptFileWithMetadata( wszWorkingFile.c_str(),
                           m_wszTestTemplateID.c_str(),
                           IPCF_EF_TEMPLATE_ID,
                           0,
                           NULL,
                           NULL,
                           &md,
                           &wszOutputFile);

 /* This will contain the serialized license */
 PIPC_BUFFER pSerializedLicense;

 /* the context to use for the call */
 PCIPC_PROMPT_CTX pContext;

 wstring wstrContentName(“MyDocument.txt”);
 bool sendLicenseRegistrationNotificationEmail = FALSE;

 hr = IpcRegisterLicense( pSerializedLicense,
                    0,
                    pContext,
                    wstrContentName.c_str(),
                    sendLicenseRegistrationNotificationEmail);

Ajouter un bouton Suivre l’utilisation à votre applicationAdd a Track Usage button to your app

Ajouter un élément d’interface utilisateur Suivre l’utilisation à votre application est aussi simple qu’utiliser l’un des formats d’URL suivants :Adding a Track Usage UI item to your app is as simple as using one of the following URL formats:

  • Utilisation de l’ID de contenuUsing Content ID

    • Obtenez l’ID de contenu à l’aide de IpcGetLicenseProperty ou IpcGetSerializedLicenseProperty si la licence est sérialisée et utilisez la propriété de licence IPC_LI_CONTENT_ID.Get the content ID by using IpcGetLicenseProperty or IpcGetSerializedLicenseProperty if the license is serialized and use the license property IPC_LI_CONTENT_ID. Pour plus d’informations, consultez Types de propriété de licence.For more information, see License property types.
    • Avec les métadonnées ContentId et Issuer, utilisez le format suivant : https://track.azurerms.com/#/{ContentId}/{Issuer}With the ContentId and Issuer metadata, use the following format: https://track.azurerms.com/#/{ContentId}/{Issuer}

      Exemple : https://track.azurerms.com/#/summary/05405df5-8ad6-4905-9f15-fc2ecbd8d0f7/janedoe@microsoft.comExample - https://track.azurerms.com/#/summary/05405df5-8ad6-4905-9f15-fc2ecbd8d0f7/janedoe@microsoft.com

  • Si vous n’avez pas accès à ces métadonnées (par exemple, si vous examinez la version non protégée du document), vous pouvez utiliser Content_Name au format suivant : https://track.azurerms.com/#/?q={ContentName}If you don’t have access to that metadata (i.e. you are examining the unprotected version of the document), you can use the Content_Name in the following format: https://track.azurerms.com/#/?q={ContentName}

    Exemple : https://track.azurerms.com/#/?q=Secret!.txtExample - https://track.azurerms.com/#/?q=Secret!.txt

Le client doit simplement ouvrir un navigateur avec l’URL appropriée.The client simply needs to open a browser with the appropriate URL. Le portail de suivi des documents RMS gère l’authentification et toute redirection requise.The RMS Document Tracking portal will handle authentication and any required redirection.

Rubriques connexesRelated topics

CommentairesComments

Avant de transmettre vos commentaires, nous vous demandons de consulter notre règlement interne.Before commenting, we ask that you review our House rules.