Documentation

System variables

List of the system variables (SYS_VAR) used by templates, datagrams and the Ntity API.

On this page

Introduction

System variables are the numeric IDs shared by the Ntity platform, the templates and the datagrams: document formats, blockchains, operations, statuses… They are referenced by their ID or by their key, eg. "L": "SYS_VAR_DOCUMENT_JSON".

List

Document

Format of a document or of the data of a certificate (template key L or Z).

ID	Name	Key	Description	Code
1500	Text	`SYS_VAR_DOCUMENT_TEXT`		`txt`
1501	CSV	`SYS_VAR_DOCUMENT_CSV`		`csv`
1502	Image Jpeg	`SYS_VAR_DOCUMENT_IMAGE_JPEG`		`jpg`
1503	Image Gif	`SYS_VAR_DOCUMENT_IMAGE_GIF`		`gif`
1504	Image Png	`SYS_VAR_DOCUMENT_IMAGE_PNG`		`png`
1505	PDF	`SYS_VAR_DOCUMENT_PDF`		`pdf`
1506	Dynamic	`SYS_VAR_DOCUMENT_DYNAMIC`
1507	Template	`SYS_VAR_DOCUMENT_TEMPLATE`
1508	JSON	`SYS_VAR_DOCUMENT_JSON`		`json`
1509	XML	`SYS_VAR_DOCUMENT_XML`		`xml`
1510	YAML	`SYS_VAR_DOCUMENT_YAML`		`yaml`
1511	HTML	`SYS_VAR_DOCUMENT_HTML`
1512	CSS	`SYS_VAR_DOCUMENT_CSS`
1520	PHP	`SYS_VAR_DOCUMENT_PHP`		`php`
1521	Javascript	`SYS_VAR_DOCUMENT_JAVASCRIPT`		`js`
1530	Header	`SYS_VAR_DOCUMENT_HEADER`
1531	Footer	`SYS_VAR_DOCUMENT_FOOTER`
1540	gzcompress	`SYS_VAR_DOCUMENT_GZCOMPRESS`	Compressed document in gzcompress format	`gz`
1541	zip	`SYS_VAR_DOCUMENT_ZIP`	Compressed document in zip format	`zip`
1548	IPFS	`SYS_VAR_DOCUMENT_IPFS`	Contains an IPFS hash	`ipfs`
1549	Custom	`SYS_VAR_DOCUMENT_CUSTOM`	Non standard document type

Blockchain

Blockchain on which a template or a document is written. The code is the network code used in the on-chain data syntax.

ID	Name	Key	Description	Code
1551	Bitcoin Mainnet	`SYS_VAR_BCD_BTC`	Bitcoin production mainnet	`BTC`
1552	Ethereum Mainnet	`SYS_VAR_BCD_ETH`	Ethereum production mainnet	`ETH`
1553	Ntity Mainnet	`SYS_VAR_BCD_NTT`	Ntity production mainnet	`NTT`
1591	POA Mainnet	`SYS_VAR_BCD_POA`	POA mainnet, ETH network id 99	`POA`
1592	Aura Mainnet	`SYS_VAR_BCD_AURA`	Aura mainnet	`AURA`
1651	Bitcoin Testnet	`SYS_VAR_BCD_BTC_TN`	Bitcoin testnet	`BTC_TN`
1652	Ethereum Testnet Ropsten	`SYS_VAR_BCD_ETH_3`	Ethereum testnet Ropsten	`ETH_3`
1653	Ntity Testnet Haradev	`SYS_VAR_BCD_NTT_TN`	Ntity testnet Haradev	`NTT_TN`
1691	POA Testnet Sokol	`SYS_VAR_BCD_POA_TN`	POA testnet Sokol, ETH network id 99	`POA_TN`
1692	Aura Testnet	`SYS_VAR_BCD_AURA_TN`	Aura testnet	`AURA_TN`

Action

Includes the datagram operations.

ID	Name	Key
2505	Insert	`SYS_VAR_ACTION_INSERT`
2506	Update	`SYS_VAR_ACTION_UPDATE`
2507	Delete	`SYS_VAR_ACTION_DELETE`
2510	Login	`SYS_VAR_ACTION_LOGIN`
2511	Register	`SYS_VAR_ACTION_REGISTER`
2512	Recover	`SYS_VAR_ACTION_RECOVER`
2514	Transfert	`SYS_VAR_ACTION_TRANSFERT`
2515	Surcharge	`SYS_VAR_ACTION_SURCHARGE`
2516	Event	`SYS_VAR_ACTION_EVENT`
2517	Move	`SYS_VAR_ACTION_MOVE`
2518	Own	`SYS_VAR_ACTION_OWN`
2519	Acknoledge	`SYS_VAR_ACTION_ACKNOLEDGE`
2520	Approval	`SYS_VAR_ACTION_APPROVAL`
2523	Merge	`SYS_VAR_ACTION_MERGE`

Status

Template key st, and approval types.

ID	Name	Key
10	Activated	`SYS_VAR_STATUS_ACTIVATED`
11	Open	`SYS_VAR_STATUS_OPEN`
12	Processing	`SYS_VAR_STATUS_PROCESSING`
13	Incomplete	`SYS_VAR_STATUS_INCOMPLETE`
14	Pending	`SYS_VAR_STATUS_PENDING`
15	Locked	`SYS_VAR_STATUS_LOCKED`
16	Resolved	`SYS_VAR_STATUS_RESOLVED`
17	Closed	`SYS_VAR_STATUS_CLOSED`
18	Deleted	`SYS_VAR_STATUS_DELETED`
19	Undefined	`SYS_VAR_STATUS_UNDEFINED`
20	Success	`SYS_VAR_STATUS_SUCCESS`
21	Fail	`SYS_VAR_STATUS_FAIL`
22	Confirmed	`SYS_VAR_STATUS_CONFIRMED`
23	Transfering	`SYS_VAR_STATUS_TRANSFERING`
24	Rejected	`SYS_VAR_STATUS_REJECTED`
25	Published	`SYS_VAR_STATUS_PUBLISHED`
26	Private	`SYS_VAR_STATUS_PRIVATE`
29	Spam	`SYS_VAR_STATUS_SPAM`

Event type

Type (y) of an event.

ID	Name	Key
2530	Warranty	`SYS_VAR_EVENTTYPE_WARRANTY`
2531	Repair	`SYS_VAR_EVENTTYPE_REPAIR`
2532	Polish	`SYS_VAR_EVENTTYPE_POLISH`
2533	Other	`SYS_VAR_EVENTTYPE_OTHER`
2534	Revison	`SYS_VAR_EVENTTYPE_REVISON`
2535	Return	`SYS_VAR_EVENTTYPE_RETURN`
2536	Growth	`SYS_VAR_EVENTTYPE_GROWTH`
2537	Harvesting	`SYS_VAR_EVENTTYPE_HARVESTING`
2538	Processing	`SYS_VAR_EVENTTYPE_PROCESSING`