Find Risks in a PDF

Overview

The typical process is:

  • Step 1: Create an Asset
  • Step 2: Create Categorisation
  • Step 3: Create a Review

Step 1: Create an Asset

Defintion

An Asset is a file that can be Reviewed. While typically a .pdf, Red Marker also supports .doc, .docx and many other common file types.

Process

The process of adding an Asset to Red Marker involves 2 steps.

  • Create an upload placeholder
  • Send the binary data

asset

Step 2: Create Categorisation

Defintion

A Categorisation is a series of questions and answers that needs to be answered to determine which Rules to use when Reviwing an Asset. Typically Categorisation is completed by a User and contains multiple questions or Categories.

As an example; one question could be 'Which channel?', and user needs to select from three options; Email, Mail, Online.

In this example; 'Which channel?' is the Category, and 'Email', 'Mail', 'Online' are are various Options.

Process

The client will instigate a new Categorisation entry and send back their selections for each Category. The response for the Categorisation will include details on the Categories and available options for each one. It is up to the client to send back the selected options for each category.

You will be responsible for adding an Asset and a Categorisation to Red Marker. These can be added in any order and can be reused between Reviews.

The response structure is detailed here.

asset

Step 3: Create a Review

Defintion

A Review is when Red Marker scan an Asset for risky content using Rules. For example, scanning a Marketing Brochure for risk.

Process

To initiate a Review, you will send a previously created Asset and (optionally) Categorisation to /reviews. Once created, you will use the Review ID to poll for details on the status and to retrieve any Review Rules which have been discovered.

A Review needs an Asset

To create the Review you need to supply an Asset by its ID then poll the Review for its status and details on the Issues we may discover for review.

asset

Step 4: Update Review Rules

Defintion

A Review Rule is a representation of a Rule that has been triggered as part of a Review. They may have zero or more Triggers that define where in the Asset and why the Rule was triggered.

Process

Once the Review Rules are available; it is possible to update their status individually.

asset