Specifying General Properties AwareIM Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
[<10>]
====== Specifying General Properties ======

The editor of business objects has several tabs – Attributes, Forms, Update Rules, Delete Rules and Presentations. The Property window contains the following properties:

===== Name =====

Specify the name of the business object uniquely identifying it within the business space version. The following restrictions apply:

  - The name must start with a character (not digit) or underscore symbol. All other symbols in the name must be either characters (including underscore symbol) or digits. No spaces or special symbols are allowed.
  - The name must be unique among the names of other business objects, business object groups and notifications.
  - The name must not start with one of the [[2000_concepts:0800_data_processing:0100_rule_evaluation:0800_context_rule_execution:0200_instance_prefixes|instance prefixes]] – ''This'', ''That'', ''Added'', ''Removed'', ''LoggedIn'', ''Changed'' or ''Failed''.
  - The name must not be one of the reserved names – ''File'', ''Day'', ''Question'', ''EmailSender'', ''ReceivedEmail'', ''IncomingEmail''.
  - The name must not coincide with the name of the basic attribute types – ''Number'', ''Date'', ''Duration'', ''Timestamp'', ''Shortcut'', ''Document'' or ''Picture''.

===== Description =====


Specify any text that describes what the business object is for, the business concept that it represents, how it is used etc. Any description if defined is included into the [[2500_config_apps:3100_gen_doc|generated documentation]] for the business space version. To provide the description for the business object, click on the Menu button in the top right corner of the screen and select “Business object description”.

===== Category =====

You can group objects by category. Objects belonging to a particular category are grouped in the Elements Tree. Enter a new category or select from the list of existing ones. You can apply the same category to several objects at once if you paste them under this category in the Elements Tree.

===== Persistence =====


You must specify where instances of the business objects will be stored:

  - Usually business objects are permanently stored in the database that is automatically managed by //**AwareIM**//. This is the default persistence option (//Database: AwareIM automatic//). 
  - Sometimes it may be necessary to use existing database tables not initially created by //**AwareIM**// (see [[2500_config_apps:2300_external_sys_ldap|working with data stored in existing database tables or ldap for details]]). To select this option choose //Database:existing external// (for data stored in external databases) or //LDAP// (for data stored in a LDAP server) from the persistence drop-down. 
  - If you choose //Not persisted// option instances of the business object will be temporarily created in memory (see [[2000_concepts:0500_data_storage|Data Storage]]). In this case the instances are destroyed when they are no longer needed by those rules that create and use them. 
    - Here you can also check the “Store Session Values” checkbox to indicate that this object will be special – the instance of this object will be automatically created when a user logs in. There is only one instance of this object per user and the instance is always present in Context. Which means that you can use the object to store attribute values that are persisted in memory only for the duration of the user session.
  - Select //Custom// option if you develop a Java plug-in that implements custom persistence storage (see [[:3500|Programmers Reference Guide]] for more details). Specify the fully quialified name of the plug-in by clicking on the Settings button.

===== Communication =====

Intelligent business objects are those that //**AwareIM**// can communicate with through the defined channels (see [[2000_concepts:0900_prod_feats:0300_comm_with_other_systems:0100_intelligent_bus_obj|intelligent business objects]]). By default business object is not intelligent. To make business object intelligent define the Communication channels of the object by clicking on the "Communication" property and defining its communication channels – see [[2500_config_apps:0500_add_edit_objects:0600_intelligent_bo|defining intelligent business objects]] for details.

===== Attributes tab =====

Any business object must have at least one attribute defined. Attributes are defined and displayed on the Attributes tab of the business object editor. 

  - To add a new attribute, select the “Attributes” tab and click on the {{docs:icons:icon_add.png?nolink&20}} icon. See [[2500_config_apps:0700_add_edit_attributes|Adding/Editing Attributes]] for details on how to add attributes of the specific types.
  - To edit an existing attribute select the attribute you want to edit and change its properties in the Selection Properties window. See [[2500_config_apps:0700_add_edit_attributes|Adding/Editing Attributes]] for details on how to edit attributes of the specific types.
  - To delete an existing attribute click on the attribute you want to delete in the Attributes table to select it and then press the {{docs:icons:icon_delete.png?nolink&20}} icon at the top of the attributes table.

===== Forms tab =====

Forms define how attributes of a business object are presented to the user when an instance of the object is added or edited in the Operation Mode. There must be at least one form defined for the business object. The Configuration Tool generates the default form automatically when a new business object is created – you can add more forms and/or edit the default form. See [[2500_config_apps:0500_add_edit_objects:0200_defining_forms|defining forms]] for details.

===== Update and Deletion Rules tabs =====

Selecting these tabs displays rules attached to the business object – see [[2500_config_apps:0800_add_edit_rules|Adding/Editing Rules]]. The Update rules are invoked when an instance of the object is being created or modified. The Deletion rules are invoked when an instance of the object is deleted.

<callout type="primary" icon="true" title="note"> When you save changes to the business object by pressing the Save button the Configuration Tool may ask you whether you want the same changes to apply to other members of the business object groups. This question will be asked if the business object being edited is a member of one or more [[2500_config_apps:1000_add_edit_bogs|business object groups]] and you have changed any of the attributes that are common to the members of the business object group. If you agree to apply changes to other members of the group, exactly the same changes that you have done to the attributes of the business object will be performed with the attributes of other group members.

The same principle applies when you edit rules of the business object that is a member of some business object groups – the changes will be applied to the rules attached to other members of the groups provided that the rules in all members are equivalent and that you agree to perform changes to other members. See also [[2500_config_apps:0800_add_edit_rules|Adding/Editing Rules]].</callout>



{{simplenavi>.:0100_specify_gen_props}}