DBC XML Format
DBC XML Format
DBC XML Format
html
Element and Attribute Global element and attribute declarations belong to this schema's
Namespaces target namespace.
By default, local element declarations have no namespace.
By default, local attribute declarations have no namespace.
Documentation
This document defines each element that can be used on DBC files, their attributes, and how to properly
use them.
For a description of what DBC files are and how the Update DB proccess works, refer to Database
Configuration Scripts (DATABASE_CONFIGURATION_SCRIPTS.html).
Properties
Name script
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 1/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
This is the main element of the script that is required on all DBC files. It is good practice to correctly
provide the author and scriptname attributes so that anyone can determine the purpose of the script
and identify the creator of the script.
Attributes:
author: The name of the author of the file.
for_demo_only: If this attribute is present and defined as true, the script is executed only against
MaxDemo databases and ignored on other cases. The default value is false.
for_install_only: If this attribute is present and defined as true, the script is executed only in install
mode and ignored on other cases. The default value is false
tenantcode: The code of the tenant where this script runs. This attribute is only considered if
context is defined as tenants .
<script
author="string" [1]
scriptname="string" [1]
for_demo_only="string (value comes from list: {'true'|'false'})" [0..1]
for_install_only="string (value comes from list: {'true'|'false'})" [0..1]
context="string (value comes from list: {'master'|'landlord'|'tenants'|'all'})" [0..1]
tenantcode="string" [0..1]
>
<description> ... </description> [0..1]
<check> ... </check> [0..*]
<statements> ... </statements> [1]
</script>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 2/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: description
Properties
Name description
Nillable no
Abstract no
Documentation
This element provides a meaningful description of the actions taken by the DBC file.
<description>Restores Assign and WMAssign class names to core values, and the same for
Scheduler-related fields</description>
<description>Add the new field OPTCLEANUP to the MAPMANAGER table and corntask for
delete old SKDOriginDestMatrix</description>
<description>Create a system property to define the maximum time since the last LBS
update after which a labor/crew marker should not be displayed using the Nearby
Resources Tool</description>
<description/>
Element: check
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 3/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Properties
Name check
Nillable no
Abstract no
Documentation
This section defines the checks to make before running the script. It can have one or more check_query
children elements and each one performs an SQL query against the database. If any query returns a row,
the information is logged and usually the script is skipped. The first check that has a query return a row
takes precedence. If no query returns rows, the script will be run.
Generally used to skip running the script if the script contents have already been applied.
When a check_query needs to register a log message, an internal MXException is created and
passed to the Maximo logging mechanism. It is possible to pass information to that object using the
attributes group , key and default , overriding the default values, as described below:
Attributes:
tag: If this attribute is set to WARNMODIFICATION , the logged message generated by execution of
the check is tagged as a warning, instead of the default info tag.
skip_script: If true , the script runs even if any check_query returns any rows.
<check
tag="string" [0..1]
group="string" [0..1]
key="string" [0..1]
default="string" [0..1]
skip_script="string (value comes from list: {'true'|'false'})" [0..1]
>
<check_query> ... </check_query> [1..*]
</check>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 4/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: check_query
Properties
Name check_query
Nillable no
Abstract no
Documentation
Before running a ascript, it is a good practice to always check if the changes of the script were already
applied. An example of how to use check_query is if a new attribute, called RELATIONSHIP , should be
added to the object WFASSIGNMENT . A safe script should test the existence of the attribute. The check
and check_query elements can be used to validate this pre-condition:
<check>
<check_query>select 1 from maxattribute where objectname = 'WFASSIGNMENT' and attribute
</check>
Another example is before a new object is created, the script should include a check to validate if the
object already exists:
<check>
<check_query>select 1 from maxintobject where intobjectname ='MXSCRIPT'</check_query>
</check>
<check_query
query="string" [1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 5/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: statements
Properties
Name statements
Nillable no
Abstract no
Documentation
This element encloses all the elements that represents runnable statements that will perform the
necessary changes on database schema or it's data. Each element runs following the order of
appearence inside this tag and, if any error is captured, the update process is aborted and the error is
logged.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 6/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<statements>
Start Choice [0..*]
<create_relationship> ... </create_relationship> [1]
<modify_relationship> ... </modify_relationship> [1]
<drop_relationship> ... </drop_relationship> [1]
<freeform> ... </freeform> [1]
<add_attributes> ... </add_attributes> [1]
<modify_attribute> ... </modify_attribute> [1]
<drop_attributes> ... </drop_attributes> [1]
<define_table> ... </define_table> [1]
<modify_table> ... </modify_table> [1]
<drop_table> ... </drop_table> [1]
<specify_index> ... </specify_index> [1]
<drop_index> ... </drop_index> [1]
<specify_synonym_domain> ... </specify_synonym_domain> [1]
<add_synonyms> ... </add_synonyms> [1]
<specify_aln_domain> ... </specify_aln_domain> [1]
<specify_numeric_domain> ... </specify_numeric_domain> [1]
<specify_crossover_domain> ... </specify_crossover_domain> [1]
<drop_domain> ... </drop_domain> [1]
<specify_table_domain> ... </specify_table_domain> [1]
<add_sigoption> ... </add_sigoption> [1]
<drop_sigoption> ... </drop_sigoption> [1]
<create_maxvar> ... </create_maxvar> [1]
<modify_maxvar> ... </modify_maxvar> [1]
<drop_maxvar> ... </drop_maxvar> [1]
<modify_domain_type> ... </modify_domain_type> [1]
<add_service> ... </add_service> [1]
<modify_service> ... </modify_service> [1]
<drop_service> ... </drop_service> [1]
<create_app> ... </create_app> [1]
<modify_app> ... </modify_app> [1]
<drop_app> ... </drop_app> [1]
<create_module> ... </create_module> [1]
<modify_module> ... </modify_module> [1]
<drop_module> ... </drop_module> [1]
<create_app_menu> ... </create_app_menu> [1]
<additional_app_menu> ... </additional_app_menu> [1]
<define_view> ... </define_view> [1]
<modify_view> ... </modify_view> [1]
<drop_view> ... </drop_view> [1]
<drop_view_attribute> ... </drop_view_attribute> [1]
<add_view_attribute> ... </add_view_attribute> [1]
<modify_view_attributes> ... </modify_view_attributes> [1]
<add_property> ... </add_property> [1]
<set_property> ... </set_property> [1]
<drop_property> ... </drop_property> [1]
<module_app> ... </module_app> [1]
<insert> ... </insert> [1]
<logical_relationship> ... </logical_relationship> [1]
End Choice
</statements>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 7/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: modify_domain_type
Properties
Name modify_domain_type
Nillable no
Abstract no
Documentation
This statement allows you to change a Domain's maxtype definition. This definition is applied to all
columns that are defined as using the domain.
Attributes:
domain: Targeted domain.
length: Set the length of the maxtype, when appropriate. Must be used only with numeric domains.
scale: Set the scale of the maxtype, when appropriate. Must be used only with decimal domains.
Use Example:
<modify_domain_type domain="DOMAINNAME" length="25" maxtype="ALN" scale="0" />
<modify_domain_type
domain="string" [1]
maxtype="string (value comes from list: {'ALN'|'LONGALN'|'LOWER'|'UPPER'|'AMOUNT'|'DECIMAL
length="NMTOKEN" [0..1]
scale="NMTOKEN" [0..1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 8/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: define_view
Properties
Name define_view
Nillable no
Abstract no
Documentation
Creates a database view based on the query defined using table, view_select, view_from and
view_where (optional).
The view is associated with a Maximo Business Object (MBO), that must already exists on Maximo Asset
Management.
Attributes:
name: The name of the new view.
description: A meaninful description about the view and why its is necessary.
extends: If this MBO extends another existing MBO, the name of this MBO can be assigned here.
internal: Indicates that the object is reserved for internal use by the platform and cannot be altered
by using the Database Configuration application.
Use Example:
For example, in order to create a view that combines SKDWORKPLANEXTCAP and CRAFTSKILL , the
element should looks like:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 9/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<define_view
name="string" [1]
description="string" [1]
service="string" [1]
classname="string" [1]
extends="string" [0..1]
type="string (value comes from list: {'system'|'site'|'companyset'|'itemset'|'org'|'orgapp
mainobject="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
>
Start Choice [1]
<autoselect> ... </autoselect> [1]
<table> ... </table> [1..*]
<view_column> ... </view_column> [0..*]
<view_select> ... </view_select> [1]
<view_from> ... </view_from> [1]
End Choice
<view_where> ... </view_where> [1]
<longdescription> ... </longdescription> [0..1]
</define_view>
Element: autoselect
Properties
Name autoselect
Nillable no
Abstract no
Documentation
AutoSelect views must reference all columns of the table that the view extends.
<autoselect/>
Element: table
Properties
Name table
Nillable no
Abstract no
Documentation
Defines a table that is part of the query present in view_select, view_from and view_where. There must
be one table element for each table present in the query.
Attributes:
name: Table's name.
Use Example:
The example for define_view uses two tables in the query with two table elements:
<table name="skdworkplanextcap"/>
<table name="craftskill"/>
<table
name="string" [1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 11/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: view_column
Properties
Name view_column
Nillable no
Abstract no
Documentation
Defines a view's column. If the element is not present, the columns are infered from the query.
Attributes:
view: Name of the target view.
Use Example:
The columns sets.setid , groupuser.userid and applicationauth.app are defined in the following
example:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 12/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<view_column
table="string" [1]
column="string" [1]
view_column="string" [1]
same_storage_as="string" [0..1]
/>
Element: view_select
Properties
Name view_select
Nillable no
Abstract no
Documentation
Defines which columns are returned in the result set and is equivalent to the select part of a SQL query.
An example is shown in the view_column element and is Used to get only three columns: sets.setid ,
groupuser.userid and applicationauth.app :
Use Example:
<view_select>select distinct sets.setid, groupuser.userid, applicationauth.app </view_selec
<view_select/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 13/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: view_from
Properties
Name view_from
Nillable no
Abstract no
Documentation
Defines which tables is part of the query and is equivalent to the from part of a SQL query. For examples
on how this element is used, see the define_view and view_column elements:
Use Example:
<view_where>sets.setid = organization.companysetid and settype in (select value from synony
<view_where>skdworkplanextcap.resourcename=craftskill.craft and skdworkplanextcap.orgid=cra
<view_from/>
Element: view_where
Properties
Name view_where
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 14/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Defines which data is present on the result set based on SQL-like conditions and is equivalent to the
where part of a SQL query. For examples on how this element is used, see the define_view and
view_column elements:
Use Example:
<view_where>sets.setid = organization.companysetid and settype in (select value from synony
<view_where/>
Element: modify_view
Properties
Name modify_view
Nillable no
Abstract no
Documentation
Modifies an existing view if the name matches the value of the name attribute. This element accepts the
same attributes and child elements of define_view.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 15/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
name: View's name.
classname: Full Qualified Name (FQN) of the View's object class name.
internal: Indicates that the object is reserved for internal use by the platform and cannot be altered
by using the Database Configuration application.
service: Service name if exists one only for this particular app.
Use Example:
It performs an update on the selected view and affects only the attributes and elements that are present in
the modify_view tag, with the exception of the attribute name.
The following example changes the view_select value of the UNASSIGNEDWORKVIEW to the value defined
below:
<modify_view name="UNASSIGNEDWORKVIEW">
<view_select> wo.workorderid,wo.wonum ,wo.siteid,wo.orgid,wo.parent,wo.status,wo.descript
</modify_view>
<modify_view
name="string" [1]
classname="string" [0..1]
description="string" [0..1]
mainobject="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
service="string" [0..1]
type="string (value comes from list: {'system'|'site'|'companyset'|'itemset'|'org'|'orgapp
>
<view_select> ... </view_select> [0..1]
<view_from> ... </view_from> [0..1]
<view_where> ... </view_where> [0..1]
<longdescription> ... </longdescription> [0..1]
</modify_view>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 16/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: drop_view
Properties
Name drop_view
Nillable no
Abstract no
Documentation
Drops an existing view if the name matches the value of the name attribute.
Attributes:
name: View's name that should be deleted.
Use Example:
The following markup drops the DBINFOOBJECTVIEW view:
<drop_view name="DBINFOOBJECTVIEW"/>
<drop_view
name="string" [1]
/>
Element: drop_view_attribute
Properties
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 17/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Name drop_view_attribute
Nillable no
Abstract no
Documentation
Drops a single view's attribute if the name matches the value of the attribute attribute.
A modify_view element must be used to remove the dropped attribute from the view's select, from and
where.
Attributes:
view: Target view's name.
Use Example:
<drop_view_attribute view="VIEWNAME" attribute="ATTRIBUTENAME" />
<drop_view_attribute
view="string" [1]
attribute="string" [1]
/>
Element: add_view_attribute
Properties
Name add_view_attribute
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 18/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Adds a new attribute to an existing view. This attribute must be a column from one of the tables present in
the view's query. This element has the same attributes of view_column element.
A modify_view element must be used to add the new attribute to the view's select, from and where, if
necessary.
Attributes:
view: View name.
Use Example:
<add_view_attribute view="VIEWNAME" view_column="VIEWATTRIBUTENAME" table="TABLENAME" colum
<add_view_attribute
view="string" [1]
view_column="string" [1]
table="string" [1]
column="string" [1]
same_storage_as="string" [0..1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 19/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: modify_view_attributes
Properties
Name modify_view_attributes
Nillable no
Abstract no
Documentation
Modifies one or more attributes of an existing view. It holds a sequence of modify_view_data where each
one acts on a single attribute.
Attributes:
Refer to modify_view_data to futher information about the element.
Use Example:
<modify_view_attributes view="VIEWNAME" >
<modify_view_data view_column="VIEWATTRIBUTE" column="TABLEATTRIBUTE" new_name="VIEWNEW
</modify_view_attributes >
<modify_view_attributes
view="string" [1]
>
<modify_view_data> ... </modify_view_data> [1..*]
</modify_view_attributes>
Element: modify_view_data
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 20/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Properties
Name modify_view_data
Nillable no
Abstract no
Documentation
Modifies a single attribute of an existing view. This element has the same attributes of view_column
element. It must be used in conjunction with modify_view_attributes.
Attributes:
new_name: New name for the particular view.
Use Example:
You can find the same sample from the modify_view_attributes element sample.
<modify_view_data
view_column="string" [1]
new_name="string" [0..1]
table="string" [0..1]
column="string" [0..1]
same_storage_as="string" [0..1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 21/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: create_maxvar
Properties
Name create_maxvar
Nillable no
Abstract no
Documentation
Attributes:
name: Name of the Maxvar.
description: A meaningful description about the Maxvar and why the Maxvar is necessary.
Use Example:
The following example create the USECLIENTTIMEZONE Maxvar:
<create_maxvar
name="string" [1]
description="string" [1]
default="string" [0..1]
type="string (value comes from list: {'system'|'site'|'organization'|'system_tenant'})" [1
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 22/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: modify_maxvar
Properties
Name modify_maxvar
Nillable no
Abstract no
Documentation
Modifies an existing Maxvar where the name matches the value of the name attribute. This element
accepts the same attributes of create_maxvar.
The element performs an update on the selected Maxvar and affects only the attributes that are present in
the modify_maxvar tag, with the exception of the attribute name.
Attributes:
name: Variable's name
type: Variable type represents the level this variable should be applied [System|Site|Organization].
Use Example:
The following example changes the attributes description, default and type of USECALFORSLAESCPT :
<modify_maxvar
name="string" [1]
description="string" [0..1]
default="string" [0..1]
type="string (value comes from list: {'system'|'site'|'organization'|'system_tenant'})" [0
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 23/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: drop_maxvar
Properties
Name drop_maxvar
Nillable no
Abstract no
Documentation
Attributes:
name: Name of the Maxvar.
Use Example:
The following example drops a Maxvar named PLUSCMOBREADONLY :
<drop_maxvar
name="string" [1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 24/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: create_relationship
Properties
Name create_relationship
Nillable no
Abstract no
Documentation
Creates a Maximo relationship between the parent and child objects that are ruled by the whereclause
value, a SQL-like that will join parent and child.
In the where clause, fields that are defined with ":" are the attributes of parent object. The other fields are
from child object.
Attributes:
parent: Name of the Maximo object indicating from where is the relationship.
name: Relationship's name, to be used everytime the relationship needs to be referred, as in the
presentation xml.
child: Name of Maximo object indicating the to of the relationship, the target.
Use Example:
The following example creates a relationship named SKDODMECONSTRAINTINFO between
SKDODMECONFLICTMESSAGE and SKDODMECONSTRAINTINFO objects and returns all
SKDODMECONSTRAINTINFO records that has the constraintname field equal to the parent
SKDODMECONFLICTMESSAGE.constraintname . The field :constraintname refers to the value of
constraintname column from SKDODMECONFLICTMESSAGE table:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 25/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<create_relationship
parent="string" [1]
name="string" [1]
child="string" [1]
whereclause="string" [1]
remarks="string" [1]
/>
Element: modify_relationship
Properties
Name modify_relationship
Nillable no
Abstract no
Documentation
Modifies an existing Maximo relationship where the name matches the value of the name attribute. This
element accepts the same attributes of create_relationship.
It performs an update on the selected relationship and affects only the attributes present inside
modify_relationship tag, with the exception of the attribute name.
Attributes:
parent: Name of the Maximo object indicating from where is the relationship.
name: Relationship's name, to be used everytime the relationship needs to be referred, as in the
presentation xml.
child: Name of Maximo object indicating the to of the relationship, the target.
Use Example:
The following example changes the attributes description, default and type of USECALFORSLAESCPT :
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 26/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<modify_relationship
parent="string" [1]
name="string" [1]
child="string" [0..1]
whereclause="string" [0..1]
remarks="string" [0..1]
/>
Element: drop_relationship
Properties
Name drop_relationship
Nillable no
Abstract no
Documentation
Attributes:
parent: Name of the parent object.
Use Example:
The following example drops a relationship named BUDGETANALYSISAXIS from BUDGET :
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 27/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<drop_relationship
parent="string" [1]
name="string" [1]
/>
Element: freeform
Properties
Name freeform
Nillable no
Abstract no
Documentation
A freeform statement is made of up SQL sections. Each SQL section can have one or more SQL
statements, delimited with semicolons. A SQL section can be targeted for specific server types, or all
servers.
Since the statement is executed directly on a database server, proceed with extreme caution. The
difference in syntax must also be considered when writting the statements. If you cannot create a
statement that is compatible with all supported servers, use a sql element for each database product.
Attributes:
description: A meaningful description about the changes been made by the SQL statements.
Use Example:
The following example shows a sequence of sql elements performing updates on different objects:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 28/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
The previous example puts one statement per sql element but they also can be grouped on one sigle sql
element, as the next example shows:
<freeform
description="string" [1]
>
<sql> ... </sql> [1..*]
</freeform>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 29/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: sql
Properties
Name sql
Nillable no
Abstract no
Documentation
Works in conjunction with the freeform element and encloses the SQL statement that is executed against
the database. Since Maximo Asset Management supports different database products that has different
SQL syntaxes, one SQL statement can run successfully on one platform but not on another. In this case,
use the target attribute to define the scope of this statement.
Attributes:
target: Defines when the statements must be executed, based on the underlying database
configuration. It's possible to have product-specific statements, such as oracle for Oracle
statements, statements that run on all products except one, like not_db2 and statements that run
on all products ( all ).
Use Example:
The following example shows different statements running against different databases. There are
statements that runs in all platforms( target="all" ), and statements that, due to differences in syntax,
has versions to Oracle, SQL Server and DB2 databases:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 30/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<sql
target="string (value comes from list: {'oracle'|'sqlserver'|'db2'|'all'|'not_oracle'|'not
/>
Element: define_table
Properties
Name define_table
Nillable no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 31/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Abstract no
Documentation
The table is associated to a Maximo Business Object (MBO) that must already exists on Maximo Asset
Management.
Attributes:
object: Table's name that is used everytime the table needs to be referred.
description: A meaningful description about the view and why the view is necessary.
primarykey: A comma-separeted list of columns names that represents the table's primary key.
trigroot: Each Maximo table includes a column named ROWSTAMP, for this columns, the trigeroot
must be set in order to autaticaly fill it.
storagetype: Defines the Storage Types for Multitenancy used by the DBChange code.
Use Example:
The following example creates a table that is named INSIGHTFACTOR :
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 32/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<define_table
object="string" [1]
description="string" [1]
service="string" [1]
classname="string" [1]
persistent="string (value comes from list: {'true'|'false'})" [0..1]
type="string (value comes from list: {'system'|'site'|'organization'|'orgwithsite'|'compan
primarykey="string" [0..1]
mainobject="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
trigroot="string" [0..1]
storagetype="string (value comes from list: {'tenant'|'master'|'system'|'template'|'system
resource_type="string" [0..1]
>
<attrdef> ... </attrdef> [1..*]
<longdescription> ... </longdescription> [0..1]
</define_table>
Element: modify_table
Properties
Name modify_table
Nillable no
Abstract no
Documentation
Above, in the list for type, organization and orgwithsite are deprecated and are kept only so existing
scripts can be used. In the statement run method, organization will be converted to org and orgwithsite
converted to orgsite.
The list of storagetype comes from the MTStorageType class. That list must correspond to th
Attributes:
name: Table's name.
Use Example:
<modify_table name="TABLENAME" object="OBJECTNAME" >
<modify_table
name="string" [1]
object="string" [0..1]
description="string" [0..1]
service="string" [0..1]
classname="string" [0..1]
type="string (value comes from list: {'system'|'site'|'organization'|'orgwithsite'|'compan
primarykey="string" [0..1]
mainobject="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
trigroot="string" [0..1]
unique_column="string" [0..1]
storagetype="string (value comes from list: {'tenant'|'master'|'system'|'template'|'system
>
Start Sequence [0..1]
<longdescription> ... </longdescription> [1]
End Sequence
</modify_table>
Element: drop_table
Properties
Name drop_table
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 34/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Attributes:
object: Table's name, to be used everytime the table needs to be referred.
Use Example:
<drop_table object="INSIGHTFACTOR" type="system" </drop_table>
<drop_table
object="string" [1]
/>
Element: add_attributes
Properties
Name add_attributes
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 35/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
Check attrmod fot a further information about nested attributes.
Use Example:
<add_attributes object="LOCATIONS">
<attrdef attribute="MODELID" maxtype="ALN" title="Import ID"
remarks="Import ID Typically from a BIM model or COBie data set" length="45" localizabl
<attrdef attribute="BIMIMPORTSRC" maxtype="ALN" title="Import source" domain="COBIESHEETT
remarks="The external source for the data in this record such as a COBie sheet or an IF
<attrdef attribute="BIMUSAGE" maxtype="ALN" title="BIM Location type" domain="BIMLOCATION
remarks="Describes how a location is used and controls COBie export behavior" length="2
<attrdef attribute="BIMROOMNAME" maxtype="ALN" title="Room Name/Number"
remarks="The name or number of the room or space" length="40" />
</add_attributes>
<add_attributes
object="string" [1]
>
<attrdef> ... </attrdef> [1..*]
</add_attributes>
Element: attrmod
Properties
Name attrmod
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 36/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Defines each attribute should be modified/added and should be configured as a nested element into the
add_attribute.
Attributes:
attribute: Attrinute's name.
length: The number of characters that can be entered into this attribute.
required: When set to TRUE, indicates that a value is required in this field.
domain: Associate this attribute with a domain through the domain's name
classname: Associate to this attribute with a field validation class trhough the class's FQN (Full
Qualified Name).
title: Define a clear, short column identifier to be substituted in messages, screen labels, etc.
sameasobject: SameAsObject indicate the master object that controls the maxtype, length, and
scale of this attribute.
sameasattribute: SameAsAttribute indicate the master attribute that controls the maxtype, length,
and scale of this attribute.
mustbe: When checked, indicates that Maxtype, Length, and Scale of the attribute can NOT be
changed. When cleared, indicates that they can be changed.
ispositive: For a numeric field, when checked, only positive values (and zero) are allowed; when
cleared, both positive and negative values are allowed.
searchtype: Indicates to Maximo what kind of search type is allowed for this attribute.
restriction: Type of restriction being configured. Valid types are Hidden, Required, Read-only and
Qualified. Qualified means that only data meeting the condition is 'qualified' to be fetched from the
database and can only be applied to top-level objects (not child objects or attributes).
Use Example:
The follow example add attributes EXTLOCID , EXTSITENAME , EXTSITEUSE and EXTROOMNAME against
the LOCATIONS object/table.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 37/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<add_attributes object="LOCATIONS">
<attrdef attribute="EXTLOCID" maxtype="ALN" title="Import ID"
remarks="External Location ID" length="45" localizable="false" />
<attrdef attribute="EXTSITENAME" maxtype="ALN" title="Import source" domain="COBIESHEET
remarks="External site name" length="25" />
<attrdef attribute="EXTSITEUSE" maxtype="ALN" title="BIM Location type" domain="BIMLOCA
remarks="External site use purpose" length="20" />
<attrdef attribute="EXTROOMNAME" maxtype="ALN" title="Room Name/Number"
remarks="Exteranal room name" length="40" />
</add_attributes>
<attrmod
attribute="string" [1]
maxtype="string (value comes from list: {'ALN'|'AMOUNT'|'BIGINT'|'BLOB'|'CLOB'|'CRYPTO'|'C
length="NMTOKEN" [0..1]
persistent="string (value comes from list: {'true'|'false'})" [0..1]
haslongdesc="string (value comes from list: {'true'|'false'})" [0..1]
required="string (value comes from list: {'true'|'false'})" [0..1]
userdefined="string (value comes from list: {'true'|'false'})" [0..1]
domain="string" [0..1]
classname="string" [0..1]
defaultvalue="string" [0..1]
title="string" [0..1]
remarks="string" [0..1]
sameasobject="string" [0..1]
sameasattribute="string" [0..1]
mustbe="string (value comes from list: {'true'|'false'})" [0..1]
ispositive="string (value comes from list: {'true'|'false'})" [0..1]
scale="NMTOKEN" [0..1]
autokey="string" [0..1]
canautonum="string (value comes from list: {'true'|'false'})" [0..1]
searchtype="string (value comes from list: {'WILDCARD'|'EXACT'|'NONE'|'TEXT'})" [0..1]
localizable="string (value comes from list: {'true'|'false'})" [0..1]
domainlink="string" [0..1]
restricted="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: modify_attribute
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 38/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Properties
Name modify_attribute
Nillable no
Abstract no
Documentation
Attributes:
attribute: Attrinute's name.
length: The number of characters that can be entered into this attribute.
required: When set to TRUE, indicates that a value is required in this field.
domain: Associate this attribute with a domain through the domain's name.
classname: Associate to this attribute with a field validation class trhough the class's FQN (Full
Qualified Name).
title: Define a clear, short column identifier to be substituted in messages, screen labels, etc.
sameasobject: SameAsObject indicate the master object that controls the maxtype, length, and
scale of this attribute.
sameasattribute: SameAsAttribute indicate the master attribute that controls the maxtype, length,
and scale of this attribute.
mustbe: When checked, indicates that Maxtype, Length, and Scale of the attribute can NOT be
changed. When cleared, indicates that they can be changed.
ispositive: For a numeric field, when checked, only positive values (and zero) are allowed; when
cleared, both positive and negative values are allowed.
searchtype: Indicates to Maximo what kind of search type is allowed for this attribute.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 39/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
restriction: Type of restriction being configured. Valid types are Hidden, Required, Read-only and
Qualified. Qualified means that only data meeting the condition is 'qualified' to be fetched from the
database and can only be applied to top-level objects (not child objects or attributes).
Use Example:
The follow example change attributes EXTLOCID , EXTSITENAME , EXTSITEUSE and EXTROOMNAME from
LOCATIONS object/table. The attributes were add in add_attributes element.
<modify_attribute object="LOCATIONS">
<attrdef attribute="EXTLOCID" maxtype="ALN" title="Import ID"
remarks="External Location ID" length="45" localizable="false" />
<attrdef attribute="EXTSITENAME" maxtype="ALN" title="Import source" domain="COBIESHEET
remarks="External site name" length="25" />
<attrdef attribute="EXTSITEUSE" maxtype="ALN" title="BIM Location type" domain="BIMLOCA
remarks="External site use purpose" length="20" />
<attrdef attribute="EXTROOMNAME" maxtype="ALN" title="Room Name/Number"
remarks="Exteranal room name" length="40" />
</modify_attribute>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 40/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<modify_attribute
object="string" [1]
attribute="string" [1]
maxtype="string (value comes from list: {'ALN'|'AMOUNT'|'BIGINT'|'BLOB'|'CLOB'|'CRYPTO'|'C
length="NMTOKEN" [0..1]
persistent="string (value comes from list: {'true'|'false'})" [0..1]
haslongdesc="string (value comes from list: {'true'|'false'})" [0..1]
required="string (value comes from list: {'true'|'false'})" [0..1]
userdefined="string (value comes from list: {'true'|'false'})" [0..1]
domain="string" [0..1]
classname="string" [0..1]
defaultvalue="string" [0..1]
title="string" [0..1]
remarks="string" [0..1]
sameasobject="string" [0..1]
sameasattribute="string" [0..1]
mustbe="string (value comes from list: {'true'|'false'})" [0..1]
ispositive="string (value comes from list: {'true'|'false'})" [0..1]
scale="NMTOKEN" [0..1]
autokey="string" [0..1]
canautonum="string (value comes from list: {'true'|'false'})" [0..1]
searchtype="string (value comes from list: {'WILDCARD'|'EXACT'|'NONE'|'TEXT'})" [0..1]
localizable="string (value comes from list: {'true'|'false'})" [0..1]
domainlink="string" [0..1]
restricted="string (value comes from list: {'true'|'false'})" [0..1]
excludetenants="string" [0..1]
/>
Element: drop_attributes
Properties
Name drop_attributes
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 41/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
objecname: Object's name that owns this attribute.
attrname: Attribute's name. For a further information about the attribute, refers to attrname
element.
Use Example:
Following a simple sample how to drop an attribute from a Table/Object.
<drop_attributes object="OBJECTNAME">
<attrname name="ATTRIBUTENAME"/>
</drop_attributes>
<drop_attributes
object="string" [1]
>
<attrname> ... </attrname> [1..*]
</drop_attributes>
Element: attrname
Properties
Name attrname
Nillable no
Abstract no
Documentation
Attributes:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 42/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
attrname: Attribute's name. For a further information about the attribute, refers to attrname
element.
Use Example:
To a complete example about this element, please refer to drop_attribute element's Use examples
section.
<attrname
name="string" [1]
/>
Element: attrdef
Properties
Name attrdef
Nillable no
Abstract no
Documentation
The attrdef element is nested to add_attributes element and serves to specify each attribute that should
be added in a particular table, view or object.
Attributes:
attribute: Attrinute's name.
length: The number of characters that can be entered into this attribute.
required: When set to TRUE, indicates that a value is required in this field.
domain: Associate this attribute with a domain through the domain's name
classname: Associate to this attribute with a field validation class trhough the class's FQN (Full
Qualified Name).
title: Define a clear, short column identifier to be substituted in messages, screen labels, etc.
sameasobject: SameAsObject indicate the master object that controls the maxtype, length, and
scale of this attribute.
sameasattribute: SameAsAttribute indicate the master attribute that controls the maxtype, length,
and scale of this attribute.
mustbe: When checked, indicates that Maxtype, Length, and Scale of the attribute can NOT be
changed. When cleared, indicates that they can be changed.
ispositive: For a numeric field, when checked, only positive values (and zero) are allowed; when
cleared, both positive and negative values are allowed.
searchtype: Indicates to Maximo what kind of search type is allowed for this attribute.
restriction: Type of restriction being configured. Valid types are Hidden, Required, Read-only and
Qualified. Qualified means that only data meeting the condition is 'qualified' to be fetched from the
database and can only be applied to top-level objects (not child objects or attributes).
Use Example:
For a further information about complete samples, please refer to add_attributes and modify_attribute
element's Use example's section.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 44/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<attrdef
attribute="string" [1]
maxtype="string (value comes from list: {'ALN'|'AMOUNT'|'BIGINT'|'BLOB'|'CLOB'|'CRYPTO'|'C
length="NMTOKEN" [0..1]
persistent="string (value comes from list: {'true'|'false'})" [0..1]
haslongdesc="string (value comes from list: {'true'|'false'})" [0..1]
required="string (value comes from list: {'true'|'false'})" [0..1]
userdefined="string (value comes from list: {'true'|'false'})" [0..1]
domain="string" [0..1]
classname="string" [0..1]
defaultvalue="string" [0..1]
title="string" [1]
remarks="string" [1]
sameasobject="string" [0..1]
sameasattribute="string" [0..1]
mustbe="string (value comes from list: {'true'|'false'})" [0..1]
ispositive="string (value comes from list: {'true'|'false'})" [0..1]
scale="NMTOKEN" [0..1]
autokey="string" [0..1]
canautonum="string (value comes from list: {'true'|'false'})" [0..1]
searchtype="string (value comes from list: {'WILDCARD'|'EXACT'|'NONE'|'TEXT'})" [0..1]
localizable="string (value comes from list: {'true'|'false'})" [0..1]
domainlink="string" [0..1]
restricted="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: specify_index
Properties
Name specify_index
Nillable no
Abstract no
Documentation
Use specify to modify an existing index or bring new a one into existence
Attributes:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 45/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
object: Object's or Table's name wich should have the index specified.
Use Example:
The follow example demostrate the specify_index element. For a further information about the nested
attribute "indexkey", please refer to indexkey documentation.
<specify_index
name="string" [0..1]
object="string" [1]
primary="string (value comes from list: {'true'|'false'})" [0..1]
unique="string (value comes from list: {'true'|'false'})" [0..1]
clustered="string (value comes from list: {'true'|'false'})" [0..1]
required="string (value comes from list: {'true'|'false'})" [0..1]
addtenantid="string (value comes from list: {'true'|'false'})" [0..1]
>
<indexkey> ... </indexkey> [1..*]
</specify_index>
Element: drop_index
Properties
Name drop_index
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 46/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Attributes:
object: Object's name of the target index.
Use Example:
The follow example would drop the index created through the specify_index command.
<drop_index
name="string" [0..1]
object="string" [1]
>
<indexkey> ... </indexkey> [0..*]
</drop_index>
Element: indexkey
Properties
Name indexkey
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 47/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
The indexkey element is a nested part of the specify_index and drop_index elements.
Attributes:
column: Attribute name associated with this index.
Use Example:
Refer to specify_index for a complete example of this element.
<indexkey
column="string" [1]
ascending="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: specify_synonym_domain
Properties
Name specify_synonym_domain
Nillable no
Abstract no
Documentation
Attributes:
domainid: Domain's name or unique identifier.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 48/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
internal: Flag to indicate if the domain is internal and/or localizable. 0: localizable and not internal;
1: internal and not localizable; 2: not localizable but not internal.
Use Examples
<specify_synonym_domain domainid="TESTING" >
<synonymvalueinfo maxvalue="ONE" value="ONE" defaults="true"/>
<synonymvalueinfo maxvalue="TWO" value="TWO" defaults="true"/>
</specify_synonym_domain>
<specify_synonym_domain
domainid="string" [1]
description="string" [0..1]
maxtype="string (value comes from list: {'ALN'|'LONGALN'|'LOWER'|'UPPER'})" [0..1]
length="NMTOKEN" [0..1]
overwrite="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
>
<synonymvalueinfo> ... </synonymvalueinfo> [1..*]
</specify_synonym_domain>
Element: add_synonyms
Properties
Name add_synonyms
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 49/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
Attributes:
domainid: Target domain.
Use Example:
The add_synonyms element is combined with the synonymvalueinfo element.
<add_synonyms
domainid="string" [1]
>
<synonymvalueinfo> ... </synonymvalueinfo> [1..*]
</add_synonyms>
Element: synonymvalueinfo
Properties
Name synonymvalueinfo
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 50/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Defines the synonym domain's value. This element is used nested to specify_synonym_domain and
add_synonyms elements.
Attributes:
value: Domain's value.
Use Example:
Refers to specify_synonym_domain and add_synonyms elements to a complete example.
<synonymvalueinfo
value="string" [1]
maxvalue="string" [1]
defaults="string (value comes from list: {'true'|'false'})" [1]
description="string" [0..1]
/>
Element: specify_aln_domain
Properties
Name specify_aln_domain
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 51/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
domainid: Domain's name or unique identifier.
internal: Flag to indicate if the domain is internal and/or localizable. 0: localizable and not internal;
1: internal and not localizable; 2: not localizable but not internal.
Use Example:
This domain represents the characters that can be selected through a domain at the Maximo UI.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 52/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<specify_aln_domain
domainid="string" [1]
description="string" [0..1]
maxtype="string (value comes from list: {'ALN'|'LONGALN'|'LOWER'|'UPPER'})" [0..1]
length="NMTOKEN" [0..1]
overwrite="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
>
<alnvalueinfo> ... </alnvalueinfo> [1..*]
</specify_aln_domain>
Element: specify_numeric_domain
Properties
Name specify_numeric_domain
Nillable no
Abstract no
Documentation
Attributes:
domainid: Domain's name or unique identifier.
internal: Flag to indicate if the domain is internal and/or localizable. 0: localizable and not internal;
1: internal and not localizable; 2: not localizable but not internal.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 53/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Use Example:
<specify_numeric_domain length="2" domainid="NUMBERS" description="A domain with 5 items, f
<numericvalueinfo value="0" description="0" />
<numericvalueinfo value="1" description="1" />
<numericvalueinfo value="2" description="2" />
<numericvalueinfo value="3" description="3" />
<numericvalueinfo value="4" description="4" />
<numericvalueinfo value="5" description="5" />
<specify_numeric_domain/>
<specify_numeric_domain
domainid="string" [1]
description="string" [0..1]
maxtype="string (value comes from list: {'AMOUNT'|'DECIMAL'|'DURATION'|'FLOAT'|'INTEGER'|'
length="NMTOKEN" [0..1]
scale="NMTOKEN" [0..1]
overwrite="string (value comes from list: {'true'|'false'})" [0..1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
>
<numericvalueinfo> ... </numericvalueinfo> [1..*]
</specify_numeric_domain>
Element: specify_crossover_domain
Properties
Name specify_crossover_domain
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 54/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
A crossover domain will allow additional values to be carried or "crossed" over from a child table when a
field is populated in a parent table, with data that connects the two tables based on a where clause that
creates a one to one relationship between the two objects.
Attributes:
domainid: Domain's name or unique identifier.
validationwhereclause: The Validation Where Clause is critical to the crossover functioning and
defines the one to one relationship between the two objects that will trigger the crossover when that
criteria is met
objectname: The Object value should be the child table and is the object the value will be brought
over from.
internal: Flag to indicate if the domain is internal and/or localizable. 0: localizable and not internal;
1: internal and not localizable; 2: not localizable but not internal.
NOTE: For listwhereclause and validationwhereclause , Maximo system does not validate your
entry for syntax or any other errors. Be sure that you have typed a correct WHERE clause. If you make
errors, errors do not become apparent until you configure the database.
Use Example:
In the following example we will set up a crossover from the ASSET table to the WORKORDER table.
When the ASSETNUM field of Work Order Tracking is populated while inserting a work order record, the
crossover will populate the corresponding SERIALNUM value from the ASSET record in the
WORKORDER.SERIALNUM field. Because the WORKORDER.ASSETNUM is the attribute used in the where
clause from the destination table, we need to associate the ASSET2WORK domain to DOMAINID column
for the ASSETNUM attribute. In the Source Field, we are going to enter SERIALNUM. Note that the
lookup can be used to select the ASSET.SERIALNUM value as the object for the child table has been
defined. The Destination field is a free form field due to the fact that the domain needs to be created
before the domain can be associated to the destination object. It is critical to enter the proper value for the
crossover to work. We have created a SERIALNUM attribute on the WORKORDER object so we will
enter that value.It is possible to have more than one source and destination pairing for one crossover
domain. Please refer to crossovervalueinfo element for a further information abour sources and
destinations
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 55/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<specify_crossover_domain
domainid="string" [1]
description="string" [0..1]
overwrite="string (value comes from list: {'true'|'false'})" [0..1]
validationwhereclause="string" [1]
listwhereclause="string" [0..1]
errorbundle="string" [0..1]
errorkey="string" [0..1]
objectname="string" [1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
>
<crossovervalueinfo> ... </crossovervalueinfo> [1..*]
</specify_crossover_domain>
Element: specify_table_domain
Properties
Name specify_table_domain
Nillable no
Abstract no
Documentation
Defines a table domain. You do add a table domain when you want to add a domain that draws its values
directly from a column in the database. This process creates a dynamic value list because the values it
draws from the database might change.
Attributes:
domainid: Domain's name or unique identifier.
validationwhereclause: The Validation Where Clause is critical to the crossover functioning and
defines the one to one relationship between the two objects that will trigger the crossover when that
criteria is met
listwhereclause: Type the part of the clause that specifies the values that you want to select
based on the validation WHERE clause.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 56/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
objectname: The Object value should be the child table and is the object the value will be brought
over from.
internal: Flag to indicate if the domain is internal and/or localizable. 0: localizable and not internal;
1: internal and not localizable; 2: not localizable but not internal.
NOTE: For listwhereclause and validationwhereclause , Maximo system does not validate your
entry for syntax or any other errors. Be sure that you have typed a correct WHERE clause. If you make
errors, errors do not become apparent until you configure the database.
Use Example:
The following example defines a dynamic asset list.
<specify_table_domain
domainid="string" [1]
description="string" [0..1]
overwrite="string (value comes from list: {'true'|'false'})" [0..1]
validationwhereclause="string" [1]
listwhereclause="string" [0..1]
errorbundle="string" [0..1]
errorkey="string" [0..1]
objectname="string" [1]
internal="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: drop_domain
Properties
Name drop_domain
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 57/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Attributes:
domaid: Unique domain identification.
Use Example:
The sample bellow delete an existent domain from the system.
<drop_domain domainid="ASSETLIST"/>
<drop_domain
domainid="string" [1]
/>
Element: alnvalueinfo
Properties
Name alnvalueinfo
Nillable no
Abstract no
Documentation
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 58/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
value: ALN domain value.
Use Example:
To a complete example about this element, please refers to specify_aln_domain element.
<alnvalueinfo
value="string" [1]
description="string" [0..1]
/>
Element: numericvalueinfo
Properties
Name numericvalueinfo
Nillable no
Abstract no
Documentation
Defines the numeric domain's value. This element is used nested to specify_numeric_domain elements.
Attributes:
value: Domain's value.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 59/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Use Example:
Refers to the specify_numeric_domain element for a complete example of this element.
<numericvalueinfo
value="NMTOKEN" [1]
description="string" [0..1]
/>
Element: crossovervalueinfo
Properties
Name crossovervalueinfo
Nillable no
Abstract no
Documentation
It is critical to enter the proper value for the crossover to work. the crossovervalueinfo defines more
than one source and destination pairing for one crossover domain.
Attributes:
sourcefield: Field from which a user will copy the database field value
destfield: Field to which a user will copy the database field value
copyofnull: Boolean value, when it is TRUE , the value of the source or destination attributes will
only be set to the opposite direction attribute when its value is NULL or empty.
copyevenifsrcnull: Boolean value, if true, the destination attribute will also be set to NULL when
the source attribute is NULL or empty. If false, the destination attribute will be left as what it is
when the source attribute is NULL or empty.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 60/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
copyonlyifdestnull: Boolean value, when it is TRUE , the value of the source attribute will only be
set to destination attribute when the destination attribute's value is NULL or empty.
Use Example:
Refer to specify_crossover_domain for a further information about this sample.
<crossovervalueinfo
sourcefield="string" [1]
destfield="string" [0..1]
copyifnull="string (value comes from list: {'true'|'false'})" [0..1]
copyevenifsrcnull="string (value comes from list: {'true'|'false'})" [0..1]
copyonlyifdestnull="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: add_sigoption
Properties
Name add_sigoption
Nillable no
Abstract no
Documentation
grantapp and grantoption determine what groups should be granted application authorization for
the new sigoption . If the grant is based on STARTCNTR.READ , then groups that have READ access to
the Start Center will be authorized for the new option when the script is run.
langcode is not longer required, and actually this setting will be ignored. The code for the base
language of the database will be used. The attribute is only kept to allow existing scripts to be valid.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 61/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
visible: Indicates whether this sigoption can be granted via the Security Groups application. It will
be visible and grantable if the value is 1 and not visible if the value is 0. If it is not visible, it should
be granted and revoked along with another application by listing it in the ALSOGRANTS and
ALSOREVOKES columns.
alsogrants: List of other sigoptions that will be automatically granted when this sigoption is
selected.
alsorevokes: List of other sigoptions that will be automatically revoked when this sigoption is
deselected.
prerequisite: List of other sigoptions that must be selected before this sigoption can be selected.
grantapp: List of applications that will be automatically granted when this sigoption is selected.
grantoption: Signature Option that will be automatically granted when this sigoption is selected.
granteveryone: Automatically granted access for everyone when this sigoption is selected.
Use Example:
The sample below explain how the sigoption command can be used to grant access for the common
actions present in APPBASIC application in Maximo. Be ware about the link between some options made
through the prerequisite , alsogrants and alsorevokes attributes.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 62/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<add_sigoption
app="string" [1]
optionname="string" [1]
description="string" [1]
esigenabled="string (value comes from list: {'true'|'false'})" [0..1]
visible="string (value comes from list: {'true'|'false'})" [0..1]
alsogrants="string" [0..1]
alsorevokes="string" [0..1]
prerequisite="string" [0..1]
langcode="string" [0..1]
grantapp="string" [0..1]
grantoption="string" [0..1]
granteveryone="string (value comes from list: {'true'|'false'})" [0..1]
grantcondition="string" [0..1]
>
Start Sequence [0..1]
<longdescription> ... </longdescription> [1]
End Sequence
</add_sigoption>
Element: drop_sigoption
Properties
Name drop_sigoption
Nillable no
Abstract no
Documentation
Drop a sigoption
Attributes:
app: Signature Option Application name.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 63/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Use Example:
The follow example delete the option NEXT associated with APPBASIC application.
<drop_sigoption
app="string" [1]
optionname="string" [1]
/>
Element: create_module
Properties
Name create_module
Nillable no
Abstract no
Documentation
Attributes:
module: Maximo Module Name
menu_param: If exists, a menu param that enables some app to work with a data start point.
image: Reference for a menu image that represents the module fuctions.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 64/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Use Example:
The sample bellow refers to create an simple module application with some applications inside that
represents a group of Maximo applications grouped by purpose. Refer to the module_menu_app element,
for a furhter information about module's menu.
<create_module
module="string" [1]
description="string" [1]
menu_position="string (value comes from list: {'first'|'last'|'before'|'after'})" [0..1]
menu_param="string" [0..1]
image="string" [0..1]
>
Start Choice [1..*]
<module_menu_app> ... </module_menu_app> [1]
<module_menu_header> ... </module_menu_header> [1]
End Choice
</create_module>
Element: modify_module
Properties
Name modify_module
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 65/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
###Attributes:
menu_param: If exists, a menu param that enables some app to work with a data start point.
image: Reference for a menu image that represents the module fuctions.
Use Example:
The example below modifies the module APPBASIC created through the example create_module
previously, by adding a new module menu APPGISSERVICE .
Note that image refers to the module's image, not for the applications
<modify_module
module="string" [1]
description="string" [0..1]
menu_position="string (value comes from list: {'first'|'last'|'before'|'after'})" [0..1]
menu_pos_param="string" [0..1]
image="string" [0..1]
/>
Element: module_app
Properties
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 66/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Name module_app
Nillable no
Abstract no
Documentation
Attributes:
module: Maximo Module Name
image: Reference for a menu image that represents the module fuctions.
Use Example:
The sample bellow refers to create an simple module to an specific application named FINANCIAL .
<module_app
module="string" [1]
app="string" [1]
menu_position="string (value comes from list: {'first'|'last'|'before'|'after'})" [0..1]
menu_pos_param="string" [0..1]
image="string" [0..1]
/>
Element: drop_module
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 67/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Properties
Name drop_module
Nillable no
Abstract no
Documentation
Drop a specific module. Dropping an app will also drop related sigoption and maxmenu entries
Attributes:
module: Module's name.
Use Example:
The example bellow will drop the APPBASIC module.
<drop_module
module="string" [1]
/>
Element: create_app
Properties
Name create_app
Nillable no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 68/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Abstract no
Documentation
Attributes:
app: Application Name (Name of the .RUN file)
maintbname: Main Object name (table or view) for APP used to get JAVA MBO set.
Use Example:
The following example creates an app for the Maximo application.
<create_app
app="string" [1]
description="string" [1]
restrictions="string" [0..1]
orderby="string" [0..1]
maintbname="string" [0..1]
/>
Element: modify_app
Properties
Name modify_app
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 69/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Attributes:
app: Application Name (Name of the .RUN file)
maintbname: Main Object name (table or view) for APP used to get JAVA MBO set.
Use Example:
The foolow example handle with the main table change from the original app created through the
example in create_app element description.
<modify_app
app="string" [1]
description="string" [0..1]
restrictions="string" [0..1]
orderby="string" [0..1]
maintbname="string" [0..1]
/>
Element: drop_app
Properties
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 70/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Name drop_app
Nillable no
Abstract no
Documentation
Drop a specific application. Dropping an app will also drop related sigoption and maxmenu entries
Attributes:
app: Applications unique name.
Use Example:
The example bellow deletes the application created by the create_app element use examples section.
<drop_app
app="string" [1]
/>
Element: module_menu_app
Properties
Name module_menu_app
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 71/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
Nested element from module_app and create_module, where the menu for applications will be defined as
well as images will be associated wiht defined menus.
Attributes:
app: Applications unique name.
image: Associated image that will represents the application among the module hyperlinks.
Use Example:
For a further information about the example of this element, please refers to [create_modul
<module_menu_app
app="string" [1]
image="string" [0..1]
/>
Element: module_menu_header
Properties
Name module_menu_header
Nillable no
Abstract no
Documentation
Defines a menu header for a module/submodule application. This is an nested element, present on
create_module root element.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 72/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Attributes:
headerdescription: Header description. Will be null if this is not a header.
Use Example:
This example can also be used or refered by the create_module element, however, the complete sample
is represented by the code's snap bellow.
<module_menu_header
headerdescription="string" [1]
>
Start Sequence [1..*]
<module_menu_app> ... </module_menu_app> [1]
End Sequence
</module_menu_header>
Element: create_app_menu
Properties
Name create_app_menu
Nillable no
Abstract no
Documentation
Attributes:
app: Application's unique name.
Use Example:
The bellow example creates a menu structure that will allow de user to delete, add or edit an specific
element from the list tab of the 'MP3 Basic Application'. Once the MP3 file were selected, the user are
ablle to upload or download lirics from the main tab (The element at this time were selected and is
presenting several details) lyrics associated with this particular mp3 file. For a further information about
the nested elements of this example please refere to the app_menu_option,app_menu_header and
menu_separator elements.
<create_app_menu app="MP3BASICAPP">
<app_menu_header headerdescription="">
<app_menu_option tabdisplay="LIST" option="DELETE"/>
<app_menu_option tabdisplay="LIST" option="ADD"/>
<app_menu_option tabdisplay="LIST" option="EDIT"/>
</app_menu_header>
<app_menu_option tabdisplay="MAIN" option="DOWNLOADLYRICS"/>
<menu_separator/>
<app_menu_option tabdisplay="MAIN" option="UPLOADLYRICS"/>
</create_app_menu>
<create_app_menu
app="string" [1]
type="string (value comes from list: {'action'|'tool'|'search'})" [0..1]
>
Start Choice [1..*]
<app_menu_option> ... </app_menu_option> [1]
<menu_separator> ... </menu_separator> [1]
<app_menu_header> ... </app_menu_header> [1]
End Choice
</create_app_menu>
Element: app_menu_option
Properties
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 74/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Name app_menu_option
Nillable no
Abstract no
Documentation
Attributes:
option: Option's name associated to a Maximo Application.
tabdisplay: Indicates the tabs on which an option can be displayed (i.e. LIST | ALL | MAIN ).
Use Example:
Please refer to create_app_menu element at the use example section, for a complete menu example.
<app_menu_option
option="string" [1]
image="string" [0..1]
accesskey="string" [0..1]
tabdisplay="string (value comes from list: {'LIST'|'MAIN'|'ALL'})" [1]
/>
Element: menu_separator
Properties
Name menu_separator
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 75/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Nillable no
Abstract no
Documentation
Attributes:
tabdisplay: Indicates the tabs on which an option can be displayed (i.e. LIST | ALL | MAIN ).
Use Example:
Please refer to create_app_menu element at the use example section, for a complete menu example.
<menu_separator
tabdisplay="string (value comes from list: {'LIST'|'MAIN'|'ALL'})" [0..1]
/>
Element: app_menu_header
Properties
Name app_menu_header
Nillable no
Abstract no
Documentation
Attributes:
headerdescription: Description of the header of a sub menu that represents some group of apps.
tabdisplay: Indicates the tabs on which an option can be displayed (i.e. LIST | ALL | MAIN ).
Use Example:
Please refer to create_app_menu element at the use example section, for a complete menu example.
<app_menu_header
headerdescription="string" [1]
image="string" [0..1]
tabdisplay="string (value comes from list: {'LIST'|'MAIN'|'ALL'})" [0..1]
>
Start Choice [1..*]
<app_menu_option> ... </app_menu_option> [1]
<menu_separator> ... </menu_separator> [1]
End Choice
</app_menu_header>
Element: additional_app_menu
Properties
Name additional_app_menu
Nillable no
Abstract no
Documentation
Attributes:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 77/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Use Example:
For this example, a new menu type of an Action will be added for NEWWRKPKG application to the
WOTRACK application.
<additional_app_menu
app="string" [1]
type="string (value comes from list: {'action'|'tool'|'search'})" [0..1]
menu_position="string (value comes from list: {'first'|'last'|'before'|'after'})" [0..1]
pos_param="string" [0..1]
>
Start Choice [1..*]
<app_menu_option> ... </app_menu_option> [1]
<menu_separator> ... </menu_separator> [1]
<app_menu_header> ... </app_menu_header> [1]
End Choice
</additional_app_menu>
Element: add_service
Properties
Name add_service
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 78/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
Add a service wich will bind through a RMI service remote and local requisitions.
Attributes:
servicename: Service's unique name.
classname: Full Qualifiend Name for the java class that implements the service.
singleton: Specifies whether the session is singleton or can be different for tenant.
Use Example:
The sample bellow indicates that is necessary add a service named BASICAPPSERVICE to bound the
remote requisitions for the Basic Applications clients.
<add_service
servicename="string" [1]
description="string" [1]
classname="string" [1]
singleton="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: modify_service
Properties
Name modify_service
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 79/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
Attributes:
servicename: Service's unique name.
classname: Full Qualifiend Name for the java class that implements the service.
singleton: Specifies whether the session is singleton or can be different for tenant.
Use Example:
The sample bellow modify the BASICAPPSERVICE service description.
<modify_service
servicename="string" [1]
description="string" [0..1]
classname="string" [0..1]
singleton="string (value comes from list: {'true'|'false'})" [0..1]
/>
Element: drop_service
Properties
Name drop_service
Nillable no
Abstract no
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 80/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Documentation
Attributes:
servicename: Service's unique name.
Use Example:
The example bellow will drop the service created at add_service element named BASICAPPSERVICE .
<drop_service
servicename="string" [1]
/>
Element: add_property
Properties
Name add_property
Nillable no
Abstract no
Documentation
Attributes:
name: Property's unique name.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 81/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
scope: Represents the use scope of the property (i.e. global , instance or open ).
secure_level: Indicates the level of access permitted for this property (i.e. private , public ,
secure or mtsecure )
live_refresh: Indicates whether live refresh of cache is supported for this property.
required: When checked, indicates that a value is required for this property.
online_changes: Indicates whether the user is allowed to override the value via the Property
application.
user_defined: Indicates whether this property was delivered with Maximo or was defined by a
user.
encrypted: Indicates whether the value of the property should be encrypted when stored on the
MaxPropValue table.
masked: Identified whether this value is masked in the System Properties application
Use Example:
This sample defines a property that controls or 'allows' the user to see the logs from the server output.
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 82/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<add_property
name="string" [1]
description="string" [1]
maxtype="string (value comes from list: {'ALN'|'INTEGER'|'YORN'})" [1]
domainid="string" [0..1]
scope="string (value comes from list: {'global'|'instance'|'open'})" [0..1]
secure_level="string (value comes from list: {'private'|'public'|'secure'|'mtsecure'})" [1
live_refresh="string (value comes from list: {'true'|'false'})" [0..1]
required="string (value comes from list: {'true'|'false'})" [0..1]
online_changes="string (value comes from list: {'true'|'false'})" [0..1]
user_defined="string (value comes from list: {'true'|'false'})" [0..1]
default_value="string" [0..1]
encrypted="string (value comes from list: {'true'|'false'})" [0..1]
masked="string (value comes from list: {'true'|'false'})" [0..1]
value="string" [0..1]
valuerules="string (value comes from list: {'ONONLY'|'OFFONLY'|'INCONLY'|'DECONLY'|'NONE'}
accesstype="string (value comes from list: {'0'|'1'|'2'|'3'|'master'|'landlord'|'delta'|'t
/>
Element: set_property
Properties
Name set_property
Nillable no
Abstract no
Documentation
Attributes:
name: Property's unique name.
Use Example:
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 83/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
The follow example set to 'ON' the TESTON property added in add_property element's use example
section.
<set_property
name="string" [1]
value="string" [1]
/>
Element: drop_property
Properties
Name drop_property
Nillable no
Abstract no
Documentation
Attributes:
name: Property's unique name.
Use Example:
The follow example will drop the TESTON created on add_property element usa example section.
<drop_property name="TESTON"/>
<drop_property
name="string" [1]
/>
Element: longdescription
Properties
Name longdescription
Nillable no
Abstract no
Documentation
Use Example:
The modify_table element implements a sample with the long description field.
...
>longdescription>The log description of some element goes here. </longdescription>
...
<longdescription/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 85/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: insert
Properties
Name insert
Nillable no
Abstract no
Documentation
Attributes:
table: Target table's name.
ignore_duplicates: If checked TRUE will allow the user to insert duplicate data.
Use Example:
The follow example will insert a row into the SKDACTION table by change the attribute values
usewith and frame and will copy the rest of columns based ont he 'selectwhere' attribute relationship.
<insert
table="string" [1]
selectfrom="string" [0..1]
selectwhere="string" [0..1]
ignore_duplicates="string (value comes from list: {'true'|'false'})" [0..1]
>
<insertrow> ... </insertrow> [1..*]
</insert>
Element: insertrow
Properties
Name insertrow
Nillable no
Abstract no
Documentation
Use Example:
For a complete example with the nested element columnvalue and other parameters, please refer to
insert element.
<insertrow>
<columnvalue> ... </columnvalue> [1..*]
</insertrow>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 87/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: columnvalue
Properties
Name columnvalue
Nillable no
Abstract no
Documentation
Defines the parameter to insert a new row to into a table through the inser and insertrow elements.
Attributes:
column: Destination column.
Use Example:
For a complete example with the nested element columnvalue and other parameters, please refer to
insert element.
<columnvalue
column="string" [1]
string="string" [0..1]
fromcolumn="string" [0..1]
boolean="string (value comes from list: {'true'|'false'})" [0..1]
number="string" [0..1]
date="string (value comes from list: {'sysdate'})" [0..1]
defaultsynonym="string" [0..1]
/>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 88/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
Element: logical_relationship
Properties
Name logical_relationship
Nillable no
Abstract no
Documentation
Attributes:
object: Table's name, to be used everytime the table needs to be referred.
targetkeys: Primary keys for the target table or foren keys in this relationship.
Use Example:
<logical_relationship status="verified" object="MAXVARS" keys="VARNAME" targetobj="MAXVARTY
description="Type information for MaxVars" number="many to 1">
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 89/90
6/1/2020 DBC XML Format Techn...~https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html
<logical_relationship
object="string" [1]
keys="string" [1]
targetobj="string" [1]
targetkeys="string" [1]
status="string (value comes from list: {'unverified'|'verified'|'invalidated'})" [1]
description="string" [0..1]
number="string" [0..1]
>
Start Sequence [0..1]
<longdescription> ... </longdescription> [1]
End Sequence
</logical_relationship>
https://developer.ibm.com/static/site-id/155/maximodev/dbcguide/script.xsd.html 90/90