Object and Field Properties
|
node
|
A container element for a list of fields for one object along with their
configuration information. Each object that appears on the MIDM must
be defined in a node element. Most of the information you need to specify
in the node elements is generated by the wizard, but you can modify the information
as needed.
Note –
All fields defined in midm.xml must also be defined in object.xml;
however, not all fields defined in object.xml need to be defined for the MIDM.
Any fields or objects not listed in midm.xml will not appear on the MIDM.
|
name
|
The name of the object defined by the node.
|
display-order
|
The order in which the child object types appear in the enterprise records
on the MIDM pages.
|
field
|
A container element defining the configuration information for a field
on the MIDM. Each field that appears on the MIDM must be defined
in a field element. A field element can contain the eleven configuration elements
listed below.
|
name
|
The name of the field as it appears in the object definition file.
|
display-name
|
The name of the field as it appears on the MIDM.
|
display-order
|
The order in which the field appears on the MIDM. For example,
specify 1 to indicate this is the first field on the MIDM pages, 2 to indicate it is the second field, and so on.
|
max-length
|
The maximum number of characters displayed on the MIDM for the
field. If the field uses an input mask, make sure the length of the input
mask matches the length specified here.
|
gui-type
|
The type of display for the field. Specify one of the following options.
-
TextBox - A standard data
entry field
-
MenuList - A field that
must be populated by selecting from a drop-down list
-
TextArea - A long field
that requires a scrollbar, such as a comments field
|
value-type
|
The master index data type for the data populated in the field. The
following data types are supported:
-
string - Contains a string
of characters.
-
date - Contains a date
value.
-
float - Contains a floating
point integer.
-
int - Contains an integer.
-
char - Contains a single
character.
-
boolean - Contains either
true or false.
|
input-mask
|
A mask used by the MIDM to add punctuation to a field. You
can add an input mask to display telephone numbers as “(123)456-7890”
even though the database might store them as “1234567890” and
the user enters the numbers with no punctuation. The following character types
are allowed:
-
D - indicates a numeric
character.
-
L - indicates an alphabetic
character.
-
A - indicates an alphanumeric
character.
For example, the input mask for the above telephone
format is “(DDD)DDD-DDDD”.
Note –
If the length of the input mask is greater than the value specified
for the max-length element, update the max-length property to match.
|
value-mask
|
A mask used by the master index application to strip any extra characters
that were added by the input mask to ensure that data is stored in the database
in the correct format. This mask must be the same length as the input mask.
To specify a value mask, type the same value as is entered for the input
mask, but type an “x” in place of each punctuation mark. For example,
using the above phone number example, you need to specify a value mask of
xDDDxDDDxDDDD. A value mask is not required for date fields.
|
value-list
|
The name of the
menu list used to populate the drop-down list for the field. This is required
if the gui-type specified is MenuList, and it must
match a code of an element in the sbyn_common_header database table.
|
is-sensitive
|
An indicator of whether the value of the field is hidden on the MIDM for
records with a certain VIP status. Only users with the Administrator or Field_VIP
user roles can view the hidden information. Specify true to
hide the field value; specify false (or remove the is-sensitive element) to display the field value.
Note –
This element is only used if the object-sensitive-plug-in-class in the impl-details section is populated.
It must precede the key-type element described below.
|
key-type
|
An indicator of whether the field (or a combination of key fields) must
be unique in an enterprise record. Unique key fields identify unique child
objects in an enterprise object. Specify true to indicate
the field is a key field; specify false if it is not.
|
Relationship Properties
|
relationships
|
A container element that defines the hierarchy of the parent and child
objects displayed on the MIDM. This element contains the following two
elements.
|
name
|
The name of the parent object.
|
children
|
The name of a child object. There should be one children element
for each child object defined in the previous section of the file.
|
Implementation Properties
|
impl-details
|
A container element that defines the configuration information for certain
classes that are required for the MIDM to connect to the server. This
section also defines debug and security options.
|
master-controller-jndi-name
|
The JNDI name for the Master Controller. The default name is ejb/app-nameMasterController, where app-name is
the name of the master index application.
|
validation-service-jndi-name
|
The JNDI name for the processing code validator. The default name is
ejb/app-nameCodeLookup.
|
usercode-jndi-name
|
The JNDI name for the user code validator (used for non-unique IDs).
The default name is ejb/app-nameUserCodeLookup.
|
report-generator-jndi-name
|
The JNDI name for the MIDM report generator. The default name
is ejb/app-nameReportGenerator.
|
debug-flag
|
An indicator of whether debug information is logged. Specify true to log debug information.
|
debug-dest
|
The destination to which debug information is written. Specify console to log debug information to a monitor; specify file to
print to a file.
|
object-sensitive-plug-in-class
|
The name of the class that contains logic for masking the data in certain
fields from certain users. For example, certain sensitive information should
only be viewed by administrators. If you specify field masking, you must define
a custom plug-in to handle the process and specify it here.
|
MIDM Page Properties
|
gui-definition
|
A container element that defines the configuration information for the
pages that appear on the MIDM, including the types of searches available
and any sub-screens contained on those pages.
|
page-definition
|
A container element for the configuration elements that define the individual MIDM pages.
|
initial-screen-id
|
The screen ID of the first page to appear when you log in to the MIDM.
Enter the value defined in the screen-id element of
the page you want to display (described later in this table).
|
local-id
|
The name to use for all fields and columns containing local IDs. If
you want to change the field label from “Local ID” to a name that
is more relevant to your implementation, define that name here. In fields
where the local ID label is abbreviated to “LID1” or “LID2”,
the name becomes local-id1 or local-id2
(where local-id is the value specified for this
element). This name is also perpetuated to heading labels on search pages.
|
page-name
|
A name that identifies the page to the MIDM. Each page is defined
by a page-name element that contains all of the
configuration information for the page. The name of this element is specific
to the page being defined, and the allowed values for the default MIDM include
the following:
-
dashboard
-
record-details
-
transactions
-
duplicate-records
-
assumed-matches
-
source-record
-
reports
-
audit-log
|
allow-insert
|
An indicator of whether entries are written to the audit log each time
data is accessed on the MIDM. This element is only used when defining
the Audit Log page. Specify true to enable the audit
log. Specify false to disable the audit log. If the
audit log is maintained, the Audit Log page is available on the MIDM for
searching and viewing audit log entries and the information is stored in the
sbyn_audit table.
|
root-object
|
The name of the parent object. This should not be changed.
|
tab-name
|
A name for tabbed heading for the page. This name appears on tab labels
associated with the pages on the MIDM.
|
screen-id
|
A unique identifier for the page. This is referenced from the initial-screen-id element to specify the initial page that appears when a user
logs in to the MIDM. This value must be an integer.
|
display-order
|
The order in which the page appears in the tabbed headings. The display
order goes from left to right.
|
search-pages
|
A container element that lists and defines the searches that are available
from the page. You can define multiple searches for each page.
|
Search Page Properties
|
simple-search-page
|
A container element that defines one type of search for an MIDM page.
You can define multiple simple search pages.
|
screen-title
|
The name of the search as it appears on the search page. Users can select
a type of search to perform based on the titles you define for the searches
here.
|
search-result-id
|
The unique identifier for the search results page that appears for the
search. You can define multiple search results pages for each MIDM page,
and each results page has a unique ID. You can enter any of the search result
ID values defined in the search-results-pages element
described later in this table.
|
search-screen-order
|
The order in which the search page appears on the MIDM. The display
order goes from left to right.
|
show-euid
|
An indicator of whether to display the EUID field in the search
criteria. Specify true to display the EUID; otherwise
specify false. This element is not used by all pages,
and the default value is false if this element does not exist.
|
show-lid
|
An indicator of whether to display the local ID and system fields in
the search criteria. Specify true to display the fields;
otherwise specify false. This element is not used by
all pages, and the default value is false if this element does not exist. When the local ID is displayed,
the local ID and system fields appear in their own labelled box.
|
show-status
|
An indicator of whether to display the record status field in the search
results list. Specify true to display the field; otherwise
specify false. This element is not used by all pages,
and the default value is false if this element does not exist.
|
show-create-date
|
An indicator of whether to display the create date field to allow searching
on the date the record was created. Specify true to
display the field; otherwise specify false. This element
is not used by all pages, and the default value is false if this element does
not exist.
|
show-create-time
|
An indicator of whether to display the create time field to allow searching
on the time the record was created. Specify true to
display the field; otherwise specify false. This element
is not used by all pages, and the default value is false if this element does
not exist.
|
show-timestamp
|
An indicator of whether to display the timestamp field. Specify true to display the field; otherwise specify false.
This element is not used by all pages, and the default value is false if this
element does not exist.
|
instruction
|
A short statement to help the user process a search. The text you enter
here appears above the search fields on the Search page.
|
field-group
|
A list of fields that appear on the Search page. You can define multiple
field groups, and each group is contained in a labelled box on the Search
page. Note that you can only define fields for searches on the Record Details
page.
|
description
|
A description of the fields defined for the field-group element.
This value appears as a box label for the area of the page that contains the
specified fields.
|
field-ref
|
One field definition for a field in the field group. Use the simple
field name of the field with their corresponding objects as the root. For
example, the path to the FirstName field in the Person object is “Person.FirstName”.
You can define multiple field-ref elements for each
field group, each of which are further configured by the following two optional
attributes.
|
field-ref/required
|
An indicator of whether the field is required in order to perform a
search. Specify any of the following values.
-
true - The corresponding
field is required to perform the search. These fields are marked with an asterisk
(*).
-
false - The corresponding
field is not required to perform the search. If the required attribute
is not defined, the default is false.
-
oneof - This is assigned to more than one field and
at least one of the fields with this designation is required to perform the
search. If a group of fields is designated as “oneof”, those fields
are marked with a dagger ( ) on the search page.
|
field-ref/choice
|
An indicator of whether you search by a range of values rather than
an exact value for the field. Specify one of the following values.
-
exact - The search is performed
on the exact value entered (wildcard may be allowed). If the choice attribute
is not specified, this is the default value.
-
range - The search is performed
on a range of values based on the entered search criteria. Fields with this
designation appear twice on the search page, once with “From”
appended to the field label and once with “To” appended to the
field label. Be sure any searches that use range searching in the MIDM are
configured to use range searching in query.xml.
To define a field for both exact and range searching, define the field
twice; once with this attribute set to exact and once with it set to range.
|
search-option
|
A container element for the configuration information for a search.
Each search-option element defines one type of search
for the page. Note that not all search pages use search options.
|
display-name
|
A short phrase describing the type of search to perform, such as “Alphanumeric
Search” or “Phonetic Search”. These names appear on the MIDM for
users to select when specifying the type of search to perform.
|
query-builder
|
The type of query to use when this type of search is selected. The value
entered here must match a query-builder name in query.xml.
|
weighted
|
An indicator of whether the results of the search are assigned matching
probability weights. Specify true to assign matching
weights or false to return unweighted results.
|
candidate-threshold
|
The maximum number of records to return for a search. This value must
be a positive number, and is only used for blocking queries. Setting the candidate
threshold to zero is equivalent to not setting a threshold.
|
parameter
|
A list of optional parameters for the search. Not all query builders
require parameters.
|
name
|
The name of the parameter. Currently, only UseWildCard is
available.
|
value
|
The value of the parameter. For the UseWildCard parameter,
this is an indicator of whether the parameter is enabled or disabled. Specify true to allow wildcard characters or false to
perform exact-match searches.
|
Search Results List Properties
|
search-result-pages
|
A container element for a list of search result page definitions. This
allows you to have more than one search result configuration for the same MIDM page.
|
search-result-list-page
|
A container element for the configuration information for one search
results page. You can define multiple search results pages.
|
search-result-id
|
A unique identifier for the search result page. This element identifies
the results page to display for each search type defined above. This value
must be an integer.
|
item-per-page
|
The number of resulting records to display on one page.
|
max-result-size
|
The maximum number of records to return for a search.
|
show-status
|
An indicator of whether to display the record status field in the results
list. Specify true to display the field; otherwise
specify false. Note that you cannot configure the search
results fields for all search results lists.
|
show-create-date
|
An indicator of whether to display the create date field in the results
list. Specify true to display the field; otherwise
specify false.
|
show-create-time
|
An indicator of whether to display the create time field in the results
list. Specify true to display the field; otherwise
specify false.
|
show-timestamp
|
An indicator of whether to display the timestamp field in the results
list. Specify true to display the field; otherwise
specify false.
|
field-group
|
A container element for one list of fields that appear in the search
results. You can define multiple groups of fields.
|
description
|
A brief description for the field group. This value appears on the MIDM above
the fields that are returned from a search.
|
field-ref
|
A definition for one field that appears in the search results list.
Use the simple field names with their corresponding objects as the root. For
example, the path to the FirstName field in the Person object is “Person.FirstName”.
You can define multiple field-ref elements.
|
Subscreen Properties
|
subscreen-configurations
|
A list of sub-pages for a page-name element,
described earlier in this table. You can define several pages within the main
tabbed page. These pages appear on the page for which they are defined with
their own tabbed headings beneath the main tabbed heading row.
|
subscreen
|
A container element for a sub-page. This element uses the same sequence
of elements as the main page-name element, including
the following:
-
enable
-
root-object
-
tab-name
-
report-name
-
screen-id
-
display-order
-
search-pages
-
search-result-pages
The subscreen element does not include the allow-insert element,
but does include two new elements, enable and report-name. The enable element contains a Boolean indicator of whether the
tabbed sub-page is available. The report-name element is used for defining
reports.
|