Field index
infoarch/field-index.html
This is a list of the information “fields” that appear in the
user interface screens.
See the terms for the meanings of terms here, also for abbreviations.
The field names are carefully crafted to facilitate search with simple tools like grep.
No whole field name is a substring of any other field name.
Key variables, essential to determine content of pages
These are the principal variables that index the main information structures.
They are given as the functional variables for the other fields.
The link here is to the main information structure for which they represent the key.
A Key variable is one which has a constant value in a page,
but is different for different invocations of the page.
When the system becomes multilingual, the Lang variable is also needed.
Within a page,
- CanNum
- Javascript:
kVa.CanNum or kVa[CanNum]
- Candidate information structure
- Contact information structure
- EnqID
- Javascript:
kVa.EnqID or kVa[EnqID]
- Enquiry information structure
- ETypeCode
- Javascript:
kVa.ETypeCode or kVa[ETypeCode]
- Enquiry type information structure
- LocID
- Javascript:
kVa.LocID or kVa[LocID]
- Location information structure
- QID
- Javascript:
kVa.QID or kVa[QID]
- Question information structure
- RoleCode
- Javascript:
kVa.RoleCode or kVa[RoleCode]
- Role information structure
Other information structures to which fields belong
- Ans
- Answer information structure
- My
- My information collection, including preferences
Language
- Lang
- human language: use the normal standard codes
@ownlang indicates that the field is a note written by the user, in their own natural language.
A translation service may be wanted for those of different language.
List or array variables, within a page
- Item
- The item number in the list of items in a question
- Date
- The date-time: some fields have multiple instances at different date-times
All fields
The value of the field is determined by the variables indicated in parenthesis –
which is why it is shown as if it is a function of them.
In most cases, one or more of them is a key variable
that determines the content of the containing page as a whole.
In most cases, one of the key variables is also the key for one of the major
structures, and is linked to it.
Otherwise, the structure (Ans or My) follows the parenthesis.
- AbuseB(CanNum)
- wiki
- Boolean: is abuse being reported?
- UI see:
break
- AbuseNote(CanNum)
- wiki
- free text report on the abuse
- UI see:
report-abuse
- shown only to admins
- @ownlang
- AbuseType(CanNum)
- wiki
- type of the abuse (remains to be formulated)
- UI see:
report-abuse
- CanADate(CanNum,QID)
- wiki
- Date the other party answered that specific question
- CanAns(CanNum,QID,Lang) — Ans
- wiki
- display version of candidate's answer, from CanAVal
- either text from QItemShort
- or number and unit from CanAVal and QSUnit
- display only
- CanDate(CanNum,EnqID)
- wiki
- Date the other party was added to the enquirer's candidate list for an enquiry
- CanELocFit(CanNum,EnqID)
- wiki
- candidate distance away for this enquiry
- UI see:
show-results;
- display only
- CanNum (Key)
- wiki
- A sequential number, also indexes URRI
- Candidate information structure
- Contact information structure
- UI see:
answer-change;
break;
contact;
candidate;
candidates;
show-results;
invitations;
my-answer;
report-abuse;
their-answer;
- CanPropCred(CanNum,QID,Date) — Ans
- wiki
- how much global credence there is/was on this A - a number for each point on the credence scale
- UI see:
their-answer;
- CanPropDate(CanNum,QID,Date) — Ans
- wiki
- date of candidate answer
- UI see:
their-answer;
- CanProps(CanNum,QID) — Ans
- wiki
- array of all the answers the candidate has given to that question
- indexed by PropCount
- UI see:
contact;
candidate;
show-results;
their-answer;
- display only
- CanPropVal(CanNum,QID,Date) — Ans
- wiki
- value or code for candidate's answer – never text
- code looked up and displayed as (usually one) QItemShort
- value converted at time of display to cater for users' unit preferences
- CanRegDate(CanNum)
- wiki
- date the candidate first registered on the system
- (a proxy for trustworthiness)
- UI see:
contact;
candidate;
- CoBreakNote(CanNum)
- wiki
- contact's final free text message to user when breaking contact
- @ownlang
- UI see:
break;
contact;
- CoChannels(CanNum)
- wiki
- contact's channels shared with me:
- UI see:
channels-shared;
- CoEIDs(CanNum)
- wiki
- which of my Enq IDs fit the contact
- UI see:
contact;
- CoELat(CanNum,EnqID)
- wiki
- contact latitude for corresponding enquiry
- UI see:
contact;
- CoELong(CanNum,EnqID)
- wiki
- contact longitude for corresponding enquiry
- UI see:
contact;
- CoEmail(CanNum)
- wiki
- contact's e-mail
- UI see:
contact;
- CoEQWants(CanNum,EnqID,QID)
- wiki
- machine version of what Co wants from Q in corresponding enquir[y|ies]
- may be compound
- UI see:
contact;
- CoEQWNote(CanNum,EnqID,QID)
- wiki
- free text note about what Co wants from Q in corresponding enquiry(ies)
- shown when contact agreed
- @ownlang
- UI see:
contact;
- CoMyChannels(CanNum)
- wiki
- my channels shared with the contact:
- UI see:
channels-shared;
- CoName(CanNum)
- wiki
- name of the contact given by themselves
- shown when contact agreed
- @ownlang
- UI see:
break;
contact;
candidates;
candidate;
show-results;
my-answer;
report-abuse;
their-answer;
- CoNick(CanNum)
- wiki
- my nickname for the contact
- shown only to me; can be used as mnemonic
- @ownlang
- UI see:
candidate;
invitations;
- ContactDate(CanNum)
- wiki
- date when contact agreed (or blank, if not)
- UI see:
candidates;
contact;
- ContactStatus(CanNum)
- wiki
- contact status of other with me
- short code; displayed as StatusLabel
- UI see:
break;
contact;
candidate;
candidates;
show-results;
- CoPropChNote(CanNum,QID,Date) — Ans
- wiki
- free text explanation of change by contact
- UI see:
their-answer;
- shown when contact agreed
- @ownlang
- CoPropNote(QID) — Ans
- wiki
- optional free text explanation of answer
- shown to others when contact agreed
- @ownlang
- UI see:
contact;
their-answer;
- ELocB(EnqID)
- wiki
- does enquiry set a required maximum distance for candidate location?
- UI see:
forming-enquiry;
- EMaxDist(EnqID)
- wiki
- the maximum distance set
- UI see:
forming-enquiry;
- EnqActB(EnqID)
- wiki
- is enquiry active?
- UI see:
forming-enquiry;
- EnqID (Key)
- wiki
- user's enquiry ID
- Enquiry information structure
- UI see:
answer-change;
enquiries-of-type;
enquiry-basics;
forming-enquiry;
enquiry-location;
want-in-enquiry;
candidates;
show-results;
my-answer-enqs;
add-question;
question-enquiries;
their-answer;
- EnqLID(EnqID)
- wiki
- location ID used in enquiry
- UI see:
contact;
forming-enquiry;
enquiry-location;
- EnqLocB(EnqID) DEPRECATED
- Just use EnqLID appropriately.
- EnqName(EnqID)
- wiki
- @ownlang
- UI see:
answer-change;
contact;
candidate;
enquiries-of-type;
enquiry-basics;
forming-enquiry;
enquiry-location;
want-in-enquiry;
candidates;
show-results;
invitations;
my-answer-enqs;
my-answer;
add-question;
question-enquiries;
their-answer;
- EnqNote(EnqID)
- wiki
- what I'm looking for in this enquiry
- @ownlang
- UI see:
enquiry-basics;
forming-enquiry;
- EnqTimes(EnqID)
- wiki
- a compound field with the windows of opportunity related to this enquiry
- displayed on forming-enquiry page as ETimeStr
- UI see:
enquiry-times;
- EQAllB(EnqID,QID)
- wiki
enquiry-location;
- are selected all required?
- UI see:
want-in-enquiry;
- EQExtB(EnqID,QID)
- wiki
- are extra ones acceptable?
- UI see:
want-in-enquiry;
- EQGrade(EnqID,QID)
- wiki
- required, considering, unasked
- UI see:
forming-enquiry;
want-in-enquiry;
add-question;
question-enquiries;
- EQGradLabel(EnqID,Lang)
- wiki
- @en: "required", "considering", "not asked"
- UI see:
forming-enquiry;
want-in-enquiry;
add-question;
- display only
- EQList(EnqID,QID)
- wiki
- the list of all QIDs relevant to this enquiry
- UI see:
forming-enquiry;
- EQMax(EnqID,QID)
- wiki
- the maximum value wanted, for RANGQ
- EQMin(EnqID,QID)
- wiki
- the minimum value wanted, for RANGQ
- EQMuteB(EnqID,QID)
- wiki
- is Ans to Q muted in this enquiry?
- UI see:
my-answer;
my-answer-enqs;
- ETimeStr(Lang)
- wiki
- EnqTimes given as a string on the forming-enquiry page
- ETypeDescrip(ETypeCode,Lang)
- wiki
- full description of type, from HUB
- UI see:
enquiries-of-type;
- ETypeCode (Key)
- wiki
- short code
- Enquiry type information structure
- UI see:
contact;
candidate;
enquiries-of-type;
forming-enquiry;
enquiry-basics;
want-in-enquiry;
enquiries-overview;
show-results;
my-answer-enqs;
my-answer;
- ETypeLabel(ETypeCode,Lang)
- wiki
- single word, from HUB
- UI see:
contact;
candidate;
enquiries-of-type;
show-results;
my-answer;
- ETypeQProhiB(ETypeCode)
- wiki
- whether given Q prohibited in this EType
- UI see:
my-answer-enqs;
- ETypeQProNote(ETypeCode,Lang)
- wiki
- Why the Q is prohibited in this EType
- UI see:
my-answer-enqs;
- ETypeTitle(ETypeCode,Lang)
- wiki
- one line from HUB
- UI see:
enquiry-basics;
forming-enquiry;
my-answer-enqs;
- LEndB(LocID)
- wiki
- does location have end date?
- UI see:
define-location;
- LocEditB: DEPRECATED
- Just use LocID appropriately.
- LocEnd(LocID)
- wiki
- end date for location
- UI see:
define-location;
- LocID (Key)
- wiki
- user's location ID
- Location information structure
- UI see:
define-location;
forming-enquiry;
enquiry-location;
- LocLat(LocID)
- wiki
- latidude of the location
- UI see:
contact;
define-location;
- LocLong(LocID)
- wiki
- longitude of the location
- UI see:
contact;
define-location;
- LocName(LocID)
- wiki
- @ownlang
- UI see:
define-location;
forming-enquiry;
enquiry-location;
- LocStart(LocID)
- wiki
- start date for location
- UI see:
define-location;
- LStartB(LocID)
- wiki
- does location has start date?
- UI see:
define-location;
- LocType(LocID)
- wiki
- type of location
- UI see:
define-location;
- MyAChNote(QID,Date) — Ans
- wiki
- explanation of change
- @ownlang
- UI see:
answer-change;
my-answer-history;
- MyACred(QID,Date) — Ans
- wiki
- how much global credence there is/was on this Ans - 5 numbers
- UI see:
my-answer-history;
- MyADate(QID,Date) — Ans
- wiki
- date of particular answer in history
- UI see:
my-answer-history;
- MyANote(QID) — Ans
- wiki
- optional explanation of answer, shown only to contacts
- @ownlang
- UI see:
contact;
my-answer-enqs;
my-answer;
- MyAns(QID,Lang) — Ans
- wiki
- display version of my answer, from MyAVal
- either text from QItemShort
- or number and unit from MyAVal and QSUnit
- UI see:
answer-change;
contact;
candidate;
my-answer-history;
my-answer;
my-answers;
question-enquiries;
- display only
- MyPropCount(QID) — Ans
- wiki
- serial number of current answer
- UI see:
my-answer;
my-answers;
- MyAVNew(QID) — Ans
- wiki
- value or code for my new answer before changing
- UI see:
answer-change;
- display only
- MyAVal(QID) — Ans
- wiki
- value or code for my answer – never text
- code looked up and displayed as (usually one) QItemShort
- value converted at time of display to cater for users' unit preferences
- UI see:
answer-change;
my-answer;
my-answer-enqs;
add-question;
question-enquiries;
- MyBirthYear — My
- wiki
- (Gregorian) Year of Birth – no need for date
- UI see:
birth-year;
- MyBreakNote(CanNum)
- wiki
- my final message to contact when breaking contact
- @ownlang
- UI see:
break;
contact;
- MyCACNote(CanNum,QID) — Ans
- wiki
- my reality check or credibility notes on C's Ans
- displayed only to me
- @ownlang
- UI see:
their-answer;
- MyCACred(CanNum,QID) — Ans
- wiki
- whether I believe Ans from contact
- this could be one of five values: sure, fairly sure, uncertain, I doubt it, surely not
- UI see:
their-answer;
- MyDateFormat — My
- wiki
- preferred date format
- UI see:
user-preferences;
- MyDefName — My
- wiki
- my general default name
- @ownlang
- UI see:
user-preferences;
- MyOwnChannels — My
- wiki
- All my communication channels that I may want to share with others
- UI see:
user-preferences;
- MyEmail — My
- wiki
- obvious
- UI see:
registration;
- needs another special page to change it
- MyEQWants(EnqID,QID)
- wiki
- machine version of what I want from Q in Enquiry
- may be compound
- UI see:
contact;
want-in-enquiry;
- MyEQWNote(EnqID,QID)
- wiki
- text note about what I want from Q in Enquiry
- shown to others when contact agreed
- @ownlang
- UI see:
contact;
want-in-enquiry;
add-question;
their-answer;
- MyID — My
- wiki
- Personal persistent ID allocated on registration
- UI see:
registration;
- MyName(CanNum)
- wiki
- the version of my name I use with this contact
- shown to others when contact agreed
- @ownlang
- UI see:
contact;
candidate;
- MyUnitDistance — My
- wiki
- units in which the user wishes to display and enter geographical distance
- UI see:
user-preferences;
- MyUnitHeight — My
- wiki
- units in which the user wishes to display and enter values like height of a person
- UI see:
user-preferences;
- MyUnitWeight — My
- wiki
- units in which the user wishes to display and enter values like weight of a person
- UI see:
user-preferences;
- NewQReqNote —
- wiki
- Free text note elaborating on a question that is requested
- UI see:
add-question;
- PropCount(CanNum,QID) — Ans
- wiki
- Integer: how many answers given to Property Q: 0=unanswered
- UI see:
their-answer;
candidate;
contact;
- QAccept(QID) — Ans
- wiki
- unaddressed, unanswered, answered, refused, confused
- UI see:
unanswered-question;
want-in-enquiry;
my-answer;
question-enquiries;
- QDesc(QID,Lang)
- wiki
- full text of question, from GMS
- UI see:
want-in-enquiry;
my-answer;
question-enquiries;
question-modify;
- QDetails(QID,Lang)
- wiki
- shorthand for full text and item texts for a question, from GMS
- UI see:
answer-change;
unanswered-question;
my-answer-enqs;
my-answer;
question-enquiries;
their-answer;
- QFuNote(QID) — Ans
- wiki
- notes on why an answer is refused for this question
(for QAccept = refused)
or what it is that is confusing
(for QAccept = confused)
- shown to others when contact agreed
- @ownlang
- UI see:
unanswered-question;
- QID (Key)
- wiki
- global question ID
- Question information structure
- UI see:
answer-change;
unanswered-question;
contact;
candidate;
enquiries-of-type;
forming-enquiry;
want-in-enquiry;
show-results;
my-answer-enqs;
my-answer-history;
my-answer;
my-answers;
more?;
- QItemLong(QID,Item,Lang)
- wiki
- long item text, from GMS
- UI see:
want-in-enquiry;
my-answer;
question-enquiries;
question-modify;
- QItemShort(QID,Item,Lang)
- wiki
- short item text, from GMS
- UI see:
want-in-enquiry;
my-answer;
add-question;
question-enquiries;
question-modify;
- QMultiB(QID)
- wiki
- does the question admit multiple answers? from GMS
- UI see:
question-modify;
- QnI(QID)
- wiki
- number of items in this question, needed for several question structures
- QOtherB(QID)
- wiki
- does the question have an "other" option? from GMS
- UI see:
question-modify;
- QPos(QID,Lang)
- wiki
- Position statement for Likert scale
- QPref1(QID,Lang)
- wiki
- description of one of two alternatives to express preference, from GMS
- QPref2(QID,Lang)
- wiki
- description of the other of two alternatives to express preference, from GMS
- QPrefer1(QID,Lang)
- wiki
- description of one of two alternatives to express preference, from GMS
- QPrefer2(QID,Lang)
- wiki
- description of the other of two alternatives to express preference, from GMS
- QRelB(QID)
- wiki
- Boolean/binary denoting if the question is about the relation between the parties, rather than about a stable characteristic of one of the parties.
If this is true, the value is not recorded, but can be varied at will in any Enquiry.
It's about how the parties want to relate, not about who they are.
- QSMax(QID)
- wiki
- maximum plausible value of metric
- QSMin(QID)
- wiki
- minimum plausible value of metric
- QSchB(QID)
- wiki
- Whether there is an externally define scheme defined for a QScheme question
- QScheme(QID)
- wiki
- the predefined question option scheme, e.g. for levels, from GMS
- QStruct(QID)
- wiki
- structure of question: see Question structures; from GMS
- UI see:
question-modify;
- QSUnit(QID)
- wiki
- the default unit used for specifying wanted values, for RANGQ
- taken from SI units to provide standard references
- converted at time of display to cater for users' preferences
- QTitle(QID,Lang)
- wiki
- question title used for display as link text, from GMS
- UI see:
answer-change;
contact;
candidate;
enquiries-of-type;
forming-enquiry;
want-in-enquiry;
show-results;
my-answer-enqs;
my-answer;
my-answers;
add-question;
question-enquiries;
question-modify;
their-answer;
- RoleDesc(ETypeCode,Lang)
- wiki
- short description of the role in that enquiry type, from HUB
- UI see:
- RoleCode
- Enquiry type information structure
- UI see:
- RoleLabel(ETypeCode,Lang)
- wiki
- single word, from HUB
- UI see:
- StatusLabel(CanNum,Lang)
- wiki
- @en: "unknown"; "uninvited"; "blocked"; "invitedbyme"; "invitingme"; "connected"; "theybreak"; "ibreak"; "broken"
- UI see where CoStatus and ContactStatus are:
break;
contact;
candidate;
candidates;
show-results;
- display only
- URRI(CanNum)
- wiki
- Code composed of system IDs of Enquirer and Candidate, in LSV
- UI see:
Change fields
These are only needed in the case of proposed question editing.
For UI for all of these, see: question-modify
- QAuthor(QID)
- GUID of question version author
- QDscrNew(QID,Lang)
- proposed new full text of question
- QItemLoNew(QID,Item,Lang)
- proposed new long item text
- QItemShoNew(QID,Item,Lang)
- proposed new short item text
- QOwner(QID)
- GUID of current question owner
- QPr1New(QID,Lang)
- revised version of QPref1
- QPr2New(QID,Lang)
- revised version of QPref2
- QSmaNew(QID)
- revised maximum plausible value of QSMax
- QSmiNew(QID)
- revised minimum plausible value of QSMin
- QSchNew(QID)
- revised option scheme
- QTitNew(QID,Lang)
- proposed new question title