Beispiele

Festlegen einer Datenaufbewahrungsrichtlinie für den Feldverlauf

In diesem Beispiel wird gezeigt, wie Sie eine Datenaufbewahrungsrichtlinie für den Feldverlauf mithilfe der Metadaten-API festlegen können. Feldverlaufsdaten werden standardmäßig nicht automatisch gelöscht. Bearbeiten Sie die Metadaten nur dann, wenn Sie die standardmäßigen Richtlinienwerte für die Speicherung in der Produktion von 18 Monaten überschreiben möchten. Das Festlegen einer Datenaufbewahrungsrichtlinie beinhaltet die Erstellung und Bereitstellung eines Metadatenpakets. Das Paket besteht aus einer .zip-Datei und einem Projektmanifest, in dem die Objekte und die API-Version aufgelistet sind, die verwendet werden müssen. Die .zip-Datei enthält einen objects-Ordner mit der XML-Datei, in der die Aufbewahrungsrichtlinie für die jeweiligen Objekte definiert wird.

Hinweis Die erste Kopie speichert den gesamten durch Ihre Richtlinie definierten Feldverlauf im Archivspeicher, was viel Zeit in Anspruch nimmt. Bei nachfolgenden Kopien werden nur die Änderungen seit der letzten Kopie übertragen. Sie nehmen weniger Zeit in Anspruch.

Definieren Sie eine Datenaufbewahrungsrichtlinie für den Feldverlauf für jedes einzelne Objekt. Die Richtlinie gibt die Anzahl der Monate an, für die Sie den Feldverlauf in Salesforce beibehalten möchten. Die folgende Beispieldatei definiert eine Richtlinie zur Archivierung des Objekts nach sechs Monaten.

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
   <historyRetentionPolicy>
       <archiveAfterMonths>6</archiveAfterMonths>
       <archiveRetentionYears>5</archiveRetentionYears>
       <description>My field history retention</description>
   </historyRetentionPolicy>

...
</CustomObject>

Im Dateinamen ist das Objekt angegeben, auf das die Richtlinie angewendet wird. Wenn Sie die oben angegebene Richtlinie beispielsweise auf das Account-Objekt anwenden möchten, speichern Sie die Datei unter dem Namen Account.object. Bei vorhandenen benutzerdefinierten Objekten ist die Datei ebenfalls nach dem benutzerdefinierten Objekt benannt. Beispiel: myObject__c.object hinzu.

Erstellen Sie das Projektmanifest. Dabei handelt es sich um eine Datei mit dem Namen package.xml. In der folgenden Beispieldatei werden mehrere Objekte aufgelistet, auf die die Datenaufbewahrungsrichtlinie angewendet werden soll. Aufgrund dieser Manifestdatei sollte der Objektordner erwartungsgemäß fünf Dateien enthalten: Account.object, Case.object usw.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Account</members>
        <members>Case</members>
        <members>Contact</members>
        <members>Lead</members>
        <members>Opportunity</members>
        <name>CustomObject</name>
    </types>
    <version>45.0</version>
</Package>

Erstellen Sie die .zip-Datei und verwenden Sie die Funktion deploy(), um Ihre Änderungen in Ihrer Produktionsumgebung bereitzustellen. Weitere Informationen finden Sie im Metadata API Guide.

Hinweis Von dieser Funktion wird die Bereitstellung aus einer Sandbox-Umgebung in Produktionsumgebungen nicht unterstützt.

Geschafft. Ihre Aufbewahrungsrichtlinie für den Feldverlauf wird entsprechend den von Ihnen festgelegten Zeiträumen wirksam.

Gleichzeitiges Erstellen von benutzerdefinierten Objekten und Festlegen einer Datenaufbewahrungsrichtlinie für den Feldverlauf

<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <deploymentStatus>Deployed</deploymentStatus>
    <enableHistory>true</enableHistory>
    <description>just a test object with one field for eclipse ide testing</description>
    <historyRetentionPolicy>
        <archiveAfterMonths>3</archiveAfterMonths>
        <archiveRetentionYears>10</archiveRetentionYears>
        <gracePeriodDays>1</gracePeriodDays>
        <description>Transaction Line History</description>
    </historyRetentionPolicy>
    <fields>
        <fullName>Comments__c</fullName>
        <description>add your comments about this object here</description>
        <inlineHelpText>This field contains comments made about this object</inlineHelpText>
        <label>Comments</label>
        <length>32000</length>
        <trackHistory>true</trackHistory>
        <type>LongTextArea</type>
        <visibleLines>30</visibleLines>
    </fields>
    <label>MyFirstObject</label>
    <nameField>
        <label>MyFirstObject Name</label>
        <type>Text</type>
    </nameField>
    <pluralLabel>MyFirstObjects</pluralLabel>
    <sharingModel>ReadWrite</sharingModel>
</CustomObject>

Setzen Sie für Felder, für die die Verfolgung aktiviert werden soll, trackHistory auf true. Setzen Sie den Wert für die anderen Felder auf false.

Aktualisieren einer Datenaufbewahrungsrichtlinie für den Feldverlauf

Wenn für ein Objekt bereits eine Datenaufbewahrungsrichtlinie für den Feldverlauf definiert wurde, können Sie die Richtlinie aktualisieren, indem Sie einen neuen Wert für HistoryRetentionPolicy in den Metadaten des betreffenden Objekts angeben. Nach der Bereitstellung der Metadatenänderungen wird die vorherige Richtlinie durch die neue Richtlinie überschrieben.

Hinweis Rufen Sie die Metadaten eines beliebigen Objekts ab, um die zugehörige Datenaufbewahrungsrichtlinie zu überprüfen. Verwenden Sie hierzu die Metadaten-API und schlagen Sie den Wert für HistoryRetentionPolicy nach.

Abfragen archivierter Daten

SELECT ParentId, FieldHistoryType, Field, Id, NewValue, OldValue FROM FieldHistoryArchive WHERE FieldHistoryType = 'Account' AND ParentId='001D000000INjVe'