PDM Macro Definitions

This article contains the following topics:
casm1401
This article contains the following topics:
PDM_Macro
CA SDM builds web forms in a language named HTMPL. HTMPL extends standard HTML with references to server variables and a number of proprietary tags of the form PDM_xxx. One of these tags, PDM_MACRO, copies a named JavaScript code segment from the database into the form. Most PDM_MACRO tags invoke client-side JavaScript that builds the web forms just in time, immediately before they are presented to the user. Most web form controls are built with the PDM_MACRO tag. For example, the PDM_MACRO tag that builds the site field on the Location Detail form is coded as follows:
<PDM_MACRO NAME=dtlLookup hdr="Site" attr="site">
A PDM_MACRO tag contains one or more keyword parameters (properties). The NAME parameter is required on every PDM_MACRO to specify the name of the macro. Other parameters are required or optional depending on the macro.
Site customization of PDM_MACRO definitions stored in the database is not supported and should not be attempted.
btnEndRow
The btnEndRow macro marks the end of a group of one or more buttons displayed in a horizontal row on a form. The button row starts with either a btnStartRow macro or with a button macro with the NewRow=yes argument. The button row ends with either a btnEndRow macro or with a button macro with the EndRow=yes property. For example:
<PDM_MACRO name=btnStartRow . . .> <PDM_MACRO name=button . . .> <PDM_MACRO name=button . . .> . . . <PDM_MACRO name=btnEndRow>
This macro has no properties.
btnStartRow
The btnStartRow macro marks the start of a group of one or more buttons displayed in a horizontal row on a form. The button row starts with either a btnStartRow macro or with a button macro with the NewRow=yes argument. The button row ends with either a btnEndRow macro or with a button macro with the EndRow=yes property. For example:
<PDM_MACRO name=btnStartRow . . .> <PDM_MACRO name=button . . .> <PDM_MACRO name=button . . .> . . . <PDM_MACRO name=btnEndRow> :
This macro has the following properties:
  • centered=true|
    false
    Specifies whether the row of buttons is centered on the form. When you do not specify this property, the row of buttons is left-justified.
  • padding=
    0
    |
    number
    Specifies the number of hard (nonbreaking) spaces between buttons in the row. When you do not specify this property, buttons are placed as close together as possible.
button
The button macro defines a button that a user of a form can click to invoke an action.
This macro has the following properties:
  • btnType=negative|
    positive
    Specifies whether a button performs a positive action (such as Save) or a negative action (such as Cancel). This specification is for documentation only; specifying a button as positive or negative has no effect on the appearance or use of the button.
  • Caption=
    text
    (Required) Specifies the text for the label of the button. You can optionally end the caption with a hotkey hint enclosed in square brackets, for example, Caption=”Save[Sv]”. When you provide a hotkey hint, CA SDM selects the hotkey for the button from the characters in the hint. When you do not provide a hotkey hint, CA SDM selects the hotkey from the characters of the entire caption.
  • Disabled=true|
    false
    Specifies whether the button is disabled on the initial display. When you do not specify this property, the button is enabled.
  • EndRow=yes|
    no
    Specifies whether this button is the last of a horizontal row of buttons. If specified as EndRow=yes, CA SDM automatically inserts a btnEndRow macro after this button. When you do not specify this property, CA SDM does not configure the button as the last one in a row.
  • Func=
    string
    (Required) Specifies the JavaScript that is invoked when the user of the form clicks the button.
  • hotkey_name=
    string
    (Required) Specifies the caption for selecting a hotkey. You must specify this property and an ASCII string. CA SDM selects the hotkey for the button from the characters in the hotkey_name string. The hotkey_name macro is ignored in locales using the Latin alphabet; these locales always use the Caption to determine a hotkey.
  • ID=
    string
    (Required) Specifies a JavaScript identifier for the button.
  • NewRow=yes|
    no
    Specifies whether this button is the first of a horizontal row of buttons. When you specify NewRow=yes, the product automatically inserts a btnStartRow macro before this button. When you do not specify this property, the product does not configure the button as the first one in a row.
  • tabIndex=n|
    -1
    Specifies the HTML tabIndex for the button. TabIndex is meaningful only in relation to other HTML elements on the form with a tabIndex. A user of the form tabs from element to element in sequence by the tabIndex values of the element. When you do not specify this property, the button receives a default tabIndex.
  • Tooltip=
    string
    Specifies the tooltip text for the button. When you do not specify this property, the property defaults to the button caption.
  • Width=
    0
    |
    number
    Specifies the width of the button in pixels. If you omit this property or specify it as 0, the product creates the button exactly wide enough for its caption.
cmdbMetadata
The cmdbMetadata macro provides attribute-level metadata for the versioning, TWA viewer, and CMDBf viewers for use when displaying CI and transaction information. This metadata is used for the following purposes:
  • To categorize and provide help information about each attribute.
  • To map each MDR provider attribute name with its corresponding CA CMDB attribute name so they are displayed together. This macro does not create a UI control and typically, use it in an HTMPL file. The HTMPL file is then included in a display form, which the versioning, TWA viewer, and CMDBf viewers use.
This macro has the following properties:
  • attr=
    attributeName
    Specifies a CA CMDB attribute name. This property is required in all cases except hiding a provider attribute from the CI displays. All subsequent properties refer to the handling of this attribute. The attribute name specified must be a valid, case sensitive, CI attribute name.
  • category=
    attributeCategoryName
    Specifies the category of this attribute to group-related attributes on the versioning and CMDBf viewer attribute displays. The category is typically the tab that contains the attribute on the CI detail display. Attributes are sorted by category on those forms.
  • common=yes|
    no
    (Deprecated) Specifies whether this attribute is a common attribute (in the nr object). Do not use this property. Do not specify an extension for the metadata for common attributes.
  • currentcivalue=
    dottedNotation
    Explicitly specifies special dotted notation for the current value of the attribute. This property is required when the default dotted notation to access the current CI value is incorrect. For example, this property is required when defining common attributes, and those attributes are not in the extension table.
    For dotted notation examples, see the cmdb_metadata_common.htmpl form.
  • dbcolumn=
    UAPMcolumnName
    Specifies a UAPM database column name so that it can be associated with the specified CA CMDB attribute name.
  • extension=
    objectName
    Specifies the extension object name that contains the attribute name. This property is required when defining attributes that are in an extension table.
  • heading=
    string
    Specifies a short label that describes this attribute. Typically, you set this property the default label that the CI detail form displays.
  • help=
    string
    Specifies a brief description of the attribute.
  • hide_provider_attr=yes|
    no
    (For use with the CMDBf viewer only) Hides the provider attribute from the CMDBf viewer display when you specify YES. Requires the specification of provider_attr and either provider_name or provider_name_regexp.
  • provider_attr=
    MDRattributeName
    (For use with the CMDBf viewer only) Specifies the MDR provider attribute name that maps to the current attribute (attr). Requires the specification of attr, and either provider_name or provider_name_regexp.
  • provider_name=
    MDRname
    (For use with the CMDBf viewer only.) Specifies the MDR provider name that is associated with the MDR attribute name (provider_attr). This property specifies an exact match with a particular MDR provider name. Requires the specification of provider_attr. This property is mutually exclusive with provider_name_regexp.
  • provider_name_regexp=
    regularExpression
    (For use with the CMDBf viewer only.) Specifies the MDR provider name regular expression that is associated with the MDR attribute name (provider_attr). This property specifies a regular expression pattern to match with the MDR provider names. Regular expressions use a valid JavaScript RegExp() pattern. Requires the specification of provider_attr. For example, \"MyMdr.*\" matches all provider names starting with \"MyMdr\" such as \"MyMdr1\", \"MyMdrAbcd\", and so on. The characters \".*\" indicate to match all provider names. This property is mutually exclusive with provider_name.
  • standardcivalue=
    dottedNotation
    Explicitly specifies special dotted notation for the corresponding value of the attribute for the standard CI. This property is required when the default dotted notation to access the standard CI value is incorrect. For example, this property is required when defining common attributes, and those attributes are not in the extension table.
dtlCheckbox
The dtlCheckbox macro specifies a check box control on an HTMPL detail form. The control appears as follows:
  • A check box on the edit view of the form.
  • The text specified by the on or off properties on the read-only view.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • off=
    0
    |
    text
    Specifies the text displayed on a read-only form when the check box is not selected.
  • on=
    1
    |
    text
    Specifies the text displayed on a read-only form when the check box is selected.
  • title=
    text
    Specifies the title for screen reader users.
dtlCheckboxReadonly
The dtlCheckboxReadonly macro specifies a read-only check box control on an HTMPL detail form. The control appears as the text specified by the on or off properties on both the edit and read-only views of the form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • off=
    0
    |
    text
    Specifies the text displayed on a read-only form when the check box is not selected.
  • on=
    1
    |
    text
    Specifies the text displayed on a read-only form when the check box is selected.
dtlCheckboxWithDesc
The dtlCheckboxWithDesc macro defines a check box control with a description.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • code=
    string
    Specifies the internal value of the check box. This property is not intended for customer use.
  • desc=
    text
    Specifies the text of the description appearing after the check box.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • func=
    script
    Provides the function to select or clear the check box. This property is not intended for customer use.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • title=
    text
    Specifies the title for screen reader users.
     
  • padding=
    0
    |
    number
    Specifies the number of spaces before the check box.
  • sameCol=true|
    false
    Specifies that the check box and description are in one column. By default, the check box and description are in two columns.
  • title=
    text
    Specifies the title for screen reader users.
     
  • value
    Specifies the value of the attribute in the read-only view.
dtlDate
The dtlDate macro specifies a date control on an HTMPL detail form. A date control contains a date and time that can be edited with a date picker pop-up in the edit view of a detail form.
This macro has the following properties:
  • attr
    Specifies the name of the attribute.
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • time=
    yes
    |no
    Specifies whether the field contains both a date and time, or only a date.
dtlDateDropdown
The dtlDateDropdown macro specifies a date control on an HTMPL detail form. When empty, this field displays as a drop-down control on the edit view of the form. The drop-down control includes date selections such as "In One Day" or "In One Week". This control displays date fields with a nonempty value in the same way as the dtlDate control.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • codename=
    string
    Specifies the name of a set of values from the ui_selection object that are displayed in the date drop-down control. The values are those values with code attributes that match the value specified for codename.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
dtlDateReadonly
The dtlDateReadonly macro specifies a noneditable date control on an HTMPL detail form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • time=
    YES
    |NO
    Specifies whether the field contains both a date and time, or only a date.
dtlDropdown
The dtlDropdown macro specifies a drop-down selection control on an HTMPL detail form. The control appears as a drop-down or lookup on the edit view of the form, and as the text in the read-only view.
The CA SDM administrator can specify the maximum number of entries a drop-down list should contain (default 10); when the size of a drop-down list exceeds this number, CA SDM automatically converts the list to a lookup. You can override this behavior with the lookup property of this macro.
This macro has the following properties:
  • attr
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
     
  • autofill=
    yes
    |no
    Specifies whether the field allows autofill when it is displayed as a lookup. Autofill lets a user enter a value in the field by typing the first few characters of a value and pressing Tab. These actions cause the product to perform one of the following actions:
    • Request the full value for the field from the server.
    • Pop up a selection form when the specified value is missing or ambiguous.
     
  • cbwidth=
    0
    |
    number
    Specifies the width of the drop-down list in pixels. If omitted or specified as zero, the list automatically sizes to the width of its widest entry.
  • codename=
    string
    Specifies the name of a set of values from the ui_selection object that are displayed in the date drop-down control. The values are those values with code attributes that match the value specified for codename.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • default=
    text
    Specifies the default value when the attribute is null.
     
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • extraURL=
    string
    Specifies a where clause predicate in URL format to restrict the contents of the control.
     
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • title=
    text
    Specifies the title for screen reader users.
     
  • initial=
    value
    Specifies the initial selection in the drop-down list, overriding the value of the attribute in the database.
  • link=
    yes
    |no
    Specifies whether the control on the read-only view is a link to detail for the value of the attribute.
     
  • list_display=
    attributeName
    Specifies the common attribute name of the table. Effective only if use_list_display=1, codename is blank, and the factory, rel_attr_name, and whereclause properties are supplied.
  • list_orderby=
    attributeName
    Specifies the order of the drop-down list. Effective only if use_list_display=1, codename is blank, and the factory, rel_attr_name, and whereclause properties are supplied.
  • lookup=
    yes
    |no
    Specifies whether the field should automatically convert to a lookup if the number of entries in the drop-down list exceeds a configured value (typically 10).
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • rel_attr_name=
    attributeName
    Specifies the attribute from the referenced table that is stored. This property is required when use_list_display=1 is specified, codename is blank, and the factory, list_display, and whereclause properties are supplied.
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • title=
    text
    Specifies the title for screen reader users.
     
  • use_list_display=
    0
    |1
    Specifies whether the drop-down control should be built from an explicit query instead of from the referenced attribute. When use_list_display=1, the factory, list_display, rel_attr_name, and whereclause properties must also be supplied.
  • whereclause=
    string
    Specifies a where clause.
dtlDropdownWithDesc
The dtlDropdownWithDesc macro specifies a drop-down list on an HTMPL detail form. A caption (header) precedes the drop-down list with a text description following it.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • desc=
    text
    Specifies the description that appears after the drop-down list.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • sel_fac=
    factoryName
    Specifies a factory whose entire contents will display in the drop-down list. This property is effective only if sel_list is empty.
  • Specifies a comma-separated list of values for the drop-down. Values are specified in pairs, with the displayed value followed by the corresponding internal value. At symbols (@) delimit the individual values, except for the first and last value in the list.
  • title=
    text
    Specifies the title for screen reader users.
     
  • value=
    string
    Specifies the value of the attribute in the read-only view.
dtlEnd
The dtlEnd macro marks the end of the macros that define the contents of a detail form. This macro must be the last macro on the form. You structure all detail forms with the following code:
<PDM_MACRO name=dtlForm . . .> <PDM_MACRO name=dtlStart . . .> <PDM_MACRO name=dtlStartRow . . .> . . . <PDM_MACRO name=dtlEnd>
This macro has no properties.
dtlEndDiv
The dtlEndDiv macro marks the end of a group of detail form macros that JavaScript can show or hide. Pair this macro with a dtlStartDiv macro and use a dtlEndTable macro. For example:
<PDM_MACRO name=dtlStartDiv divid="my_div" . . .> . . . <PDM_MACRO name=dtlEndTable> <PDM_MACRO name=dtlEndDiv>
This macro has no properties.
dtlEndTable
The dtlEndTable macro marks the end of an HTML table, and is not intended for customer use. No dtlStartTable macro exists; the detail form table automatically starts and ends HTML tables as required for the layout. A dtlEndTable macro is required only when a macro group must be separated into HTML blocks, such as when dtlStartDiv and dtlEndDiv create a division.
dtlEndTable has no properties.
dtlForm
The dtlForm macro marks the beginning of the macros that define the contents of a detail form. This macro must be the first macro on the form. All detail forms must be structured with the following code:
<PDM_MACRO name=dtlForm . . .> <PDM_MACRO name=dtlStart . . .> <PDM_MACRO name=dtlStartRow . . .> . . . <PDM_MACRO name=dtlEnd>
This macro has the following properties:
  • button=
    true
    |false
    Specifies whether to show the default buttons on the edit view and the Edit button on the read-only view. The default buttons are Save, Cancel, and Reset.
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hideeditbtn=true|
    false
    Specifies whether to hide the Edit button in the read-only view.
  • onsubmit=
    script
    Overrides the default form submit handler. The default handler is sufficient for most cases.
  • saveclose=true|
    false
    Specifies whether to show a "Save and Close" button in the edit view.
  • skip_tenant_hdr=yes|
    no
    Specifies whether to suppress the tenant field at the header of the form.
  • skiphdr=yes|
    no
    Specifies whether to skip standard form headers, such as default buttons.
dtlHier
The dtlHier macro specifies a hierarchical lookup control on a detail form. In the edit view, a user can click the caption (header) of the control to pop up a hierarchical selection form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
     
  • autofill=
    yes
    |no
    Specifies whether the field allows autofill when it is displayed as a lookup. Autofill lets a user enter a value in the field by typing the first few characters of a value and pressing Tab. These actions cause the product to perform one of the following actions:
    • Request the full value for the field from the server.
    • Pop up a selection form when the specified value is missing or ambiguous.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • common_name=
    attributeName
    Specifies the name of the attribute from the referenced table that should be displayed on the detail form. This macro is not intended for customer use.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
dtlHTMLEditbox
The dtlHTMLEditbox macro defines an HTML edit field in a detail form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • bound=
    yes
    |no
    Specifies whether the control is bound to an attribute.
  • className=
    value
    Specifies a style sheet class.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • escape=
    JS2
    |C|JS|HTML
    Specifies how data is escaped in the read-only view. This property is not intended for customer use.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • maxlength=
    number
    Specifies the maximum length of the edit field.
     
  • optionid=
    string
    Specifies the JavaScript identification of the HTML edit field control. This property is not intended for customer use.
  • persid=
    value
    Specifies the persistent identifier of the object displayed in the edit field. This property is not intended for customer use.
  • preview=
    yes
    |no
    Specifies whether the edit field supports Quick View mode.
  • readonly=yes|
    no
    Specifies whether the HTML editor is read-only. This property is ignored unless bound=no.
  • rows=1|number
    Specifies the number of rows on the form occupied by the textbox.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • spellchk=yes|
    no
    Specifies whether to display a Spell button next to the field label in the edit view.
     
  • tenant=
    value
    Specifies the internal identification (UUID) of the tenant. This property is not intended for customer use.
  • tenantName=
    value
    Specifies the name of the tenant. This property is not intended for customer use.
  • toolbar=
    default
    |reportcard|tmpl
    Specifies the set of HTML editing tools displayed in the edit field. This property has the following possible values:
    • default -- the default toolbar set
    • reportcard -- a toolbar set appropriate for the knowledge report card
    • tmpl -- a toolbar set appropriate for the document template editor
dtlLookup
The dtlLookup macro specifies a lookup control on a detail form. In the edit view, a user can click the caption (header) of the control to pop up a selection form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • autofill=
    yes
    |no
    Specifies whether the field allows autofill when it is displayed as a lookup. Autofill lets a user enter a value in the field by typing the first few characters of a value and pressing Tab. These actions cause the product to perform one of the following actions:
    • Request the full value for the field from the server.
    • Pop up a selection form when the specified value is missing or ambiguous.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • common_name_attr=
    attributeName
    Specifies the name of the attribute from the referenced table to display on the detail form. This property is not intended for customer use.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • extraURL=
    string
    Specifies a where clause predicate in URL format to restrict the contents of the control.
     
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • link=
    yes
    |no
    Specifies whether the control on the read-only view is a link to detail for the value of the attribute.
     
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
dtlLookupReadonly
The dtlLookupReadonly macro specifies a read-only lookup control on an HTMPL detail form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • link=
    yes
    |no
    Specifies whether the control on the read-only view is a link to detail for the value of the attribute.
     
dtlLrelMultiselbox
The dtlLrelMultiselbox macro displays a multiselect field (side-by-side selection) control for a many-to-many selection form. This macro displays a set of input controls, including the following:
  • A left-side multiselect field and its header
  • A right-side multiselect field and its header
  • Two select buttons between the multiselect fields
  • Pagination text below the multiselect fields if any
  • Two Clear Selection buttons at the bottom of the multiselect fields
This macro has the following properties:
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
dtlRadio
The dtlRadio macro displays a group of option button controls with optional text following the control.
This macro has the following properties:
  • actcode=
    string
    Specifies the action code.
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • codename=
    string
    (Required) Specifies the name of a set of values from the ui_selection object that are displayed in the date drop-down list control. These values have code attributes that match the value specified for codename.
  • dataclass=
    string
    Specifies the CSS class name used for the text of the option button.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • title=
    text
    Specifies the title for screen reader users.
     
  • sameRow=true|
    false
    Specifies whether to display the option buttons on the same row.
  • title=
    text
    Specifies the title for screen reader users.
     
Example: dtlRadio
NX_ROOT\bopcfg\www\htmpl\web\analyst\detaikl_pri_cal.htmpl file has the following use of the macro:
<PDM_MACRO name=dtlRadio hdr="Duplicate Ticket Action" attr="action" actcode="$args.action" codename="dupActions">
dtlReadonly
The dtlReadonly macro specifies a read-only textbox on an HTMPL detail form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • fmtfunc=
    name
    Specifies the name of a JavaScript function that formats the field for display. The function is passed a single argument containing the value of the attribute, and must return a string that is displayed on the form.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • hdrclass=
    text
    Specifies the CSS class used to format the caption. This property is not intended for customer use.
  • title=
    text
    Specifies the title for screen reader users.
     
  • inline=yes|
    no
    Specifies whether the header text and the data are on the same line, separated by a colon (:). Use this property only when attr="n/a".
  • value=
    value
    Specifies the value displayed on the form when attr="n/a".
dtlShowtext
The dtlShowtext macro displays plain text on the form without any label or header that is associated with the text. This macro lets you do the following activities:
  • Associate the text to display with an attribute.
  • Format and display the text when needed.
  • Show a bar image below the text.
This macro has the following properties:
  • argumts=
    string
    Specifies the arguments that are passed to the fmtmsg format function.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • dataclass=pageHeader|hdr|required|alertmsg|className
    Specifies the CSS class that is applied to displayed text.
  • fmtmsg=
    string
    Specifies the name of the function to format the text for display. The arguments for this function are specified in the argumts parameter. The function must return a text string that is the value displayed.
  • keeplinks=yes|
    no
    Specifies whether HTML links (Action: tags) are displayed as links or formatted as raw text. Preserves HTML links when the text to display contains HTML links. The default value is no.
     
  • keeptags=yes|
    no
    Specifies whether HTML tags are interpreted as HTML links or formatted as raw text. keeptags=yes overrides the keeplinks property.
     
  • showbarimg=yes|
    no
    Specifies whether to display a bar image below the text.
  • value=
    text
    (Required) Specifies the value to display. The value can be associated to an attribute.
Example: dtlShowtext
NX_ROOT\bopcfg\www\htmpl\web\analyst\detaikl_pri_cal.htmpl file uses the following macro:
<PDM_MACRO name=dtlShowtext colspan=6 dataclass=hdr value="Priority Calculation Options">
  • Colspan
    Specifies the number of field columns we want to span.
  • Dataclass
    Specifies the css we want to apply for the text.
  • Value
    Specifies the displayed text value.
dtlStart
The dtlStart macro begins a detail form, and must be the second macro on the form. Structure all detail forms with the following code:
<PDM_MACRO name=dtlForm . . .> <PDM_MACRO name=dtlStart . . .> <PDM_MACRO name=dtlStartRow . . .> . . . <PDM_MACRO name=dtlEnd>
This macro has the following properties:
  • center=true|
    false
    Specifies whether the form is centered.
  • scroll=true|
    false
    Specifies whether the form always has a scroll bar.
dtlStartDiv
The dtlStartDiv macro marks the beginning of a group of detail form macros that JavaScript can show or hide. Pair this macro with a dtlEndDiv macro. For example:
<PDM_MACRO name=dtlStartDiv divid="my_div". . .> . . . <PDM_MACRO name=dtlEndTable> <PDM_MACRO name=dtlEndDiv>
This macro has the following properties:
  • align=
    left
    |center|right
    Specifies the alignment of the DIV.
  • class=
    className
    Specifies the CSS class of the DIV.
  • divid=
    string
    (Required) Specifies the JavaScript identification of the DIV.
  • style=
    string
    Specifies the style of the DIV.
dtlStartExpRow
The dtlStartExpRow macro specifies the start of an expandable row on a detail form. An expandable row lets the user hide the row controls by clicking the title bar of the row.
This macro has the following properties:
  • class=
    className
    Specifies the CSS class of the HTML table containing the controls in the new row.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • exp_rows="1,2,…"
    Specifies the row numbers in the expandable section as a quoted string containing a sequence of numbers from 1 to
    N
    .
    N
    represents the number of rows desired in the expandable section. The section includes the controls following dtlStartExpRow, and the next n-1 dtlStartRow macros.
  • form_name=
    name
    Specifies the name of the containing HTMPL file name without the htmpl extension. The name value is the name of the file. When the expandable section is in a tab, this argument specifies the name of the file containing the tab.
  • label=
    string
    Specifies the label shown on the expandable section bar.
dtlStartRow
The dtlStartRow macro marks the start of a row on a detail form.
This macro has the following properties:
  • class=
    className
    Specifies the CSS class of the HTML table containing the controls in the new row.
  • hrClass=
    className
    Specifies the CSS class of an optional dividing line. This property is effective only when hrSpan specifies a nonzero value.
  • hrSpan=
    0
    |
    number
    Specifies the number of columns spanned by an optional dividing line above the new row. The default value of zero specifies no dividing line.
dtlSurvey
The dtlSurvey macro displays multiple choice answers for each survey question. Survey questions can accept single answers for which option buttons are displayed or can accept multiple answers for which check boxes are displayed. You can use this macro in survey forms like preview risk survey, submit risk survey, and view submitted survey.
This macro has the following properties:
  • answerselected=
    number
    Specifies the index of the selected answer.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • factory=
    name
    Specifies the factory containing the survey, usually risk_svy_atpl.
  • parentid=
    number
    Specifies the database id of the question, usually $question.id.
  • parentmultiflag=
    number
    Specifies whether to display a check box or a option button. This value is usually $question.mult_resp_flag.
  • parentsequence=
    number
    Specifies the question sequence. This value is usually $question.sequence.
  • view=
    preview
    |doview|viewsubmitted
    Specifies the survey view to display. You can specify any of the following views:
    • preview -- specifies to display preview survey page
    • doview -- specifies to display survey page which is ready to be submitted
    • viewsubmitted -- specifies to display the previously submitted survey page
dtlTextbox
The dtlTextbox macro specifies a text field on a detail form. In the edit view, the field allows entry of free-form text.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • disp_entities=yes|
    no
    Specifies whether to display HTML entities (for example, &amp; or &#26237) in read-only view. If disp_entities=no, HTML entities are displayed exactly as entered; if disp_entities=yes, HTML entities are converted to their external value.
  • evt=
    ”eventName=’script’”
    Specifies one or more HTML event handlers in the same way you specify them in an HTML statement, with quotes escaped as required. For example:
    evt="onclick='myfunc()' onchange=\\\"myfunc2()\\\""
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • title=
    text
    Specifies the title for screen reader users.
     
  • JSButton=function()
    Specifies a JavaScript function that creates a button next to the header of the control.
  • keeplinks=yes|
    no
    Specifies whether HTML links (Action: tags) are displayed as links or formatted as raw text. Preserves HTML links when the text to display contains HTML links. The default value is no.
     
  • keeptags=yes|
    no
    Specifies whether HTML tags are interpreted as HTML links or formatted as raw text. keeptags=yes overrides the keeplinks property.
     
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • maxlength=
    number
    Specifies the maximum length of the edit field.
     
  • password=yes|
    no
    Specifies whether the text field contains a password field. CA SDM replaces passwords with a string of asterisks in both the edit and read-only views.
  • rows=1|number
    Specifies the number of rows on the form occupied by the textbox.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • spellchk=yes|
    no
    Specifies whether to display a Spell button next to the field label in the edit view.
     
  • srchknow=yes|
    no
    Specifies whether to display a search knowledge button next to the field label.
  • title=
    text
    Specifies the title for screen reader users.
     
  • value=
    text
    Specifies the value to display when the value cannot be retrieved from the attribute.
dtlWriteproperty
The dtlWriteproperty macro specifies a custom property for a change or issue category, or a request, incident, or problem area. Properties appear on the properties tab of the respective tickets. This macro formats a single property with the label on the left, input field value in the middle, and a sample value on the right. The Input field can be a textbox, drop-down list, or a check box.
This macro has the following properties:
  • label=prop
    n
    .label
    Specifies a label for the property, in the form propn.label. n is the property number specified in the propNum argument.
  • make_required=YES|
    NO
    Makes a field required when you specify YES regardless of whether the associated attribute is required at the object level. A required field forces the user to specify a nonblank value.
     
  • propNum
    (Required) Specifies a number for the property. Properties are displayed in sequence by property number.
  • sample=prop
    n
    .sample
    Specifies an example of a value for the property, in the form propn.sample. n is the property number specified in the propNum argument.
  • validation_rule=prop
    n
    .validation_rule.id
    Specifies the validation rule for the property, in the form propn.validation_rule.id. n is the property number specified in the propNum argument.
  • validation_type=prop
    n
    .validation_type
    Specifies the validation type for the property, in the form propn.validation_type. n is the property number specified in the propNum argument.
  • value=prop
    n
    .sample
    Specifies the value of the property. n is the property number specified in the propNum argument.
ebr_search_filter
The ebr_search_filter macro specifies an Advanced filter for a related knowledge search. This macro is not intended for customer use.
This macro has the following properties:
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • order_by=
    true
    |false
    Specifies whether the filter should include an Order by combo box.
  • view=Architect|
    Generic
    |Knowledge
    Specifies whether the filter should be displayed in a Knowledge tab, an Architect tab, or generically (any tab except Knowledge or Architect).
elsEditField
The elsEditField macro specifies an editable field for the Edit in List feature of a list form. You specify that a list form has the Edit in List feature by including the elsStartEdit and elsEndEdit macros. You define the fields on the Edit in List form with one or more elsEditField and elsEditReadOnly macros. For example:
<PDM_MACRO name=elsStartEdit search_filter="__search_filter"> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditReadonly . . .> . . . <PDM_MACRO name=elseEndEdit>
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • datatype=0
    Specifies the data type for input validation. The only datatype supported is 0, which causes the field to be validated as an integer.
  • EndRow=yes|
    no
    Specifies whether the field is the last one in a row on the Edit in List form. Specifying EndRow=yes causes CA SDM to display the next field on a new line of the form.
     
  • extraEvt=function()
    Specifies a JavaScript function that is called as an onchange event handler when a user modifies the field.
  • extraURL=
    string
    Specifies a where clause predicate in URL format to restrict the contents of the control.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • StartRow=yes|
    no
    Specifies whether the field starts a new row on the Edit in List form.
     
elsEditReadonly
The elsEditReadonly macro specifies a read-only field for the Edit in List feature of a list form. You specify that a list form has the Edit in List feature by including the elsStartEdit and elsEndEdit macros. You define the fields on the Edit in List form with one or more elsEditField and elsEditReadOnly macros. For example:
<PDM_MACRO name=elsStartEdit search_filter="__search_filter"> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditReadonly . . .> . . . <PDM_MACRO name=elseEndEdit>
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • EndRow=yes|
    no
    Specifies whether the field is the last one in a row on the Edit in List form. Specifying EndRow=yes causes CA SDM to display the next field on a new line of the form.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • StartRow=yes|
    no
    Specifies whether the field starts a new row on the Edit in List form.
     
elsEndEdit
The elsEndEdit macro marks the end of the fields specified for the Edit in List feature of a list form. You specify that a list form has the Edit in List feature by including the elsStartEdit and elsEndEdit macros. You define the fields on the Edit in List form with one or more elsEditField and elsEditReadOnly macros. For example:
<PDM_MACRO name=elsStartEdit search_filter="__search_filter"> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditReadonly . . .> . . . <PDM_MACRO name=elseEndEdit>
This macro has no properties.
elsStartEdit
The elsStartEdit macro activates the Edit in List feature of a list form, and marks the start of the list of fields. You specify that a list form has the Edit in List feature by including the elsStartEdit and elsEndEdit macros. You define the fields on the Edit in List form with one or more elsEditField and elsEditReadOnly macros. For example:
<PDM_MACRO name=elsStartEdit search_filter="__search_filter"> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditField . . .> <PDM_MACRO name=elsEditReadonly . . .> . . . <PDM_MACRO name=elseEndEdit>
This macro has the following properties:
  • search_filter="__search_filter"
    (Required) Specifies the JavaScript object name of the search filter. Specify this property exactly as shown.
endFrameset
The endFrameset macro marks the end of a frameset definition. You define a page of the frame with the startFrameset, endFrameset, and frame macros. For example:
<PDM_MACRO name=startFrameset. . .> <PDM_MACRO name=frame. . .> <PDM_MACRO name=frame. . .> . . . <PDM_MACRO name=endFrameset>
This macro has no properties.
endMenu
The endMenu macro marks the end of a menu within a menubar definition. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has no properties.
endMenubar
The endMenubar macro marks the end of definition of a menubar, and is followed by the definitions of the menus on the menubar. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has no properties.
endNotebook
The endNotebook macro marks the end of the definition of a notebook on a detail page. Only one notebook can exist on a page and it must be the last item on the page. You define a notebook with the startNotebook, startTabGroup, tab, and endNotebook macros. For example:
<PDM_MACRO name=startNotebook. . .> <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=endNotebook>
This macro has no properties.
frame
The frame macro specifies a frame on a frameset page. You define a frameset page with the startFrameset, frameab, and endFrameset macros. For example:
<PDM_MACRO name=startFrameset. . .> <PDM_MACRO name=frame . .> <PDM_MACRO name=frame . .> . . . <PDM_MACRO name=endFrameset >
This macro has the following properties:
  • extra=
    string
    Specifies a string of keywords in the same way as in an HTML <frame> statement, with quotes escaped as required.
  • frame_name=
    name
    (Required) Specifies a name for the frame (the "name" argument on an HTML <frame> statement).
  • frameborder=
    yes
    |no
    Specifies whether the frame has a border (the "frameborder" argument on an HTML <frame> statement).
  • id=
    name
    (Required) Specifies the JavaScript ID of the frame (the "id" argument on an HTML <frame> statement).
  • marginheight=
    number
    Specifies the size of the top and bottom margins (the "marginheight" argument on an HTML <frame> statement).
  • marginwidth=
    number
    Specifies the size of the top and bottom margins (the "marginwidth" argument on an HTML <frame> statement).
  • noresize=true|
    false
    Specifies whether the frame is resizable (the "noresize" keyword on an HTML <frame> statement).
  • scrolling=
    auto
    |yes|no
    Specifies whether the frame has a scroll bar (the "scrolling" argument on an HTML <frame> statement).
  • style=
    string
    Specifies CSS style information for the frame (the "style" argument on an HTML <frame> statement).
  • tabindex=
    number
    Specifies the tab index of the frame (the "tabindex" argument on an HTML <frame> statement).
  • title=
    text
    Specifies the title for screen reader users.
     
  • web_form_name=
    string
    Specifies the code name of an object in the web_form factory where CA SDM can obtain the URL for the form displayed in the frame. This property is effective only when web_form_url is not specified.
  • web_form_url=
    string
    Specifies the URL of the form that displays in the frame.
kt_Categories_Tree
The kt_Categories_Tree macro creates a knowledge category frame.
This macro has the following properties:
  • frameborder=
    0
    |
    number
    Specifies the size of the border.
  • height=
    100px
    |
    value
    Specifies the frame height.
  • iframe=
    yes
    |no
    Specifies whether to generate an iframe for the tree. Specify iframe=no when you are using a predefined frame.
  • menu=
    name
    Specifies the tree menu type. Specify adm_tree, DOCUMENT_EDITOR, HTML_EDITOR, ATTACHMENTS_IMAGES, ATTACHMENTS_TAB, ATTACHMENTS_ADMIN, ARCHITECT, or FAQ.
  • ParentTenant=
    value
    Specifies the parent tenant. Typically, you code this property as ParentTenant="$args.ParentTenant"
  • tabindex=
    number
    Specifies the tab index of the frame.
  • UseTenant=
    0
    |1
    Specifies whether to use a tenant.
  • view=
    ArchitectTree
    |FAQ
    Specifies the view: ArchitectTree or FAQ.
  • width=
    100px
    |
    value
    Specifies the frame width.
lsCol
The lsCol macro specifies a column on a list form. You define the contents of a list form with the lsStart, lsCol, and lsEnd macros. You can optionally include lsWrite and lsExport macros. For example:
<PDM_MACRO name=lsStart. . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsWrite . .> <PDM_MACRO name=lsCol . .> . . . <PDM_MACRO name=lsEnd>
HTML for the entire list is output by the lsEnd macro. The other list macros save information used by lsEnd to generate the list.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
    This property is not used and is ignored. This property is retained for compatibility with previous releases.
  • common_name_option=
    yes
    |no
    Specifies whether the column contains an SREL attribute. The common name of the referenced table when the list is exported replaces the attribute value.
  • disp_entities=yes|
    no
    Specifies whether to display HTML entities (for example, &amp; or &#26237 in read-only view. This property has the following values:
    • YES
      -- HTML entities are converted to their external value.
    • NO
      -- HTML entities are displayed exactly as entered.
  • display_attr=
    COMMON_NAME
    |attrName
    Specifies the column from the referenced table that is displayed on the list for columns containing an SREL attribute. This property is ignored for columns that are not SRELs.
  • escape=
    C
    |HTML|JS|JS2
    Specifies how the value of the column is escaped. This property has the following values:
    • C
      -- Prefix quotes, backslashes, and newlines with a backslash
    • HTML
      -- Convert quote, backslash, '<', and '>' to HTML entities
    • JS
      -- Convert quote, backslash, and newline to JavaScript hex (%nn)
    • JS2
      -- Same as JS, but also convert '%' to '%25'
  • export=
    yes
    |no
    Specifies whether this column is exported when the user clicks the Export button.
  • export_hdr_default
    Specifies the default header text. The list result export uses this property.
  • exportFmt=
    function
    Specifies the name of a JavaScript function (without parentheses) that returns a string format code which controls formatting the column when it is exported. This property has the following function values:
    • "YES_NO"
      -- Return either "yes" or "no"
    • "FACTORY_LINK"
      -- No formatting (reserved for future use)
    • "LIST_LOOKUP:v1,v1a,v2,v2a,.."
      -- Convert from a list. A value matching the first element in a pair is converted to the second element in the pair.
  • exportHdr=
    text
    |DISPLAY_NAME
    Specifies the header for the column when it is exported. You can specify the value as explicit text, or as the keyword value DISPLAY_NAME, which sets the header to the value of export_hdr_default.
  • export_hdr_default=
    text
    Specifies the text of the export column header when exportHdr has the keyword value DISPLAY_NAME. You rarely must specify this property, which defaults to the display name of the attribute for the column.
  • fmtfunc=
    function
    Specifies the name of a JavaScript function that formats the field for display. The function is passed as a single argument containing the value of the attribute, and must return a string that is displayed on the form.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • hidden=yes|
    no
    Specifies whether the column is invisible. A hidden column can be useful for Edit in List or export.
  • img=
    name
    Specifies a JavaScript variable containing the URL of an image to display in the column. Set the JavaScript variable with a preceding lsWrite macro.
  • justify=
    left
    |center|right
    Specifies the position of content within the columns.
  • keeplinks=yes|
    no
    Specifies whether HTML links (Action: tags) are displayed as links or formatted as raw text. Preserves HTML links when the text to display contains HTML links. The default value is no.
     
  • keeptags=yes|
    no
    Specifies whether HTML tags are interpreted as HTML links or formatted as raw text. keeptags=yes overrides the keeplinks property.
     
  • label=
    string
    Specifies text for a label positioned to the left of data.
     
  • link=
    yes
    |no
    Specifies whether the control on the read-only view is a link to detail for the value of the attribute.
     
  • max_char=
    0
    |
    number
    Specifies the maximum number of characters to display in column.
  • nowrap=yes|
    no
    Specifies whether to suppress wrapping of text in a call. When you specify nowrap=yes, text for the column is not permitted to wrap to multiple lines.
  • required=yes|
    no
    Specifies whether text must appear in the column. When you specify required=yes and the attribute has no value, its value is replaced with "Not Available."
  • sort=
    ASC
    |DESC|no
    Specifies the sort sequence of the list when a user clicks the column as follows:
    • ASC (ascending)
    • DESC (descending)
    • no (column is not a sort column)
  • startrow=yes|
    no
    Specifies whether the column is the first one in the expansion section. This property works as follows:
    • Columns defined by lsCol macros prior to one specifying startrow=yes are displayed on the main portion of the list.
    • Columns defined by the lsCol macro specifying startrow=yes are included in the expansion section that is hidden from view unless the user clicks the plus sign at the beginning of the list row.
    • The startrow property is effective only for the first lsCol macro specifying startcol=yes; it is ignored on subsequent lsCol macros.
  • style=
    string
    Specifies CSS formatting for the column.
  • uid=
    string
    Specifies an additional identifier to distinguish between columns with the same attribute. This property is not intended for customer use.
  • width=
    0
    |
    number
    Specifies the maximum width of a column.
lsEnd
The lsEnd macro marks the end of a list form specification. You define the contents of a list form with the lsStart, lsCol, and lsEnd macros. You can optionally include lsWrite and lsExport macros. For example:
<PDM_MACRO name=lsStart. . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsWrite . .> <PDM_MACRO name=lsCol . .> . . . <PDM_MACRO name=lsEnd>
HTML for the entire list is output by the lsEnd macro. The other list macros save information used by lsEnd to generate the list.
This macro has the following properties:
  • alt_data_src=
    name
    Specifies the name of a JavaScript variable containing the contents of the list. This property is used to display data from a source other than the database. For example:
    var alternative_source = new Array(); var row1 = new Object(); row1. column0 = "column0"; row1. column1 = 4; alternative_source[0] = row1; ...... <PDM_MACRO name=lsEnd alt_data_src=alternative_source>
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • isTicketFactory=
    0
    |1
    Specifies a list of tickets (requests, incidents, problems, changes, or issues).
  • list=
    name
    Specifies the source variable of a database list. This property is not intended for customer use.
  • sort=
    attributeName
    Specifies the initial sort sequence of the list.
  • start=
    number
    Specifies the ordinal number of the first row of the list to display. This property is not intended for customer use.
lsExport
Use the lsExport macro in place of lsCol to specify a column for a list form that is not included in the web UI list. However, this column is included in the spreadsheet generated by exporting the list. You define the contents of a list form with the lsStart, lsCol, and lsEnd macros. You can optionally include lsWrite and lsExport macros. For example:
<PDM_MACRO name=lsStart. . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsWrite . .> <PDM_MACRO name=lsCol . .> . . . <PDM_MACRO name=lsEnd>
HTML for the entire list is output by the lsEnd macro. The other list macros save information used by lsEnd to generate the list.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • common_name_option=
    yes
    |no
    Specifies whether the column contains an SREL attribute. The common name of the referenced table replaces this attribute value when the list is exported.
  • export=
    yes
    |no
    Specifies whether this column is exported when the user clicks the Export button.
  • export_hdr_default
    Specifies the text of the header.
  • exportFmt=
    function
    Specifies the name of a JavaScript function (without parentheses) that returns a string format code used to control formatting the column when it is exported. The function can return the following values:
    • "YES_NO" -- Return either "yes" or "no"
    • "FACTORY_LINK" -- No formatting (reserved for future use)
    • "LIST_LOOKUP:v1,v1a,v2,v2a,.." -- Convert from a list. A value matching the first element in a pair is converted to the second element in the pair.
  • exportHdr=
    text
    |DISPLAY_NAME
    Specifies the header for the column when it is exported. You can specify the value as explicit text, or as the keyword value DISPLAY_NAME, which sets the header to the value of export_hdr_default.
  • export_hdr_default=
    text
    Specifies the text of the export column header when exportHdr has the keyword value DISPLAY_NAME. You rarely must specify this property, which defaults to the display name of the attribute of the column.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • label=
    string
    Specifies text for a label positioned to the left of data.
     
lsStart
The lsStart macro marks the beginning of a list form specification. You define the contents of a list form with the lsStart, lsCol, and lsEnd macros, and can optionally include lsWrite and lsExport macros. For example:
<PDM_MACRO name=lsStart. . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsWrite . .> <PDM_MACRO name=lsCol . .> . . . <PDM_MACRO name=lsEnd>
HTML for the entire list is output by the lsEnd macro. The other list macros save information used by lsEnd to generate the list.
This macro has the following properties:
  • search_type=
    DISPLAY
    |GET_DOB
    Specifies how data for the list is retrieved. The default of DISPLAY causes all data to be retrieved directly from the database. The alternate value of GET_DOB causes data to be formatted by the object engine (domsrvr), and may be required if the list includes local attributes not stored in the database. A specification of search_type=GET_DOB reduces the performance of the list form, and only use it when necessary.
lsWrite
The lsWrite macro specifies JavaScript code executed for every row of a list. The text specified by lsWrite is inserted into the HTML form multiple times, once for each row of the list. You define the contents of a list form with the lsStart, lsCol, and lsEnd macros. You can optionally include lsWrite and lsExport macros. For example:
<PDM_MACRO name=lsStart. . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsCol . .> <PDM_MACRO name=lsWrite . .> <PDM_MACRO name=lsCol . .> . . . <PDM_MACRO name=lsEnd>
HTML for the entire list is output by the lsEnd macro. The other list macros save information used by lsEnd to generate the list.
This macro has the following properties:
  • both=yes|
    no
    Specifies whether the JavaScript text defined by the macro is inserted before the list and for every row on the list.
  • text=
    script
    Specifies the text to insert.
menubarItem
The menubarItem macro defines an item on a menubar. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has the following properties:
  • hotkey=
    string
    Provides a hotkey suggestion for this menubar item. CA SDM selects the hotkey for the menubar item from the characters in the string; otherwise, it selects the hotkey from the characters in the label.
     
  • id=
    name
    (Required) Specifies a JavaScript identifier for the menubar item.
    The startMenu macro references this identifier. The startMenu macro defines the contents of the menu dropped down from the menubar for this item.
  • img=
    url
    Specifies the URL of an image to display on the toolbar section of the menubar.
  • label=
    text
    (Required) Specifies the text of the menu bar item.
  • variable=
    name
    Specifies a JavaScript variable that can be used to reference the menubar item. This property is not intended for customer use.
menuItem
The menubarItem macro defines an item on a menu. The item invokes a JavaScript function in the main CA SDM form, even if the menu is in a pop-up form. Use the menuitemLocal macro to invoke a local function. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has the following properties:
  • extended=
    0
    |1
    Specifies whether this item is an extended menu item supporting disabling, hiding, and changing an image.
  • function=
    script
    (Required) Specifies the JavaScript function invoked when the menu item is selected. This function must be available in the main CA SDM form, and not in the pop-up form containing the menu. Menu items invoking functions in the pop-up form should be defined with the menuitemLocal macro.
  • hotkey=
    string
    Provides a hotkey suggestion for this menubar item. CA SDM selects the hotkey for the menubar item from the characters in the string; otherwise, it selects the hotkey from the characters in the label.
     
  • icon_name=
    string
    Specifies the name of an image file displayed as an icon on the menu next to the menu item.
  • id=
    name
    Specifies a JavaScript ID for the menu item.
  • label=
    text
    (Required) Specifies the text of the menu item.
  • local=
    0
    |1
    Specifies whether extended menus use the function in the local frame. This property is not intended for customer use.
  • tooltip=
    string
    Specifies a tooltip for the icon.
menuItemLocal
The menuItemLocal macro defines an item on a menu that invokes a JavaScript function in the form containing the menu. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has the following properties:
  • function=
    script
    (Required) Specifies the JavaScript function invoked when the menu item is selected. This function must be available in the form containing the menu.
  • hotkey=
    string
    Provides a hotkey suggestion for this menubar item. CA SDM selects the hotkey for the menubar item from the characters in the string; otherwise, it selects the hotkey from the characters in the label.
     
  • icon_name=
    string
    Specifies the name of an image file displayed as an icon on the menu next to the menu item.
  • id=
    name
    Specifies a JavaScript ID for the menu item.
  • label=
    text
    (Required) Specifies the text of the menu item.
  • tooltip=
    string
    Specifies a tooltip for the icon.
priMatrix
The priMatrix macro specifies a priority calculation matrix.
This macro has the following properties:
  • impact_label=
    name
    Specifies an impact label.
  • matrix_name=
    name
    (Required) Specifies the name of this matrix.
  • reset_btn_name=
    name
    Specifies a reset button name.
  • urgency_label=
    name
    Specifies an urgency label.
schedAttr
The schedAttr macro specifies an attribute included on a schedule form, either the change schedule (list_chgsched_config.htmpl) or the knowledge schedule (list_kdsched_config.htmpl). You define a schedule form with the schedConfig, schedAttr, and schedGroup macros. For example:
<PDM_MACRO name=schedConfig. . .> <PDM_MACRO name=schedAttr . .> <PDM_MACRO name=schedAttr . .> . . . <PDM_MACRO name=schedGroup . .> <PDM_MACRO name=schedGroup . .> . . .
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • attrRef=
    .COMMON_NAME
    |attributeName
    Specifies the attribute in the table referenced by an SREL attribute that should be shown on the schedule.
  • detail=0|
    1
    Specifies whether to include the attribute in the detailed n-day view.
  • fmtfunc=
    none
    |function
    Specifies the name of a JavaScript function that formats the field for display. The function is passed a single argument containing the value of the attribute, and must return a string that is displayed on the form.
  • hoverInfo=
    0
    |1
    Specifies whether to include the attribute in the monthly view info pop-up.
  • ident=
    0
    |1
    Specifies whether to include the group name on the n-day view.
  • label=0|string|
    $args.&{attr].DISPLAY_NAME
    Specifies a label for the attribute. A value of zero signifies no label; the default is the display name of the attribute.
  • summary=
    0
    |1
    Specifies whether to include the attribute in the summary n-day view.
schedConfig
The schedConfig macro controls the appearance and contents of a schedule form, either the change schedule (list_chgsched_config.htmpl) or the knowledge schedule (list_kdsched_config.htmpl). You define a schedule form with the schedConfig, schedAttr, and schedGroup macrosle. For example:
<PDM_MACRO name=schedConfig. . .> <PDM_MACRO name=schedAttr . .> <PDM_MACRO name=schedAttr . .> . . . <PDM_MACRO name=schedGroup . .> <PDM_MACRO name=schedGroup . .> . . .
This macro has the following properties:
  • autoSearch=0|1
    Specifies whether to reissue a search automatically if necessary.
  • defaultView=0|1|7|
    30
    |99
    Specifies the initial view as 1 (day), 7 (week), 30 (month), 99 (
    n
    day), or 0 (list).
  • export=0|
    codename
    Specifies the iCalendar export template code (0=no export).
  • firstday=
    0
    |1|2|3|4|5|6
    Specifies the first weekday from 0 (Sunday) to 6 (Saturday).
  • hoverMax=
    35
    |number
    Specifies the maximum number of rows in a hover information pop-up.
  • legend=0|
    1
    |2
    Specifies the position of a legend (1=top, 2=bottom, 0=none).
  • maxgroups=
    4
    |
    number
    Specifies the maximum number of groups per cell in month view.
  • ndays=0|(
    3,7,14,28
    )|(
    n1,n2,..
    )
    Specifies the contents the n-days drop-down list as a comma-separated list of numbers. A value of 0 signifies no n-days drop-down list.
  • round=0|(
    0,15
    )|(
    hh,mm
    )
    Specifies event times in hours and minutes enclosed in parentheses. The default of (0,15) specifies rounding to the nearest 15 minutes. A value of 0 signifies no rounding.
  • timefmt=
    24hr
    |(
    am,pm
    )
    Specifies time format as either 12 or 24 hour. You specify the 12-hour value as two comma-separated strings, the first for am and the second for pm.
  • tzSelect=
    string
    Specifies where clause restrictions on the time zone drop-down list.
schedGroup
The schedGroup macro controls the name and styling of groups of items on a schedule form, either the change schedule (list_chgsched_config.htmpl), or the knowledge schedule (list_kdsched_config.htmpl). You define a schedule form with the schedConfig, schedAttr, and schedGroup macrosle. For example:
<PDM_MACRO name=schedConfig. . .> <PDM_MACRO name=schedAttr . .> <PDM_MACRO name=schedAttr . .> . . . <PDM_MACRO name=schedGroup . .> <PDM_MACRO name=schedGroup . .> . . .
This macro has the following properties:
  • bgcolor=
    white
    |color
    Specifies the background color for the group as any valid web color.
  • color=
    black
    |color
    Specifies the foreground (text) color for the group as any valid web color.
  • grpname=
    name
    (Required) Specifies the name of the group.
  • icon=
    filename
    Specifies an icon for the group as the name of a file in $NX_ROOT/bopcfg/www/wwwroot/img.
  • label=
    string
    Specifies a label for the group.
  • legend=0|
    string
    Specifies description of the group for the legend. A value of 0 signifies that group is not in the legend.
  • style=
    normal
    |bold|italic
    Specifies the text style for the group.
sfDate
The sfDate macro specifies a date control in the search filter of a list form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
    colspan=
    1
    |
    number
    Specifies the number of columns on the form.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • qbe_condition=
    condition
    Specifies one of the following conditions for comparing the value in this field to the database value:
    • EQ is equal to the value.
    • NE is not equal to the value.
    • GT is greater than the value.
    • LT is less than the value.
    • GE is greater than or equal to the value.
    • LE is less than or equal to the value.
    • NU is null
    • NN is not null.
    • IN matches the SQL LIKE expression.
    • KY contains the text entered.
     
sfDropdown
The sfDropdown macro specifies a drop-down selection control in the search filter of a list form.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • codename=
    string
    Specifies the name of a set of values from the ui_selection object that are displayed in the date drop-down control. The values are those values with code attributes that match the value specified for codename.
     
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • default=
    text
    Specifies the default value when the attribute is null.
     
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • lookup=
    yes
    |no
    Specifies whether the field should automatically convert to a lookup when the number of entries in the drop-down list exceeds a configured value (typically 10).
  • Noempty=yes|
    no
    Specifies whether the empty value is included in the drop-down list. Specify Noempty=yes to suppress the empty value.
  • op=QBE.op
    Specifies one of the following conditions for comparing the value in this field to the database value:
    • EQ is equal to the value.
    • NE is not equal to the value.
    • GT is greater than the value.
    • LT is less than the value.
    • GE is greater than or equal to the value.
    • LE is less than or equal to the value.
    • NU is null
    • NN is not null.
    • IN matches the SQL LIKE expression.
    • KY contains the text entered.
  • win=
    windowName
    Specifies the target window. This property is not intended for customer use.
sfEnd
The sfEnd macro marks the end of the definition of a search filter on a list page. You define a search filter with the sfStart, sfEnd, and other sfxxx macros. For example:
<PDM_MACRO name=ssfStart. . .> <PDM_MACRO name=sfxxx. . .> <PDM_MACRO name=sfxxx. . .> . . . <PDM_MACRO name=sfEnd>
The macro has no properties.
sfHier
The sfHier macro specifies a hierarchical lookup control in the search filter of a list form. A hierarchical lookup control allows a user to click the caption (header) of the control to pop up a hierarchical selection form.
This macro has the following properties:
  • addPercent=yes|no
    Specifies whether to allow wildcard character searches. This property defaults to the value of the web_wildcard_search option.
     
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
sfLookup
The sfLookup macro specifies a lookup control in the search filter of a list form. A lookup control allows a user to click the caption (header) of the control to pop up a selection form.
This macro has the following properties:
  • addPercent=yes|no
    Specifies whether to allow wildcard character searches. This property defaults to the value of the web_wildcard_search option.
     
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • extraURL=
    string
    Specifies a where clause predicate in URL format to restrict the contents of the control.
     
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
sfMultiLookup
The sfMultiLookup macro specifies a multi-value lookup control in the search filter of a list form. A multi-value lookup control allows a user to selection one or more values for the attribute associated with the control.
This macro has the following properties:
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
sfStart
The sfStart macro marks the beginning of the definition of a search filter on a list page. You define a search filter with the sfStart, sfEnd, and other sfxxx macros. For example:
<PDM_MACRO name=ssfStart. . .> <PDM_MACRO name=sfxxx. . .> <PDM_MACRO name=sfxxx. . .> . . . <PDM_MACRO name=sfEnd>
This macro has the following properties:
  • button=
    true
    |false
    Specifies whether to show the default search filter buttons: Search, Show Filter, Clear Filter, and Create New.
  • color=
    string
    This property is not used in this release (reserved for future use).
  • create=
    true
    |false
    Specifies whether to show the Create New button.
  • export=
    yes
    |no
    Specifies whether to show the Export button.
  • extraCreateURL=
    string
    Specifies additional arguments for the URL used to create an object.
  • factory=
    name
    Specifies the name of a Majic factory for the selection list. Defaults to the factory referenced by the associated attributes, and so is not typically required.
     
  • ForceSearchWithKeywords=true|
    false
    Specifies whether to request a nonempty search text. This property is effective only when KnowledgeSearchText is true.
  • KnowledgeSearchText=true|
    false
    Specifies whether to show the knowledge search text at the top of the filter.
sfStartRow
The sfStartRow macro marks the start of a row on a search filter.
This macro has the following properties:
  • type=Set
    Specifies that the new row begins a row set that is hidden from view until the user clicks the green filter icon at the end of the previous row.
sfTextbox
The sfTextbox macro specifies a textbox in a search filter.
This macro has the following properties:
  • addPercent=yes|no
    Specifies whether to allow wildcard character searches. This property defaults to the value of the web_wildcard_search option.
     
  • attr=
    attributeName
    (Required) Specifies the name of the attribute associated with the control.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • disabled=yes|
    no
    Specifies whether the textbox is disabled for input. If you disable the textbox, you must also specify the value, display_value, and qbe_condition properties.
  • display_value=
    text
    Specifies the human-readable value of a disabled textbox. This property is effective only when disabled=yes.
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • qbe_condition=
    condition
    Specifies one of the following conditions for comparing the value in this field to the database value:
    • EQ is equal to the value.
    • NE is not equal to the value.
    • GT is greater than the value.
    • LT is less than the value.
    • GE is greater than or equal to the value.
    • LE is less than or equal to the value.
    • NU is null
    • NN is not null.
    • IN matches the SQL LIKE expression.
    • KY contains the text entered.
     
  • size=
    20
    |
    number
    Specifies the width of the input field.
     
  • value=
    string
    Specifies the value of a disabled textbox used in the search. This property is effective only when disabled=yes.
startFrameset
The startFrameset macro marks the beginning of a frameset definition. You define a frame page with the startFrameset, endFrameset, and frame macros. For example:
<PDM_MACRO name=startFrameset. . .> <PDM_MACRO name=frame. . .> <PDM_MACRO name=frame. . .> . . . <PDM_MACRO name=endFrameset
This macro has the following properties:
  • border
    Specifies the space between the frames.
  • cols
    Specifies the quantity and sizes of the columns in the frame set.
  • frameborder=
    yes
    |no
    Specifies whether the frame has a border (the "frameborder" argument on an HTML <frame> statement).
  • id=
    name
    (Required) Specifies the JavaScript ID of the frame (the "id" argument on an HTML <frame> statement).
  • onload
    Specifies the onLoad handler of the frame set.
  • onunload
    Specifies the onUnload handler of the frame set.
  • rows
    Specifies the quantity and sizes of the rows in the frame set.
startMenu
The startMenu macro marks the beginning of a menu within a menubar definition. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has the following properties:
  • parentid=
    name
    (Required) Specifies the ID of the menubarItem macro specifying this menu.
startMenubar
The startMenubar macro marks the beginning of a menubar definition. You define a menubar page with the startMenubar, menubarItem, endMenubar, startMenu, menuItem, menuItemLocal, and endMenu macros. For example:
<PDM_MACRO name=startMenubar. . .> <PDM_MACRO name=menubarItem. . .> <PDM_MACRO name=menubarItem. . .> . . . <PDM_MACRO name=endMenubar> <PDM_MACRO name=startMenu. . .> <PDM_MACRO name=menuItem. . .> <PDM_MACRO name=menuItemLocal. . .> . . . <PDM_MACRO name=endMenu> <PDM_MACRO name=startMenu. . .> . . . <PDM_MACRO name=endMenu> . . .
This macro has no properties.
startNotebook
The startNotebook macro marks the beginning of the definition of a notebook on a detail page. A page can only have one notebook and it must be the last item on the page. You define a notebook with the startNotebook, startTabGroup, tab, and endNotebook macros. For example:
<PDM_MACRO name=startNotebook. . .> <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=endNotebook>
This macro has the following properties:
  • hdr=
    text
    Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.
     
  • ilayer_height=
    number
    This property is deprecated; not used in this release.
  • nb_height=
    number
    Specifies the height of the notebook in pixels.
startTabGroup
The startTabGroup macro specifies the beginning of a group of tabs in a notebook on a detail page. This macro indicates that the notebook is organized in tab groups. A notebook with tab groups shows the groups as the highest level of tab. Tabs following the group are visible only when the group is selected.
You define a notebook with the startNotebook, startTabGroup, tab, and endNotebook macros. For example:
<PDM_MACRO name=startNotebook. . .> <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=endNotebook>.
This macro has the following properties:
  • title=
    string
    Specifies the name of the tab group that is shown at the top of the notebook. If you omit this property, CA SDM creates the name of the tab group by concatenating the names of all the tabs within the group.
tab
The tab macro specifies a tab in a notebook on a detail page. You define a notebook with the startNotebook, startTabGroup, tab, and endNotebook macros. For example:
<PDM_MACRO name=startNotebook. . .> <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=startTabGroup. . .> <PDM_MACRO name=tab . .> . . . <PDM_MACRO name=endNotebook>
This macro has the following properties:
  • accordion_specific_tab=true
    Specifies that this macro defines an CA SDM Release 12.9 notebook. If present, you must specify this property exactly as shown.
  • file=
    filename
    .htmpl
    Specifies an immediate tab. The contents of an immediate tab are part of the form containing it, and are formatted at the same time the containing form is formatted. This property specifies the HTMPL file containing its contents. CA SDM looks for a <PDM_FORM> tag in the referenced file, and includes the contents of this form as the contents of the tab. This property is mutually exclusive with the src property.
  • filename=
    string
    Specifies the value of the $prop.filename server variable that is passed to the tab contents. This property has no relationship to the similarly named file property.
  • height=
    number
    Specifies the height of this tab.
  • id=
    string
    Specifies the JavaScript identification of this tab.
  • new_row=yes|
    no
    (Deprecated) Indicates that the tab starts a new row of tabs. This property is informational only and CA SDM ignores it. The startTabGroup macro handles the grouping of tabs into rows.
  • src=
    url
    Specifies that this tab is a deferred tab. The contents of a deferred tab are independent of the main form and are loaded only when the user selects the tab. This property specifies the URL invoked to load the content of the tab. This property is mutually exclusive with the file property.
  • title=
    string
    Names the tab on the notebook.
  • tooltip=
    string
    Specifies a tooltip for a tab on the notebook.
tabBanner
The tabBanner macro specifies a banner (header) within a tab. You can only use this macro within an immediate tab loaded by the file property of the tab macro. The banner can contain text and one or more buttons.
This macro has the following properties:
  • add_btns=true|
    false
    Specifies whether the tab banner contains buttons. When this property is true, the containing form must include a JavaScript that defines the buttons. The btnfunc property specifies the name of the function and defaults to add_button_to_tab_banner().
  • btnfunc=
    add_button_to_tab_banner
    |
    functionName
    Specifies the name of the function that creates the buttons in the banner when add_btns=true.
  • btns_in_two_rows=
    true
    |false
    Specifies whether to include an additional line in the banner for scrolling in the Internet Explorer browser.
  • show_bar=
    true
    |false
    Specifies whether to display a horizontal bar below the tab banner.
  • title=
    string
    The text displayed in the tab banner. The string can be an empty string.
tabList
The tabList macro specifies a list included within an immediate tab loaded by the file property of the tab macro.
This macro has the following properties:
  • brBefore=yes|
    no
    Specifies whether to insert a line break before the list for spacing.
  • btnTitle=
    string
    Specifies a title for the Load button displayed when the Screen Reader preference is active.
  • colspan=
    1
    |
    number
    Specifies the number of columns on the form.
     
  • frmName=
    string
    Specifies a JavaScript identification of the HTML iframe that contains the list.
  • height=
    number
    Specifies the height of the generated list.
  • src=
    url
    (Required) Specifies the URL to invoke to generate the list.