Deleting Documents

Deleting 2D Documents

Pre-requisites

The class library must be configured to include a Document Register that accepts an Action column and include a DeleteWhere clause. For example:

The scraped tag Discovery register must be configured with the following properties:

• RegisterType="Secondary"

• Category="Docs"

• IDColumn="DocumentId"

• DeleteWhere="{{ @ReferencedId.isUnset }}"

  

Considerations When Deleing 2D Documents

When processing 2D Documents via a Document Register, delete in the Action column deletes the document, any associated files and any associations to scraped tags. The scraped tags are deleted as well, unless they were loaded from another register.

The delete process is a synchronous action. If documents are requested to be deleted prior to a current delete request completing, the new request will be queued until the current delete finishes. This avoids any data discrepancy.

Only associations to tags scraped during the initial ingestion will be removed as part of the file deletion. If additional document-to-tag or reference data associations are loaded from a register other than the scraping (discovery) or main document register, they should be manually cleaned up using the standard deletion process by applying the DeleteWhere condition and ingesting the data with a deletion flag.

If a Document is referenced in multiple Registers, the delete action still means all files associated with the Document will be deleted, but a reference to the Document object will remain in the EIWM generated. References to the Document in the other registers must be manually cleaned up to fully remove the Document object.

For the case where two files are associated to a document and one is still required, then the required file will need to be republished after the deletion is completed.

Cleanup of Files Associated to Unclassified Objects

An automated process is scheduled to cleanup and delete any Files associated with unclassified/unknown objects.

The process will execute every Sunday 03:00 UTC to minimize any impact.

Files will be deleted in batches of 50,000 per week.

Files must meet the following criteria to be marked for deletion through this automated process:

• File must be older than 60 days.

• File must only be associated with unclassified objects. A file associated with an unclassified object and a classified object will not be deleted.

Files deleted via this process will display in the Load Reporting Delete Files tab as a System Delete to differentiate from user driven deletes. For more information see View Reports by Files.

Deleting 3D Models

The process to delete 3D models involves loading files into the AVEVA Data Pipeline following the standard method, but with a key difference: instead of uploading a 3D model file, a CSV file is uploaded. This CSV file contains the file names of the 3D models to be deleted.

The other difference in this process is the use of the “action":"delete" parameter, which is exclusively used for deleting 3D model files. This parameter is specified in the Upload URL API call, along with the dependent parameters ("fileName": "{filename}.csv" and "target": "Model"). See Ingestion API Request Parameters for more information.

Note: Deleting 3D models is not supported using the AVEVA Document Connector. Any CSV files uploaded through the Document Connector that have Target: Model will not be processed.

The CSV File for 3D Model Deletion

The CSV file used for specifying the 3D models to be deleted must adhere to the following guidelines:

• The CSV file should contain a column with the file names of the 3D models along with their extensions.

• It must include a header called File Names.

• The extensions of the file names in the column should correspond to valid 3D model file formats.

An example CSV file:

File Names

Model1.rvm

Model2.zgl

Loading the CSV into the Data Pipeline

The process of loading the CSV (that describes which 3D files to delete) involves three API calls: Init API, Upload URL API, and Complete API. The key difference, when deleting 3D files, is in the request body for the Upload URL API, which includes the action parameter. See Using the Ingestion API for more information on using Postman.

Init API

The process for this call remains unchanged from the standard process.

Upload URL API

• This step uploads your prepared CSV file to the cloud.

• There are specific parameters that must be specified in the request body for 3D model deletion.

• The remaining process for this call remains unchanged from the standard process (to PUT the file into the upload URL).

Request Body

When deleting a 3D model, the body of the Upload URL request must include specific parameters to ensure the process is correctly executed. These parameters are essential for the orchestration to identify and process the deletion of 3D models. See Ingestion API Request Parameters for an example request body.

Required Parameters

• action: This parameter must be set to 'delete'. It indicates that the request is for deleting 3D models.

  • Example: "action": "delete"

  • The value ‘delete’ must be in lowercase.

• fileName: This parameter must be set to the name of your prepared CSV file (including the .csv extension).

  • Example: "fileName": "myfiles.csv"

• target: This parameter must be set to "Model". It specifies that the target of the deletion action is a 3D model.

  • Example: "target": "Model"

Error Handling

• Incorrect Target

  • Error: "Delete action is currently only supported for Models."

  • Cause: action is set to delete, but target is not set to Model.

• Incorrect File Type

  • Error: "Model delete currently only supports csv files."

  • Cause: action is set to delete, but fileName is not a CSV file.

• Incorrect Action Value

  • Error: "Missing required parameters."

  • Cause: action is present but its value is not delete.

Complete API

The process for this call remains unchanged from the standard process.