A fact allows you to trace an action performed on a component and thus provide a component history.

Factual information

The facts are made up of several pieces of information that allow us to identify the precise action performed and its context.

Object identification

The object on which a fact took place can be identified from the object type and its identifier.

Context

In order to provide information on the context in which a fact took place, several types of information are available:

The actions (see

Action) supported for facts are:

• CREATE: Component creation
• UPDATE: Component update
• VERSION: Creating a component version
• ASSIGN: Assignment of a task to a user
• ADD_CONTENT: Adding an attachment to tasks, adding or updating content for documents and adding components to a folder
• DELETE_CONTENT: Deleting an attachment to tasks, deleting content for documents and deleting components to a folder
• REVERT: Restores a version of a document

Additional fields

In addition to information natively stored in the facts, additional fields can be stored (or simply displayed) using

ResultField.

var fact = new Fact();
var field = new ResultField();
field.setName("RefClient");
field.setValue("1234");
fact.addUpdatedField(field)

Add facts

In certain business contexts, it may be necessary to build your own facts. To do this, several functions are available for this purpose:

To add new facts, it is first necessary to obtain a fact instance with one of the following constructors:

To modify a component’s history, you need to subscribe to the history opening feature:

    var factAPI = JSAPI.get().getHelperFactory().getFactAPI();  
    factAPI.register(component.getId(), function(facts, callback){
		//Manipulate facts of component
   });

The facts array provided as input to the subscription contains the facts determined natively by the application. In order to modify the facts displayed to users, it is necessary to provide a modified array to the callback provided:

    var factAPI = JSAPI.get().getHelperFactory().getFactAPI();  
    factAPI.register(component.getId(), function(facts, callback){
    	var processed = new Array();
		callback.onProcessed(processed);
   });

JSAPI.get().registerForComponentChange(function(componentFormAPI, component, phase) {        
	var factAPI = JSAPI.get().getHelperFactory().getFactAPI();
	factAPI.register(component.getId(), function(facts, callback){
		var fact1 = new Fact(component);
		var date1 = new Date("January 15, 2017 1100");
		fact1.setUser(JSAPI.get().getUserAPI().getUserId());
		fact1.setCreationDate(date1.getTime());
		fact1.setAction("UPDATE");
		var field1 = new ResultField();
		field1.setName("RefClient");
		field1.setValue("2018-01-01 1207.006 +0100");
		fact1.addUpdatedField(field1);

		var fact2 = new Fact(component);
		var date2 = new Date("January 16, 2017 1100");
		fact2.setCreationDate(date2.getTime());
		fact2.setDescription("Description for fact2");

		facts.push(fact1);		
		facts.push(fact2);
		callback.onProcessed(facts);
	});
});