Object Info tab field descriptions

This tab specifies the general properties and behavior of the Object.

The field descriptions for the Object Info tab are:

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Field Name	Description
Description field desc.field	Specifies a short description of the Object.
Profile application profile.appl	Specifies the RAD application that creates the profile that determines if a user can perform certain functions, such as add and delete. For example, db.environment. (rquired)
Profile variable profile.variable	Specifies a variable that can be accessed any time this Object is called without accessing the environment record.For example, $L.env. (required)
Number record name number.record	Defines a number class for the Object, which can be accessed from a call to the getnumb application either via a Process or FormatControl or RAD call. It can be used to retrieve a sequential number as a unique key for the record. For example, EXWorkOrder.
Category table name category.file.name	Specifies the table name that links with the category table associated with this Object's category value. When displaying a record of this type, if a field called category exists, then the Object will search the category table name and for the record with the corresponding name. If found, the system stores the Category File Name as a variable: $L.category.
Phase table name phase.file.name	Specifies the table name that links with the phase table associated with this Object, if applicable. When the system displays a record of this type, if a field called phase exists, then the Object goes to the phase table name and selects a record with a corresponding name. If found, the system will store the phase table name as a variable: $L.phase.
Paging table name paging.file	Specifies the name of the table used for storing pages. Pages are created as full copies of the current record prior to the latest updates being applied. This is done every time a record is updated, which creates a detailed audit trail.
Master format control master.fc	Specifies the name of the Master Format Control record, if one exists for the record Object. Master Format Control allows you to define in one record the Format Control statements that apply to all phases in an area, for example Change Management Request Phases. Typically, the name of the master format control is the name of the dbdict or all categories in Incident Management, Problem Management, or Service Desk.
Joindef joindef	Specifies the name of the joindef record used to join multiple tables, for example joincomputer, or an expression that evaluates to a valid joindef name, such as joindef in $L.category
Status field statusField	Specifies the field name that contains the record's status information.
Assigned to fields assignedToFields	Specifies the field name that contains the assignee name field for this Object. This field will be referred to when Folder Entitlement verifies that the record is assigned to the logged in operator.
Workgroup fields workgroupFields	Specifies the field name that contains the assignment group field for this Object. This field will be referred to when Folder Entitlement verifies that the record is assigned to any of the logged in operator's work groups.
Open state open.state	Specifies the State definition record to use upon opening a new record.
Close state close.state	Specifies the State definition record to use for close processing of an existing record.
List state list.state	Specifies the State definition record used to display a list of records.
Default state default.state	Specifies the name of the State used as default for the Object. To edit a record in this Object, the default State is used.
Search state search.state	Specifies the State definition record to use for searching.
Browse state browse.state	Defines the State definition record to use when records use locking. Essentially, this field defines a read-only State when a record is currently locked by another user.
Manual states manual.states	Specifies the array of States that may be used with this Object other than the life-cycle states of open, close, list, view, search or browse.

Field Name

Description

Description field

desc.field

Specifies a short description of the Object.

Profile application

profile.appl

Specifies the RAD application that creates the profile that determines if a user can perform certain functions, such as add and delete. For example, db.environment. (rquired)

Profile variable

profile.variable

Specifies a variable that can be accessed any time this Object is called without accessing the environment record.For example, $L.env. (required)

Number record name

number.record

Defines a number class for the Object, which can be accessed from a call to the getnumb application either via a Process or FormatControl or RAD call. It can be used to retrieve a sequential number as a unique key for the record. For example, EXWorkOrder.

Category table name

category.file.name

Specifies the table name that links with the category table associated with this Object's category value. When displaying a record of this type, if a field called category exists, then the Object will search the category table name and for the record with the corresponding name. If found, the system stores the Category File Name as a variable: $L.category.

Phase table name

phase.file.name

Specifies the table name that links with the phase table associated with this Object, if applicable. When the system displays a record of this type, if a field called phase exists, then the Object goes to the phase table name and selects a record with a corresponding name. If found, the system will store the phase table name as a variable: $L.phase.

Paging table name

paging.file

Specifies the name of the table used for storing pages. Pages are created as full copies of the current record prior to the latest updates being applied. This is done every time a record is updated, which creates a detailed audit trail.

Master format control

master.fc

Specifies the name of the Master Format Control record, if one exists for the record Object. Master Format Control allows you to define in one record the Format Control statements that apply to all phases in an area, for example Change Management Request Phases. Typically, the name of the master format control is the name of the dbdict or all categories in Incident Management, Problem Management, or Service Desk.

Joindef

joindef

Specifies the name of the joindef record used to join multiple tables, for example joincomputer, or an expression that evaluates to a valid joindef name, such as joindef in $L.category

Status field

statusField

Specifies the field name that contains the record's status information.

Assigned to fields

assignedToFields

Specifies the field name that contains the assignee name field for this Object. This field will be referred to when Folder Entitlement verifies that the record is assigned to the logged in operator.

Workgroup fields

workgroupFields

Specifies the field name that contains the assignment group field for this Object. This field will be referred to when Folder Entitlement verifies that the record is assigned to any of the logged in operator's work groups.

Open state

open.state

Specifies the State definition record to use upon opening a new record.

Close state

close.state

Specifies the State definition record to use for close processing of an existing record.

List state

list.state

Specifies the State definition record used to display a list of records.

Default state

default.state

Specifies the name of the State used as default for the Object. To edit a record in this Object, the default State is used.

Search state

search.state

Specifies the State definition record to use for searching.

Browse state

browse.state

Defines the State definition record to use when records use locking. Essentially, this field defines a read-only State when a record is currently locked by another user.

Manual states

manual.states

Specifies the array of States that may be used with this Object other than the life-cycle states of open, close, list, view, search or browse.