Ejemplos

Establecer política de retención de datos para historial de campos

Este ejemplo demuestra el modo de establecer una política de retención de datos de historial de campos utilizando la API de metadatos. De forma predeterminada, los datos del historial de campo no se eliminan automáticamente. Modifique los metadatos solo si desea anular los valores de política predeterminados de 18 meses de almacenamiento de producción. El establecimiento de una política de retención de datos lleva aparejado la creación de un paquete de metadatos e implementarlo. El paquete está compuesto de un archivo .zip y un manifiesto de proyecto que enumera los objetos y la versión de API que hay que utilizar. El archivo .zip contiene una carpeta objects con el XML que define la política de retención de cada objeto.

Nota La primera copia escribe el historial de campos completo definido por su política para archivar el almacenamiento y tarda mucho tiempo. Las copias siguientes solo transfieren los cambios desde la última copia y son más rápidas.

Defina una política de retención de datos de historial de campos para cada objeto. La política especifica el número de meses que desea mantener el historial de campos en Salesforce. El siguiente archivo de ejemplo define una política para archivar el objeto tras seis meses.

<?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>

El nombre de archivo determina el objeto al que se aplica la política. Por ejemplo, para aplicar la política precedente al objeto Cuenta, guarde el archivo como Account.object. Para objetos personalizados existentes, el archivo también se denomina tras el objeto personalizado. Por ejemplo: myObject__c.object.

Cree el manifiesto de proyecto, que es un archivo XML denominado package.xml. El siguiente archivo de ejemplo enumera varios objetos para los que hay que aplicar una política de retención de datos. Con este archivo de manifiesto, espera que la carpeta de objetos contenga cinco archivos: Account.object, Case.object, etc.

<?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>

Cree el archivo .zip y utilice la función deploy() para implementar sus cambios en su entorno de producción. Para obtener más información, consulte la Guía de la API de metadatos.

Nota Esta característica no admite la implementación desde entornos de sandbox a entornos de producción.

¡Eso es todo! Su política de retención de historial de campos entra en vigor según los periodos de tiempo que establezca.

Crear un objeto personalizado y establecer una política de retención de historial de campos al mismo tiempo

<?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>

Establezca trackHistory en true en los campos que desea seguir y false en los otros campos.

Actualizar política de retención de datos para historial de campos

Si la política de retención de datos del historial de campo ya está definida en un objeto, puede actualizar la política especificando un nuevo valor HistoryRetentionPolicy en los metadatos de ese objeto. Cuando se implementan los cambios de metadatos, la nueva política sustituye a la anterior.

Nota Para comprobar la política de retención de datos actual para cualquier objeto, recupere sus metadatos utilizando API de metadatos y busque el valor HistoryRetentionPolicy.

Consultar datos archivados

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