Custom attributes will allow users to create their own fields for flocks and contracts. Users will be able to declare a fields name, it's data type, etc. and this field can be set for flocks. The values will also appear on contracts.
Custom attributes will appear in the data set for any report that returns results against flocks.These fields can be added to new or existing reports. When the report is run, the custom values will appear as a part of the results. All wizards for these reports will include a step that allows users to filter flock results by their attribute values.
Flock Attribute Configuration
System --> Settings --> Flock Attributes Tab
This tab will allow users to define custom attributes for flocks and contracts.
Attributes that are both currently enabled and disabled (disabled ones will not appear on the flock and contract form) will appear in the list, in the order that they will appear on the flock and contract forms. Disabled attributes will be conditionally colored grey as an added means to clearly identify them.
Users have the ability to "Add" new attributes, or select one and click "Edit" to manage it. Users can also double-click an attribute to bring up the editor. Attributes cannot be deleted- only enabled/disabled.
Field Name: This field represents the literal definition of the field. Because this will be used to add columns to report data sets, it is required and must be distinct from all other definition's field names- including disabled ones.
Data Type: This is the data type of the field the users will be setting. Options for values include:
- Boolean: This is a "true/false" value that will be represented in the software as check boxes.
- String: This is a "text" value.
Description /Label: Also called the label, this field represents what users will see on the flock and contract screens.
Sort Order: This is the order in which the fields will appear on the flock and contract screens. Decimals can be used to fit newly created items prior to already created items.
Disabled: If set to true, this field will not longer be visible on the flock and contract screens. When disabled, values for both flocks and contracts will not be deleted, but future flocks will not see this field, and will therefore not be able to set it.
Boolean Sample
String Sample
Added or edited attributes will not be committed to the database until the user clicks the "Save" button for System Settings.
Flock Form
Live Inventory --> Select a flock --> Edit Selected --> Attributes Tab
A new tab has been added to flocks, titled "Attributes". Users will be able to set flock specific values for attribute definitions on this tab. These definitions are saved when the user saves the flock. The attributes are listed in the sort order defined.
Note: Commas and semicolons cannot be entered into string value fields- these are used by the report wizards to filter a selection of attributes.
Contract
System --> Contracts --> FlockAttributes Tab
A new tab has been added to the Contract form, that allows users to set default attributes for contracted flocks. This will have the same layout and sort as the flock attribute tab. These values are defaulted from the flock's assigned contract, when users setup or reload a contract.
Reports
In report edit mode, custom attributes will appear as report editor rows. Their field name will be defined as the prefix "GroupAttribute_" + their Code.
Attribute definition codes cannot be updated after they are created, so users should not worry about changing bindings.
Attributes can be marked deleted after it has been added to a layout. This field will not longer appear in future data sets, but the field will remain on the report, albeit empty, as it's binding is now invalid. These fields are not automatically removed from reports, so special care must be taken when disabling attribute definitions.
When a report is run, the specific attribute values for the flock will appear in the report. Custom attribute fields can be used the same as any other in the data set- you can use them in calculations, scripts, parameters, etc.
Filtering Reports Results Using Attributes
A new wizard step has been added to select report wizards, before the flock filter. Users can enter attribute values on wizards, and filter the list of flocks being processed for reporting. These wizard values can be saved and loaded with wizard parameters.
When you wish to apply a filter to a flock list, check the attribute to enable the field.
If the field is boolean, select true/false.
if the field is string, a list of distinct values for that attribute appear, check any whose flocks you wish to include in the report.
Flocks that do not meet the filter requirements will not appear in the flock list, before running the report
