Attributes are data items within a class. Attributes can be thought of in terms of “fields” or database “columns”. You can create one attribute at a time or you can create multiple attributes. When you create one attribute at a time, you will have access to all of the options available for an attribute.
To create one attribute at a time:
- Select the class you want to add attributes to in the Repositories pane.
-
In the Properties pane, select the Attributes tab.
-
Select Add | Single. The Attribute Configuration dialog box is displayed.
- Enter the value you would like displayed for the attribute in the Display Name field. The maximum number of characters that can be used in this field is 99 characters. The Display Name field value is populated into the Name field when configuring new attributes. This value can contain spaces and symbols, which will not be reflected in the value populated in the Name field. This value will populate the Heading value when creating filters.
- Enter the Name of the attribute. No spaces or symbols can exist in this name. The Name also cannot consist of only numeric characters. The maximum number of characters that can be used in this field is 99 characters. You cannot have multiple attributes with the same name within a class; attributes names must be unique. Name values cannot consists solely of numeric characters.
-
Select an appropriate data type from the Data Type drop-down menu. The data type must match the type of data that will be pulled from the external database column.
Note:
When mapping a currency data type, it should be mapped to a decimal data type in external database columns.
The following data types are available:
Data Type
Description
Alphanumeric
For databases created before version 14:
Alphanumeric data up to the maximum characters allowed by the database. Can use up to 8000 characters in a SQL Server database and up to 4000 characters in an Oracle database.
In a SQL Server database, if you choose to set the maximum number of characters above 4000 characters, all characters over 4000 entered in the Client will be “invisible” to the user in the field unless the text is highlighted. This is general functionality of alphanumeric fields in HTML.
For databases created in 14 and after the following are maximum character lengths:
In Oracle databases:
-
non-Unicode Oracle database - alphanumeric data has the maximum of 2000 single-byte characters.
-
Oracle Unicode database - alphanumeric data has the maximum of 2000 characters.
In SQL databases:
-
non-Unicode SQL database - alphanumeric data has the maximum of 2000 single-byte characters.
-
SQL Unicode database - alphanumeric data has the maximum of 4000 characters.
CAUTION:Lengths cannot be changed in OnBase Studio if a value exists for an attribute. When using the OnBase Studio, alphanumeric attributes <=256 characters cannot be increased to 257 characters or greater. Likewise, you cannot decrease the character length of an attribute that is >256 characters to 256 characters or less.
CAUTION:Alphanumeric attributes longer than 256 characters cannot be used in fixed constraints, user prompts, or sorting.
Integer
Numeric data containing any value between -2147483648 and 2147483647.
Date
Date data. Formatting is controlled by the regional setting.
Text
Alphanumeric data. See the Alphanumeric description for maximum character information.
CAUTION:Text attributes cannot be used in fixed constraints, user prompts, or sorting.
Relationship
Used to lookup data (set in the Designer). You must specify a Related Class.
Boolean
Used for true or false values.
Currency
Formatted as a monetary amount. The maximum field length is 20 characters. Formatting is controlled by the regional setting.
Date/Time
Date and time data. Formatting is controlled by the regional setting.
Decimal
Numeric values with decimal places that always have a precise decimal location. Trailing zeros in a value will be displayed for this attribute type.
Enter the number of digits after the decimal you want in the Precision field. 9 is the maximum number of digits allowed. There is a maximum of 20 characters total.
Floating Point
Numeric values that have several possible locations for the decimal point placement or have more than 2 decimal places. (Examples include interest rates and ratios.)
The maximum character length is 20 characters. More than 14 characters before the decimal point will be an invalid value. Values will be stored up to 16 characters, including the decimal character.
If you want to precisely specify floating point places, select the Specify Precision check box. Enter the number of digits after the decimal you want. 6 is the maximum number of digits allowed. If a number other than 6 is entered, the value is not rounded. If 6 is entered, the default rounded behavior is adhered to.
If an attribute with precision configured in set outside of the object interface through such mean as Workflow actions, unity scripts, or the API, values will be rounded.
If there is existing data that exceeds the newly assigned precision limit, the filter will not show the data that exceeds the precision configuration; it will round it for viewing. When opened in the viewer, the field will be invalid and the user must make the value valid in order to save the object.
When precision is set, value will be completed with trailing zeros to display to the number of digits specified for precision.
When the Specify Precision check box is not selected, decimals places will be rounded up once the 15th digit is encountered.
Note:Values that have more than 6 decimal places will be rounded to 6 decimal places.
Note:In the Unity Client, only 15 digits are displayed in filter results.
Note:Once a value is entered for Specify Precision and the OK button is clicked in the Attribute Configuration dialog box, the precision number cannot be decreased.
Document
Stores direct links between a WorkView object and a specific document within OnBase.
Note:In order for users to use this attribute type, they must have Modify rights to the class.
Encrypted Alphanumeric
Stores alphanumeric data as encrypted data.
Note:You cannot encrypt an existing attribute. You cannot decrypt an existing encrypted alphanumeric attribute.
Note:Wildcards are not supported in constraints using encrypted alphanumeric attributes.
Note:Encrypted alphanumeric attributes can be used in fixed constraints and user prompts using the Equal and Not Equal operators.
Formatted Text
Allows user to format text entered into field in the Client. Adds the Edit Text button to a field which opens the Edit dialog box.
Note:Data entered within a field of this type is not searchable within Workview filters.
CAUTION:Formatted Text attributes cannot be used in fixed constraints, user prompts, or sorting.
HTML attributes that are not whitelisted will be stripped out. The list of whitelisted HTML attributes are the following:
"abbr", "accept", "alt", "autocomplete", "autoplay", "checked", "cite", "class", "cols", "colspan", "controls", "coords", "data", "datetime", "dir", "disabled", "for", "headers", "height", "hidden", "href", "hreflang", "id", "label", "lang", "list", "loop", "max", "maxlength", "media", "min", "multiple", "muted", "name", "open", "pattern", "placeholder", "preload", "readonly", "rel", "required", "reversed", "rows", "rowspan", "sandbox", "scope", "selected", "shape", "size", "sorted", "src", "start", "step", "style", "target", "title", "type", "value", "width", "wrap"
-
- Enter a Length for that attribute. The length specified should be long enough to accommodate the values in the external database column. Data entered into an attribute that is greater than the configured maximum length will not be saved in the database when the object is saved. For example, if the maximum length for an attribute configured totals 5 and the value of ‘abcdefg' is entered as the value in the attribute field, only the value of ‘abcde' will be included for the value in the database when the object is saved.
- As an option you can configure a Default Value for the attribute (more information found on page Default Values) The Default Value field is disabled for the Document and Relationship data types.
-
If you are configuring a Relationship
Data Type attribute, select the Related Class the attribute is associate with from the drop-down list.
Note:
Association classes are not available for selection for a Relationship attribute's Related Class.
- If you want the attribute to exist only when the object that the attribute value was taken from in the related class exists, select the Dependent on related class check box. Also, if this option is selected, when an object is deleted that is related to another object, a prompt stating This object contains dependent objects. Are you sure you want to delete this object and all dependent objects? displays. Clicking Yes allows you to delete all related objects in addition to the selected object. An example of when deleting dependent objects might be useful is if you have Vendor objects and Contact objects. Each Vendor has a Contact. When you delete a Vendor from OnBase, there is a good chance that you might want to delete the Vendor's Contact information from OnBase. Using this feature, the Contact object is automatically deleted when the related Vendor object is deleted.
-
Select the Advanced tab.
-
As an option you can configure a Data Set that can be used for the attribute (more information found on page Configuring Data Sets).
CAUTION:
Data Set should contain values that match the attribute's data type and length to ensure values are store properly.
CAUTION: It is not supported for Attributes of the same Class to have the same Data Set configured.Note:Data Sets are not available for the following attribute data types: Relationship, Boolean, or Document.
Note:If you select a Data Set, you will only be able to select a value from it in the Default Value field.
-
As an option you can configure Masking that can be used for the attribute (more information found in Configuring Masking for Attributes).
Note:
Masking can only be configured for alphanumeric attributes less than 101 characters.
-
If you want to allow tracking of changes made to the selected attribute in objects on objects' History tab or dialog box, select the Track changes check box, which is selected by default. If you do not want to allow changes to be tracked for the specific attribute on the objects' History tab or dialog box, deselect the option.
Note:
Attributes will only be viewable in the History tab or dialog box if the current user has rights to see the attribute in a view. If the attribute does not belong to a view that the user has access to, the History tab or dialog box will not display the attribute.
Note:The Track changes check box in this screen will control only the selected attribute. If you want to track changes to all attributes within a class, select the Track changes check box for the appropriate class. See 13 for further information.
- You can also configure attributes with indexing specification (more information found on page Indexing). Indexing options are not available for the following data types: Relationship, Text, Formatted Text, and Boolean.
- Click OK.
-
Repeat these steps for each attribute you want to add to the selected class.
When a new attribute is created, it is displayed in the Attributes tab.
Note:Base class attributes in an extension class cannot be sorted in the Attributes tab.
To create multiple attributes at a time:
- Select the class you want to add attributes to in the Repositories pane.
-
In the Properties pane, select the Attributes tab.
-
Select Add | Multiple. The Attribute dialog box is displayed.
- Enter the Display Name of the attribute. This value is used as the attribute's name that is displayed in the clients. The value you enter in this field will automatically populate the Name column with the value with no spaces. Name values cannot consists solely of numeric characters.
- You can enter a different value or modify the existing value in the Name field. This is the name of the attribute.
-
Select an appropriate data type from the Data Type drop-down menu. The following data types are available:
Data Type
Description
Alphanumeric
For databases created before version 14:
Alphanumeric data up to the maximum characters allowed by the database. Can use up to 8000 characters in a SQL Server database and up to 4000 characters in an Oracle database.
In a SQL Server database, if you choose to set the maximum number of characters above 4000 characters, all characters over 4000 entered in the Client will be “invisible” to the user in the field unless the text is highlighted. This is general functionality of alphanumeric fields in HTML.
For databases created in 14 and after the following are maximum character lengths:
In Oracle databases:
-
non-Unicode Oracle database - alphanumeric data has the maximum of 2000 single-byte characters.
-
Oracle Unicode database - alphanumeric data has the maximum of 2000 characters.
In SQL databases:
-
non-Unicode SQL database - alphanumeric data has the maximum of 2000 single-byte characters.
-
SQL Unicode database - alphanumeric data has the maximum of 4000 characters.
CAUTION:Lengths cannot be changed in OnBase Studio if a value exists for an attribute. When using the OnBase Studio, alphanumeric attributes <=256 characters cannot be increased to 257 characters or greater. Likewise, you cannot decrease the character length of an attribute that is >256 characters to 256 characters or less.
CAUTION:Alphanumeric attributes longer than 256 characters cannot be used in fixed constraints, user prompts, or sorting.
Integer
Numeric data containing any value between -2147483648 and 2147483647.
Date
Date data. Formatting is controlled by the regional setting.
Text
Alphanumeric data. See the Alphanumeric description for maximum character information.
CAUTION:Text attributes cannot be used in fixed constraints, user prompts, or sorting.
Relationship
Used to lookup data (set in the Designer). You must specify a Related Class.
Boolean
Used for true or false values.
Currency
Formatted as a monetary amount. The maximum field length is 20 characters. Formatting is controlled by the regional setting.
Date/Time
Date and time data. Formatting is controlled by the regional setting.
Decimal
Numeric values with decimal places that always have a precise decimal location. Trailing zeros in a value will be displayed for this attribute type.
Enter the number of digits after the decimal you want in the Precision field. 9 is the maximum number of digits allowed. There is a maximum of 20 characters total.
Floating Point
Numeric values that have several possible locations for the decimal point placement or have more than 2 decimal places. (Examples include interest rates and ratios.)
The maximum character length is 20 characters. More than 14 characters before the decimal point will be an invalid value. Values will be stored up to 16 characters, including the decimal character.
If you want to precisely specify floating point places, select the Specify Precision check box. Enter the number of digits after the decimal you want. 6 is the maximum number of digits allowed. If a number other than 6 is entered, the value is not rounded. If 6 is entered, the default rounded behavior is adhered to.
If an attribute with precision configured in set outside of the object interface through such mean as Workflow actions, unity scripts, or the API, values will be rounded.
If there is existing data that exceeds the newly assigned precision limit, the filter will not show the data that exceeds the precision configuration; it will round it for viewing. When opened in the viewer, the field will be invalid and the user must make the value valid in order to save the object.
When precision is set, value will be completed with trailing zeros to display to the number of digits specified for precision.
When the Specify Precision check box is not selected, decimals places will be rounded up once the 15th digit is encountered.
Note:Values that have more than 6 decimal places will be rounded to 6 decimal places.
Note:In the Unity Client, only 15 digits are displayed in filter results.
Note:Once a value is entered for Specify Precision and the OK button is clicked in the Attribute Configuration dialog box, the precision number cannot be decreased.
Document
Stores direct links between a WorkView object and a specific document within OnBase.
Note:In order for users to use this attribute type, they must have Modify rights to the class.
Encrypted Alphanumeric
Stores alphanumeric data as encrypted data.
Note:You cannot encrypt an existing attribute. You cannot decrypt an existing encrypted alphanumeric attribute.
Note:Wildcards are not supported in constraints using encrypted alphanumeric attributes.
Note:Encrypted alphanumeric attributes can be used in fixed constraints and user prompts using the Equal and Not Equal operators.
Formatted Text
Allows user to format text entered into field in the Client. Adds the Edit Text button to a field which opens the Edit dialog box.
Note:Data entered within a field of this type is not searchable within Workview filters.
CAUTION:Formatted Text attributes cannot be used in fixed constraints, user prompts, or sorting.
HTML attributes that are not whitelisted will be stripped out. The list of whitelisted HTML attributes are the following:
"abbr", "accept", "alt", "autocomplete", "autoplay", "checked", "cite", "class", "cols", "colspan", "controls", "coords", "data", "datetime", "dir", "disabled", "for", "headers", "height", "hidden", "href", "hreflang", "id", "label", "lang", "list", "loop", "max", "maxlength", "media", "min", "multiple", "muted", "name", "open", "pattern", "placeholder", "preload", "readonly", "rel", "required", "reversed", "rows", "rowspan", "sandbox", "scope", "selected", "shape", "size", "sorted", "src", "start", "step", "style", "target", "title", "type", "value", "width", "wrap"
-
-
Enter a Length for that attribute. The length specified should be long enough to accommodate the values in the external database column. When configuring a decimal data type attribute, enter the precision number in this field.
Note:
When using a mask, the static characters configured count towards the total value length.
- If you want to specify a Default Value for the attribute, enter the value in the Default Value column. Once you have click in the column, a drop-down list is available to access further options. See Default Values for more information on these options.
-
If you are configuring a Relationship
Data Type attribute, select the Related Class the attribute is associate with from the drop-down list. Enter the name of the attribute in the Attribute Name: field. No spaces or symbols can exist in this name. The maximum number of characters that can be used in this field is 99 characters.
Note:
Association classes are not available for selection for a Relationship attribute's Related Class.
- Repeat these steps for each attribute you want to add.
- Click OK.
In order to configure additional options for attributes creation using the Add | Multiple option, you must select the attribute in the Attributes tab and click Modify. In addition, an attribute can be modified by selecting the attribute in the Attributes tab and clicking Modify.
An attribute Length cannot be decreased to a value less than any value stored in the database for that attribute.
If a class contains data for an attribute, the data type cannot be changed.
The length of an attribute cannot be modified if an index is configured for the attribute. The index must be removed before the attribute can be modified.