Trace details

Each change to a business object such as a project or a job is logged with date, type of change and details on changed values. A single change is called a "trace". Each trace is serialized as a JSON object.

TRACE CONTENT

Each trace is a JSON object with these properties:

dt

UTC date and time when this transaction was written to the log.

datetime
uid

The user who triggered the action in the first place. Null if change was triggered by the system.

NOTE: This field is only populated in some cases for the time being.

int?
cidThe company to which the user belongs. Null if change was triggered by the system.int?
   
 Grouping of traces 
ts

A globally unique identifier which permits to group related traces.

For example if an operation updates three different objects in the framework of an operation then all three traces share the same ts value.

string
tsc

An English description of the user interface or system operation attached to ts.

Examples: "Job status change", "Batch deletion of jobs", "Submission of order"...

NOTE: This field is only populated in some cases for the time being.

string?
   
 Changed object 
oc

Uniquely identifies the type of object being traced.

For example:

  • o: Order
  • jc: Codyt Job
  • js: Standard job
  • ps: Person/User
  • ...

See Traces for all objects.


 
key

The unique key of the changed object. This may be a composite key.

Example of a company change (object "c"):

key: { "cid": 1000 }

Example of a standard job document change (object "jsd"):

key: { "js": "s9928", "did": 88372 }

See list of objects and their keys

 

object
   
 

Change details

string
aType of action:
  • "d": Deletion
  • "i": Insertion
  • "c": Change
string
fld

The data fields. Each element contains a changed field.

Example:

[
	{ "f": "Reference", "v": "New reference 1", "p": "Old reference" },
	{ "f": "Status_", "v": 3, "p": 2 }
]

Notes:

  • With deletions the fld property is always empty
  • Fields with null-values are not listed

 

object[]
vThe used field names may undergo changes or extensions over time. This is the field dictionary version of the present trace.int

 

The fld array contains elements of this type:

f

The field being changed.

string 
v

The value of the field after the change.

The type of the value may be numeric, string, a JSON array or a JSON object

Field specific type
pPrevious value, if applicable.Field specific type

 

BUSINESS OBJECTS

The following is the list of business objects for which we log changes.

Click to view: Traces


EXAMPLE

A few sample traces: 

[ 
{
	"v": 1,
	"a": "i",
	"oc": "ps",
	"key": {
		"uid": 138
	},
	"dt": "2017-07-10T16:18:53.6961066Z",
	"uid": 1,
	"cid": 1,
	"ts": "0ec12110-50c9-4c60-927e-3a250eea5ccf",
	"tsc": "new account",
	"flds": [{
			"f": "RssNotifications",
			"v": "Personal"
		}, {
			"f": "EmailNotifications",
			"v": "Personal"
		}, {
			"f": "NotifyOrders",
			"v": "Personal"
		}, {
			"f": "NotifyJobs",
			"v": "Personal"
		}, {
			"f": "PersonId",
			"v": "0"
		}, {
			"f": "AddressId",
			"v": "1"
		}, {
			"f": "FirstName",
			"v": "creation"
		}, {
			"f": "LastName",
			"v": "test"
		}, {
			"f": "Email",
			"v": "cpons@wordbee.com"
		}, {
			"f": "PersonCode",
			"v": "ct"
		}, {
			"f": "RssNotifications_",
			"v": "1"
		}, {
			"f": "EmailNotifications_",
			"v": "1"
		}, {
			"f": "IsActive",
			"v": "False"
		}, {
			"f": "LoginAttempts",
			"v": "0"
		}, {
			"f": "Password",
			"v": "*****"
		}, {
			"f": "PwdDate",
			"v": "10/07/2017 16:18:51"
		}, {
			"f": "NotifyOrders_",
			"v": "0"
		}, {
			"f": "NotifyJobs_",
			"v": "0"
		}
	]
}, {
	"v": 1,
	"a": "c",
	"oc": "ps",
	"key": {
		"uid": 138
	},
	"dt": "2017-07-10T16:19:36.6244773Z",
	"ts": "79a5aa40-b302-44ff-baaf-71d88b4c67fd",
	"flds": [{
			"f": "PersonCode",
			"v": "cao",
			"p": "ct"
		}
	]
}, 
{
	"v": 1,
	"a": "d",
	"oc": "ps",
	"key": {
		"uid": 138
	},
	"dt": "2017-07-10T16:19:46.7389286Z",
	"ts": "313b163f-211c-41d4-bd0e-35496b560fe8",
	"tsc": "Delete",
	"flds": []
}
]

 

 

 

Copyright Wordbee - Buzzin' Outside the Box since 2008