Configuring External Class Attributes - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external

Configuring External Class Attributes - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier

WorkView

Platform

OnBase

Product

WorkView

Release

Foundation 24.1

License

Premier

External classes have different attribute configuration screens than other classes, and therefore, have slightly different configuration steps that must be completed. To create an attribute for an external class:

Select the class you want to add attributes to in the Repositories pane.
In the Properties pane, select the Attributes tab.
Click Add. The Attribute Configuration dialog box is displayed.
Enter the Name of the attribute. No spaces or symbols can exist in this name. The maximum number of characters that can be used in this field is 99 characters.
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. If you tab from the Attribute Name: field to the Display Name: field, the value from the Attribute Name: field will automatically populate the Display Name: field. This value can contain spaces and symbols. This value will populate the Heading value when creating filters.
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. See Creating Attributes for more information.

Note:
Text, Formatted Text, and Document data types are not available for selection.
Enter a Length for that attribute. The length specified should be long enough to accommodate the values in the external database column.
Enter the column name that you want to pull data from in the external database in the External Data Column field. The column must reside in the table specified when the connection was configured.

CAUTION:
The name used for a column name cannot match the name of a System Attribute. You can create a database view is in the external database to rename the column to something other than the name of a system attribute and then create the external class against the database view you created.

Note:
If the value entered in the External Data Column contains a space, upon click OK, quotation marks will enclose the value.

Note:
When configuring attributes for classes that are populated with Unity Scripts, the External Data Column field is disabled.
Click Advanced to set additional options. External attributes can be configured in one of two ways:

For the first option, one Integer data type attribute must have the Unique value selected in the Index drop-down menu. Only one attribute can have this setting.

For the second option, you can configure a Composite Key where values from multiple attributes are used to uniquely identify objects. To accomplish this, any attribute you would like to use as part of the Composite Key must be configured with the Composite Key Component value in the Index drop-down list.

Note:
External classes configured with the Unity Script class type will not have the Composite Key Component option available.

CAUTION:
Attributes that are used as part of the Composite Key always must have values in order to successfully identify objects using the Composite Key. NULL is not a valid value for a Composite Key Component.
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.

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.
Click 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.
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 data type must match the type of data that will be pulled from the external database column.

Note:
Text, Formatted Text, and Document data types are not available for selection.
Enter a Length for that attribute. The length specified should be long enough to accommodate the values in the external database column. If you are configuring a Decimal data type attribute, this field is not editable.
Enter the column name that you want to pull data from in the external database in the External Data Column field. The column must reside in the table specified when the connection was configured.

Note:
When configuring attributes for classes that are populated with Unity Scripts, the External Data Column field is disabled.
With the attribute selected you would like to configure further, click Advanced.
Select the Advanced tab to set additional options. External attributes can be configured in one of two ways:

For the first option, one Integer data type attribute must have the Unique value selected in the Index drop-down menu. Only one attribute can have this setting.

For the second option, you can configure a Composite Key where values from multiple attributes are used to uniquely identify objects. To accomplish this, any attribute you would like to use as part of the Composite Key must be configured with the Composite Key Component value in the Index drop-down list.

Note:
External classes configured with the Unity Script class type will not have the Composite Key Component option available.
Click OK.
Repeat these steps for each attribute you want to add.
Click OK.

Note:
The Default value and Data Set options are not available for attributes configured for an external class.

Note:
The Relationship and Document data types are not available for attributes configured in an external class.

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.