Nasıl yapılır: Belge izleme ve iptal etmeyi etkinleştirmeHow-to: enable document tracking and revocation

Bu konu başlığı altında, içeriklerde belge izleme işlemi uygulamaya ilişkin temel yönergelerin yanı sıra meta veri güncelleştirmeleri ve uygulamanız için bir Kullanımı İzle düğmesi oluşturmaya yönelik örnek kod yer almaktadır.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.

Belge izlemeyi uygulamaya yönelik adımlarSteps to implement document tracking

Adım 1 ve adım 2 belgenin izlenmesini sağlar.Steps 1 and 2 enable the document to be tracked. Adım 3, korunan belgelerinizi izlemek ve iptal etmek için uygulama kullanıcılarınızın belge izleme sitesine ulaşmasını sağlar.Step 3 enables your app users to reach the document tracking site in order to track and revoke your protected documents.

  1. Belge izleme meta verileri eklemeAdd document tracking metadata
  2. Belgeyi RMS hizmetine kaydetmeRegister the document with the RMS service
  3. Uygulamanıza Kullanımı İzle düğmesi eklemeAdd Track Usage button to your app

Bu adımların uygulanmasına ilişkin ayrıntılar aşağıdadır.The implementation details for these steps follow.

1. Belge izleme meta verileri ekleme1. Add document tracking metadata

Belge izleme Hak Yönetimi sisteminin bir özelliğidir.Document tracking is a feature of the Rights Management system. Belge koruma işlemi sırasında belirli meta veriler ekleyerek, bir belge sonrasında izleme için çeşitli seçenekler sağlayan izleme hizmeti portalına kaydedilebilir.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.

Belge izleme meta verileri içeren bir içeriği eklemek/güncelleştirmek için bu API'leri kullanın.Use these APIs to add/update a content license with document tracking metadata.

İşletimsel olarak, belge izleme için yalnızca içerik adı ve bildirim türü özellikleri gereklidir.Operationally, only the content name and the notification type properties are required for document tracking.

  • IpcCreateLicenseMetadataHandleIpcCreateLicenseMetadataHandle

  • IpcSetLicenseMetadataPropertyIpcSetLicenseMetadataProperty

    Tüm meta veri özelliklerini ayarlayacağınızı umuyoruz.We expect that you will set all of the metadata properties. Bunlar, aşağıda türe göre listelenmektedir.Here they are, listed by type.

    Daha fazla bilgi için bkz. Lisans meta verilerinin özellik türleri.For more information, see License metadata property types.

    • IPC_MD_CONTENT_PATHIPC_MD_CONTENT_PATH

      İzlenen belgeyi tanımlamak için bunu kullanın.Use to identify the tracked document. Tam yolun mümkün olmaması durumunda, yalnızca dosya adını belirtin.In cases where a full path is not possible, just provide the file name.

    • IPC_MD_CONTENT_NAMEIPC_MD_CONTENT_NAME

      İzlenen belgenin adını tanımlamak için bunu kullanın.Use to identify the tracked document name.

    • IPC_MD_NOTIFICATION_TYPEIPC_MD_NOTIFICATION_TYPE

      Ne zaman bildirim gönderileceğini belirtmek için bunu kullanın.Use to specify when notification will be sent. Daha fazla bilgi için bkz. Bildirim türü.For more information, see Notification type.

    • IPC_MD_NOTIFICATION_PREFERENCEIPC_MD_NOTIFICATION_PREFERENCE

      Bildirim türünü belirtmek için bunu kullanın.Use to specify the type of notification. Daha fazla bilgi için bkz. Bildirim tercihi.For more information, see Notification preference.

    • IPC_MD_DATE_MODIFIEDIPC_MD_DATE_MODIFIED

      Kullanıcı Kaydet’e her tıkladığında bu tarihi ayarlamanızı öneririz.We suggest that you set this date each time the user clicks Save.

    • IPC_MD_DATE_CREATEDIPC_MD_DATE_CREATED

      Dosyanın oluşturulma tarihini ayarlamak için bunu kullanın.Use to set the origination date of the file

  • IpcSerializeLicenseWithMetadataIpcSerializeLicenseWithMetadata

Meta verileri, dosya veya akışınıza eklemek için bu API'lerden uygun olanı kullanın.Use the appropriate one of these APIs to add the metadata to your file or stream.

Son olarak, izlenen belgenizi izleme sistemine kaydetmek için bu API’yi kullanın.Lastly, use this API to register your tracked document with the tracking system.

2. Belgeyi RMS hizmetine kaydetme2. Register the document with the RMS service

Belge izleme meta verileri ayarlama ve izleme sistemine kayıt için çağrı örneğini gösteren bir kod parçacığı aşağıda verilmiştir.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);

Uygulamanıza Kullanımı İzle düğmesi eklemeAdd a Track Usage button to your app

Uygulamanıza bir Kullanımı İzle kullanıcı arabirimi öğesi eklemek için aşağıdaki URL biçimlerinden birini kullanmanız yeterlidir:Adding a Track Usage UI item to your app is as simple as using one of the following URL formats:

  • İçerik Kimliğini KullanmaUsing Content ID

    • IpcGetLicenseProperty lisans özelliğini veya lisans serileştirilmişse IpcGetSerializedLicenseProperty biçimini kullanarak ve IPC_LI_CONTENT_ID ile içerik kimliğini alın.Get the content ID by using IpcGetLicenseProperty or IpcGetSerializedLicenseProperty if the license is serialized and use the license property IPC_LI_CONTENT_ID. Daha fazla bilgi için bkz. Lisans özelliği türleri.For more information, see License property types.

    • ContentId ve Issuer meta verilerinde aşağıdaki biçimi kullanın: https://track.azurerms.com/#/{ContentId}/{Issuer}With the ContentId and Issuer metadata, use the following format: https://track.azurerms.com/#/{ContentId}/{Issuer}

      Örnek - 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

  • Bu meta verilere erişiminiz yoksa (yani belgenin korumasız sürümünü inceliyorsanız) Content_Name öğesini aşağıdaki biçimde kullanabilirsiniz: 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}

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

İstemcinin yalnızca uygun URL’yi kullanarak bir tarayıcı açması gerekir.The client simply needs to open a browser with the appropriate URL. RMS Belge İzleme portalı, kimlik doğrulamayı ve gerekli tüm yönlendirmeleri yapar.The RMS Document Tracking portal will handle authentication and any required redirection.