This article describes how to create attributes for use with items and parts.
For issues, the process of defining attributes is the same except that they are created in a CMS project, and not in the swArchitect.
Prerequisites
- Assignment of the SW Architect role in the server
- An installation of the SystemWeaver Architect client (swArchitect)
- For creating attributes for items and parts, log in to the server using the swArchitect client and navigate to the Attributes tab.
- Next, right-click anywhere in the attribute list and select Create:
The Create Attribute Type dialog will display. It provides a number of settings for defining the attribute. The settings are described below. - Make your selections and click OK to save. The new attribute will be included in the list of attributes in the Architect.
Explanation of Attribute Settings
SID: Required. The attribute's unique identifier. Can include letters, numbers and special characters (maximum length: 8 characters) although it is recommended that only letters (A-Z) and/or numbers (0-9) are used.
Name: Required. Name of the attribute as seen by the users.
Tip: Keep in mind that the length of the attribute label display is limited in the Overview view, in order to allow for sufficient room for displaying attribute values. Therefore, attempt to keep labels short and concise but, if attribute names are similar and do get truncated, place the differentiator at the beginning. Example: |
Data type: Required. Defines both the data dimension and the attribute type. The data dimension and data type options are:
| Single | The attribute can have one value. |
| Array | The attribute can have several values. Allows duplicates. |
| Set | The attribute can have several values from a validated list called a "Range". |
A drop-down list of available types is provided. A selection is required and the following types are available:
Type | Valid Data Dimension | Description | Support for Default Value | Allows Empty Value |
|---|---|---|---|---|
Boolean | Single | Supports the values "True" and "False". | Yes | Yes |
Computed | Single | Supports any type that can be defined according to the Path expressions in SystemWeaver. This type of attribute can be used as a Default attribute and not an Additional attribute. | No | No |
Custom | Single, array, set | Reserved for attribute types with custom support in the swExplorer client. | N/A | Yes |
Single | Supports date values, presented in the format yyyy-mm-dd. | Yes | Yes | |
Enumeration | Single, set | Provides users with a validated list of values to select from. | Yes | Yes |
Single, array | Supports named file and URL references. | Yes | Yes | |
Float | Single | Supports decimal values. Does not support numeric range. | Yes | Yes |
Single | Automatic generation of integer values according to a Sequence ID. Such values are unique within the specified Sequence ID. Also, once set, Identity attribute values cannot be changed. | No | No | |
Integer | Single | Supports natural values. Does not support numeric range. | Yes | Yes |
RVF (RichView Format text) | Single | Supports fully formatted text, including pictures. This is the format generally used in Descriptions in SystemWeaver. Whenever needed this format is automatically translated into the RTF format used in MS Office applications. | Yes | Yes |
| Signature | Single | Supports digital signing | No | Yes |
Single, array | Supports non-formatted strings, up to 100 characters long. | Yes | Yes | |
Single | Supports non-formatted strings, including new lines. | Yes | Yes | |
Single, set | Supports the value domain of all users defined in the SystemWeaver server. | No | Yes | |
XML | Single | Supports XML formatted text. | Yes | Yes |
Optional Settings
The following standard settings are optional:
Info: A text box used for administrative information, e.g., the purpose of the attribute, who created it and when.
Default value: Set a default value upon creation of new items or parts of types that have the attribute as a default attribute. The table above shows whether a default value is supported or not for each attribute type.
Allow empty value: Indicates if empty attribute values should be acceptable or not. Check the box to allow an empty value. If a value is not set for an attribute where an empty value is not allowed, a warning icon will display to indicate that a value should be set.
Editor width: Sets the default width for displaying the attribute values. 200 is a good starting point. This option is available for all attribute types.
Editor min height: Sets the min height for displaying the attribute values. Applicable only to Text, External reference (array dimension), and User (set dimension) attribute types.
Editor max height: Sets the max height for displaying the attribute values. Applicable only to Text, External reference (array dimension), and User (set dimension) attribute types.
Restricted: Check this box to hide the attribute from users in the standard views. Such information would typically be visible in some other form.
Deprecated: When selected, indicates that the attribute is no longer used. Users can still view the attribute, but will see a warning icon next to the deprecated attribute.
To hide the attribute, use together with the Restricted option.
There may be additional settings available for specific attribute types. They are described in separate articles.
What's Next?
The new attribute can now be assigned to items and parts for use as needed.