Postupy: Povolení sledování a odvolání dokumentůHow-to: enable document tracking and revocation

Toto téma obsahuje základní pokyny pro implementaci sledování obsahu dokumentů a také ukázkový kód pro aktualizace metadat a pro vytvoření tlačítka Sledovat využití pro vaši aplikaci.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.

Kroky pro implementaci sledování dokumentůSteps to implement document tracking

Kroky 1 a 2 povolí sledování příslušného dokumentu.Steps 1 and 2 enable the document to be tracked. Krok 3 umožní uživatelům aplikace přejít na web pro sledování dokumentů, sledovat chráněné dokumenty a odvolat přístup k nim.Step 3 enables your app users to reach the document tracking site in order to track and revoke your protected documents.

  1. Přidání metadat pro sledování dokumentůAdd document tracking metadata
  2. Registrace dokumentu pomocí služby RMSRegister the document with the RMS service
  3. Přidání tlačítka Sledovat využití do aplikaceAdd Track Usage button to your app

Dál jsou uvedené podrobnosti o implementaci těchto kroků.The implementation details for these steps follow.

1. Přidání metadat pro sledování dokumentů1. Add document tracking metadata

Sledování dokumentů je jednou z funkcí systému Rights Management.Document tracking is a feature of the Rights Management system. Přidáním konkrétních metadat během procesu ochrany dokumentu lze dokument zaregistrovat u portálu služby sledování, který poté poskytne několik možností sledování.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.

Chcete-li přidat/aktualizovat licence k obsahu pomocí metadat pro sledování dokumentů, použijte tato rozhraní API.Use these APIs to add/update a content license with document tracking metadata.

Z provozního hlediska jsou ke sledování dokumentů potřeba jen vlastnosti název obsahu a typ oznámení.Operationally, only the content name and the notification type properties are required for document tracking.

  • IpcCreateLicenseMetadataHandleIpcCreateLicenseMetadataHandle
  • IpcSetLicenseMetadataPropertyIpcSetLicenseMetadataProperty

    Předpokládáme, že nastavíte všechny vlastnosti metadat.We expect that you will set all of the metadata properties. Zde je uveden jejich výčet seřazený podle typu.Here they are, listed by type.

    Další informace najdete v tématu Typy vlastností metadat licence.For more information, see License metadata property types.

    • IPC_MD_CONTENT_PATHIPC_MD_CONTENT_PATH

      Tato vlastnost slouží k identifikaci sledovaného dokumentu.Use to identify the tracked document. V případech, kdy nelze uvést úplnou cestu, stačí zadat název souboru.In cases where a full path is not possible, just provide the file name.

    • IPC_MD_CONTENT_NAMEIPC_MD_CONTENT_NAME

      Tato vlastnost slouží k identifikaci názvu sledovaného dokumentu.Use to identify the tracked document name.

    • IPC_MD_NOTIFICATION_TYPEIPC_MD_NOTIFICATION_TYPE

      Tato vlastnost určuje, kdy bude odesláno oznámení.Use to specify when notification will be sent. Další informace najdete v tématu Typ oznámení.For more information, see Notification type.

    • IPC_MD_NOTIFICATION_PREFERENCEIPC_MD_NOTIFICATION_PREFERENCE

      Tato vlastnost slouží k zadání typu oznámení.Use to specify the type of notification. Další informace najdete v tématu Předvolby oznamování.For more information, see Notification preference.

    • IPC_MD_DATE_MODIFIEDIPC_MD_DATE_MODIFIED

      Toto datum doporučujeme nastavit vždy, když uživatel klikne na Uložit.We suggest that you set this date each time the user clicks Save.

    • IPC_MD_DATE_CREATEDIPC_MD_DATE_CREATED

      Slouží k nastavení data vzniku souboru.Use to set the origination date of the file

  • IpcSerializeLicenseWithMetadataIpcSerializeLicenseWithMetadata

Chcete-li přidat metadata do souboru nebo datového proudu, použijte příslušné rozhraní z těchto rozhraní API.Use the appropriate one of these APIs to add the metadata to your file or stream.

A konečně, toto rozhraní API použijte k registraci sledovaného dokumentu v systému pro sledování.Lastly, use this API to register your tracked document with the tracking system.

2. Registrace dokumentu pomocí služby RMS2. Register the document with the RMS service

Zde je fragment kódu, který ukazuje příklad nastavení metadat pro sledování dokumentu a volání k registraci v systému pro sledování.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);

Přidání tlačítka Sledovat využití do aplikaceAdd a Track Usage button to your app

K přidání položky Sledovat využití do uživatelského rozhraní aplikace stačí použít jeden z následujících formátů URL:Adding a Track Usage UI item to your app is as simple as using one of the following URL formats:

  • Použití ID obsahuUsing Content ID

    • K získání ID obsahu použijte IpcGetLicenseProperty nebo IpcGetSerializedLicenseProperty (pokud je licence serializovaná) a potom použijte vlastnost 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. Další informace najdete v tématu Typy vlastností licence.For more information, see License property types.
    • Pro metadata ContentId a Issuer použijte následující formát: https://track.azurerms.com/#/{ContentId}/{Issuer}With the ContentId and Issuer metadata, use the following format: https://track.azurerms.com/#/{ContentId}/{Issuer}

      Příklad: 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

  • Pokud k těmto metadatům nemáte přístup (to znamená, že zkoumáte nechráněnou verzi dokumentu), můžete použít Content_Name v následujícím formátu: 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}

    Příklad: https://track.azurerms.com/#/?q=Secret!.txtExample - https://track.azurerms.com/#/?q=Secret!.txt

Stačí, když klient jednoduše otevře prohlížeč s příslušnou adresou URL.The client simply needs to open a browser with the appropriate URL. Portál pro sledování dokumentů RMS zajistí ověření a případná požadovaná přesměrování.The RMS Document Tracking portal will handle authentication and any required redirection.

KomentářeComments

Před přidáním komentáře se podívejte na naše pravidla organizace.Before commenting, we ask that you review our House rules.