| Both sides previous revision Previous revision Next revision | Previous revision |
| 3400_how_to:0100_awareim_basics [2026/08/13 03:53] – external edit 127.0.0.1 | 3400_how_to:0100_awareim_basics [2026/08/13 07:43] (current) – Imported by DokuWiki Advanced Plugin aware_support3 |
|---|
| ====== AwareIM Basics ====== | ====== AwareIM Basics ====== |
| | ===== How to ... ===== |
| | <accordion autoclose> |
| |
| {{simplenavi>.:0100_awareim_basics}} | <anchor id="go_about_system_configuration"> |
| | <accordion-item title="go about system configuration"> |
| <accordion id="awareimbasics" collapsed="true"> | |
| | |
| <panel type="primary" title="go about system configuration"> | |
| We recommend that you follow these steps when configuring your application (the order of steps is essential): | We recommend that you follow these steps when configuring your application (the order of steps is essential): |
| |
| - //**Identify the requirements of your system**// Requirements define the problem(s) that your application will solve for your organization. All other steps are part of a solution to these problems. Without the definition of a problem there can be no solution. | - //**Identify the requirements of your system**// Requirements define the problem(s) that your application will solve for your organization. All other steps are part of a solution to these problems. Without the definition of a problem there can be no solution. |
| - //**Define business objects and relationships between the objects. **// \\ This is the key step when defining the solution. Make sure you do it right – if you do, all other steps will be easier. Ignore any user interface considerations at this stage – let //**AwareIM**// create the default user interface and forms for you. You can customize them later if you like. See also “[[2000_concepts:0200_basics:0100_business_objects_as_carriers_of_data|Business Objects as Carriers of Data]]”]. | - //**Define business objects and relationships between the objects.**// \\ This is the key step when defining the solution. Make sure you do it right – if you do, all other steps will be easier. Ignore any user interface considerations at this stage – let //**AwareIM**// create the default user interface and forms for you. You can customize them later if you like. See also “[[2000_concepts:0200_basics:0100_business_objects_as_carriers_of_data|Business Objects as Carriers of Data]]”]. |
| - //**Define business rules**// \\ Business logic of your system must be encapsulated in business rules. Do not use processes for this. Do not worry about presentation rules (rules on how the information will be presented to the user) at this stage. See also “[[2000_concepts:0200_basics:0200_business_rules_carriers_business_logic|Business Rules as Carriers of Business Logic]]”. | - //**Define business rules**// \\ Business logic of your system must be encapsulated in business rules. Do not use processes for this. Do not worry about presentation rules (rules on how the information will be presented to the user) at this stage. See also “[[2000_concepts:0200_basics:0200_business_rules_carriers_business_logic|Business Rules as Carriers of Business Logic]]”. |
| - //**Test the resulting system in the browser. **// \\ Performing steps 2 and 3 should be enough to create the skeleton of your system. //**AwareIM**// will create the default user interface that will make it possible for you to test this skeleton in the browser. See also the “[[2500_config_apps:0200_work_bsv:0600_testing_bsv|Testing Business Space Version]]” section. | - //**Test the resulting system in the browser.**// \\ Performing steps 2 and 3 should be enough to create the skeleton of your system. //**AwareIM**// will create the default user interface that will make it possible for you to test this skeleton in the browser. See also the “[[2500_config_apps:0200_work_bsv:0600_testing_bsv|Testing Business Space Version]]” section. |
| - //**Refine your system by customizing the user interface, adding reports and document**////**templates, specifying access restrictions etc**// | - //**Refine your system by customizing the user interface, adding reports and document**////**templates, specifying access restrictions etc**// |
| - //**Test the final system**// \\ See the “[[2500_config_apps:0200_work_bsv:0600_testing_bsv|Testing Business Space Version]]” section. | - //**Test the final system**// \\ See the “[[2500_config_apps:0200_work_bsv:0600_testing_bsv|Testing Business Space Version]]” section. |
| |
| See also the “[[2000_concepts:1000_config_proc:0500_config_guide|Configuration Guidelines]]” section. | See also the “[[2000_concepts:1000_config_proc:0500_config_guide|Configuration Guidelines]]” section. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="start configuring the system"> | <anchor id="start_configuring_the_system"> |
| | <accordion-item title="start configuring the system"> |
| - Start the Configuration Tool. If you have just installed //**AwareIM**// you will see your business space with two business space versions - one in the ''CURRENT'' state and another one in the ''NEW'' state – see the “[[2500_config_apps:0200_work_bsv:0100_bsv_lifecycle|Lifecycle of a Business Space Version]]” section. | - Start the Configuration Tool. If you have just installed //**AwareIM**// you will see your business space with two business space versions - one in the ''CURRENT'' state and another one in the ''NEW'' state – see the “[[2500_config_apps:0200_work_bsv:0100_bsv_lifecycle|Lifecycle of a Business Space Version]]” section. |
| - Expand the node of the version in the ''NEW'' state (its number must be 1.1) and start defining business objects, business rules etc in the newly created version – see the “[[2500_config_apps:0300_work_config_elements|Working with Configuration Elements]]” section. | - Expand the node of the version in the ''NEW'' state (its number must be 1.1) and start defining business objects, business rules etc in the newly created version – see the “[[2500_config_apps:0300_work_config_elements|Working with Configuration Elements]]” section. |
| - To save changes update the version The Configuration Tool displays business space versions in the ''CURRENT'' state in black – see the “[[2500_config_apps:0200_work_bsv:0400_updating_bsv|Updating Business Space Version]]” section. | - To save changes update the version The Configuration Tool displays business space versions in the ''CURRENT'' state in black – see the “[[2500_config_apps:0200_work_bsv:0400_updating_bsv|Updating Business Space Version]]” section. |
| See also the “[[:1200_getting_started|Getting Started with AwareIM]]” section. | See also the “[[:1200_getting_started|Getting Started with AwareIM]]” section. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="define database tables and database columns"> | <anchor id="define_database_tables_and_database_columns"> |
| | <accordion-item title="define database tables and database columns"> |
| In //**AwareIM**// you are not dealing with database tables or database columns. Instead of defining tables and columns you are defining business objects and their attributes (see the “[[2000_concepts:0200_basics:0100_business_objects_as_carriers_of_data|Business Objects as Carriers of Data]]” section). | In //**AwareIM**// you are not dealing with database tables or database columns. Instead of defining tables and columns you are defining business objects and their attributes (see the “[[2000_concepts:0200_basics:0100_business_objects_as_carriers_of_data|Business Objects as Carriers of Data]]” section). |
| |
| //**AwareIM**// automatically creates the required database tables and columns when you publish the business space version (see the “[[2500_config_apps:0200_work_bsv:0700_publishing_bsv|Publishing Business Space Version]]” section) or make it available for testing (see the “[[2500_config_apps:0200_work_bsv:0600_testing_bsv|Testing Business Space Version]]” section). | //**AwareIM**// automatically creates the required database tables and columns when you publish the business space version (see the “[[2500_config_apps:0200_work_bsv:0700_publishing_bsv|Publishing Business Space Version]]” section) or make it available for testing (see the “[[2500_config_apps:0200_work_bsv:0600_testing_bsv|Testing Business Space Version]]” section). |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="define links between database tables"> | <anchor id="define_links_between_database_tables"> |
| | <accordion-item title="define links between database tables"> |
| In //**AwareIM**// you do not define links between database tables. //**AwareIM**// encourages you to think in terms of business objects and relationships between them rather than in terms of linking database tables through a particular column or creating special relationships tables. | In //**AwareIM**// you do not define links between database tables. //**AwareIM**// encourages you to think in terms of business objects and relationships between them rather than in terms of linking database tables through a particular column or creating special relationships tables. |
| |
| |
| See also the “[[2000_concepts:0200_basics:0400_reference_attributes|Reference Attributes]]” section. | See also the “[[2000_concepts:0200_basics:0400_reference_attributes|Reference Attributes]]” section. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="set up calculated fields"> | <anchor id="set_up_calculated_fields"> |
| | <accordion-item title="set up calculated fields"> |
| To get //**AwareIM**// to calculate the value of an attribute of a business object you have to define a business rule that will perform the required calculation. The rule should be attached to the business object that owns the calculated attribute. See the “[[2500_config_apps:0800_add_edit_rules|Adding/Editing Business Rules]]” section. | To get //**AwareIM**// to calculate the value of an attribute of a business object you have to define a business rule that will perform the required calculation. The rule should be attached to the business object that owns the calculated attribute. See the “[[2500_config_apps:0800_add_edit_rules|Adding/Editing Business Rules]]” section. |
| |
| <code aim>IF PurchaseOrder.MyLineItems WAS CHANGED THEN | <code aim>IF PurchaseOrder.MyLineItems WAS CHANGED THEN |
| PurchaseOrder.NumberOfLineItems = COUNT OrderLineItem WHERE OrderLineItem IN PurchaseOrder.MyLineItems </code> | PurchaseOrder.NumberOfLineItems = COUNT OrderLineItem WHERE OrderLineItem IN PurchaseOrder.MyLineItems </code> |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="set up business rules"> | <anchor id="set_up_business_rules"> |
| | <accordion-item title="set up business rules"> |
| Most business rules should be attached to business objects. The rules will be automatically evaluated when this object is created or modified. See the “[[2000_concepts:0200_basics:0200_business_rules_carriers_business_logic|Business Rules as Carriers of Business Logic]]” and “[[2500_config_apps:0800_add_edit_rules|Adding/Editing Business Rules]]” sections. | Most business rules should be attached to business objects. The rules will be automatically evaluated when this object is created or modified. See the “[[2000_concepts:0200_basics:0200_business_rules_carriers_business_logic|Business Rules as Carriers of Business Logic]]” and “[[2500_config_apps:0800_add_edit_rules|Adding/Editing Business Rules]]” sections. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="test the configured system"> | <anchor id="test_the_configured_system"> |
| | <accordion-item title="test the configured system"> |
| When you finish configuring your application (or part of it) you can test how the system will work before you deploy it for production use. To test the system you must make the business space version, containing the configuration you want to test, available for testing. To do this: | When you finish configuring your application (or part of it) you can test how the system will work before you deploy it for production use. To test the system you must make the business space version, containing the configuration you want to test, available for testing. To do this: |
| |
| - Start creating business objects, reports etc – see the “[[2000_concepts:1000_config_proc:0300_testing_mode|Testing Mode]]” section. | - Start creating business objects, reports etc – see the “[[2000_concepts:1000_config_proc:0300_testing_mode|Testing Mode]]” section. |
| - Make sure that business rules operate as expected – inspect the execution log for details. See the “[[2000_concepts:0800_data_processing:0300_execution_log|Execution Log]]” section. | - Make sure that business rules operate as expected – inspect the execution log for details. See the “[[2000_concepts:0800_data_processing:0300_execution_log|Execution Log]]” section. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="deploy the configured system"> | <anchor id="deploy_the_configured_system"> |
| | <accordion-item title="deploy the configured system"> |
| Any application configured with //**AwareIM**// is operated over the web using any web browser such as Internet Explorer or Firefox. Before the final application is deployed the business space version containing the application configuration needs to be published – see the “[[2500_config_apps:0200_work_bsv:0700_publishing_bsv|Publishing Business Space Version]]” section. | Any application configured with //**AwareIM**// is operated over the web using any web browser such as Internet Explorer or Firefox. Before the final application is deployed the business space version containing the application configuration needs to be published – see the “[[2500_config_apps:0200_work_bsv:0700_publishing_bsv|Publishing Business Space Version]]” section. |
| |
| - The application can be deployed for use across the Internet. | - The application can be deployed for use across the Internet. |
| Either your organization should have direct access to the Internet or you have to get a third party organization (“web host”) to provide this access. See [[2000_concepts:1000_config_proc:0400_hosting|Working with AwareIM in the Hosting Environment]] for more details . | Either your organization should have direct access to the Internet or you have to get a third party organization (“web host”) to provide this access. See [[2000_concepts:1000_config_proc:0400_hosting|Working with AwareIM in the Hosting Environment]] for more details . |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="create records"> | <anchor id="create_records"> |
| | <accordion-item title="create records"> |
| In //**AwareIM**// records are created in the operation mode. In //**AwareIM**// terminology creating a record is creating an instance of a business object. For users to be able to create instances of business objects the application must be configured to have the menu item of the “Create Object” type (see the “[[2500_config_apps:1500_add_edit_vp:0100_working_with_vp_editor:0500_defining_layout_of_content_panels:1100_setting_menu_item_props|Setting Menu Item Properties]]” section). When a user selects the menu item of this type in the Operation Mode the default form of the business object is displayed. When the user fills out the form and submits it, the instance of the business object is created in the system. | In //**AwareIM**// records are created in the operation mode. In //**AwareIM**// terminology creating a record is creating an instance of a business object. For users to be able to create instances of business objects the application must be configured to have the menu item of the “Create Object” type (see the “[[2500_config_apps:1500_add_edit_vp:0100_working_with_vp_editor:0500_defining_layout_of_content_panels:1100_setting_menu_item_props|Setting Menu Item Properties]]” section). When a user selects the menu item of this type in the Operation Mode the default form of the business object is displayed. When the user fills out the form and submits it, the instance of the business object is created in the system. |
| |
| |
| It is also possible to configure a process that will create an instance of a business object (see the “[[2500_config_apps:0900_add_edit_processes|Adding/Editing Processes]]” section). The process can execute ''[[ref:a_f:a:enter_new|ENTER NEW]]'' action of the Rule Language, which will bring up a form of a business object for the user to fill out. The process approach should be used when the creation of an instance should be immediately followed by some other action. For the user to start the process a menu item of the “Start Process” type has to be configured. | It is also possible to configure a process that will create an instance of a business object (see the “[[2500_config_apps:0900_add_edit_processes|Adding/Editing Processes]]” section). The process can execute ''[[ref:a_f:a:enter_new|ENTER NEW]]'' action of the Rule Language, which will bring up a form of a business object for the user to fill out. The process approach should be used when the creation of an instance should be immediately followed by some other action. For the user to start the process a menu item of the “Start Process” type has to be configured. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="edit records"> | <anchor id="edit_records"> |
| In //**AwareIM**// records are modified in the operation mode. In //**AwareIM**// terminology editing a record is editing an instance of a business object. In order to edit an instance of a business object the user has to find the instance first. This can be achieved by running a query – see [[3400_how_to:0100_awareim_basics:0110_llook_for_records]]. If a query displays its results in a standard manner the instance of a business object can be edited by pressing the Edit button (see the “[[2000_concepts:0700_data_presentation:0100_query_results_grid|Standard Form of Query Results]]” section). This will bring up a form of the business object so that the user can change the attribute values on this form and submit it. | <accordion-item title="edit records"> |
| | In //**AwareIM**// records are modified in the operation mode. In //**AwareIM**// terminology editing a record is editing an instance of a business object. In order to edit an instance of a business object the user has to find the instance first. This can be achieved by running a query – see [[3400_how_to:0100_awareim_basics]]. If a query displays its results in a standard manner the instance of a business object can be edited by pressing the Edit button (see the “[[2000_concepts:0700_data_presentation:0100_query_results_grid|Standard Form of Query Results]]” section). This will bring up a form of the business object so that the user can change the attribute values on this form and submit it. |
| |
| It is also possible to configure a process that will find a particular instance of a business object and invoke the editing operation using the ''[[ref:a_f:a:edit|EDIT]]'' action of the Rule Language (see the “[[2500_config_apps:0900_add_edit_processes|Adding/Editing Processes]]” section). This process might look something like this: | It is also possible to configure a process that will find a particular instance of a business object and invoke the editing operation using the ''[[ref:a_f:a:edit|EDIT]]'' action of the Rule Language (see the “[[2500_config_apps:0900_add_edit_processes|Adding/Editing Processes]]” section). This process might look something like this: |
| |
| The ''[[ref:a_f:a:edit|EDIT]]'' action will display a form of the business object and wait for the user to change the values and submit the form. For the user to start the process a menu item of the “Start Process” type has to be configured. | The ''[[ref:a_f:a:edit|EDIT]]'' action will display a form of the business object and wait for the user to change the values and submit the form. For the user to start the process a menu item of the “Start Process” type has to be configured. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="look for records"> | <anchor id="look_for_records"> |
| | <accordion-item title="look for records"> |
| In //**AwareIM**// terminology looking for records is looking for instances of a business object. A user can find instances of a business object in the operation mode by running a query. There are several ways of running a query in the operation mode. See the “[[2000_concepts:0600_data_retrieval:0200_queries_op_mode|Running Queries in the Operation Mode]]” section for details. | In //**AwareIM**// terminology looking for records is looking for instances of a business object. A user can find instances of a business object in the operation mode by running a query. There are several ways of running a query in the operation mode. See the “[[2000_concepts:0600_data_retrieval:0200_queries_op_mode|Running Queries in the Operation Mode]]” section for details. |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="delete records"> | <anchor id="delete_records"> |
| | <accordion-item title="delete records"> |
| In //**AwareIM**// terminology deleting records is deleting instances of a business object. To allow the user to delete instances of a business object in the operation mode either a process that finds an instance of a business object and uses the ''[[ref:a_f:a:delete|DELETE]]'' action to delete it, has to be configured (see the “[[2500_config_apps:0900_add_edit_processes|Adding/Editing Processes]]” section), or an operation of the Delete Object type has to be defined for the object (see the “[[Adding/Editing Form Menu]]” section). | In //**AwareIM**// terminology deleting records is deleting instances of a business object. To allow the user to delete instances of a business object in the operation mode either a process that finds an instance of a business object and uses the ''[[ref:a_f:a:delete|DELETE]]'' action to delete it, has to be configured (see the “[[2500_config_apps:0900_add_edit_processes|Adding/Editing Processes]]” section), or an operation of the Delete Object type has to be defined for the object (see the “[[Adding/Editing Form Menu]]” section). |
| </panel> | </accordion-item> |
| |
| <panel type="primary" title="change default database used"> | <anchor id="change_default_database_used"> |
| | <accordion-item title="change default database used"> |
| Select “Database” from the Settings menu in the //**AwareIM**// Control Panel. In the Database Settings dialog choose the database engine you want. Set the properties of the database engine. Click OK and restart //**AwareIM**//. | Select “Database” from the Settings menu in the //**AwareIM**// Control Panel. In the Database Settings dialog choose the database engine you want. Set the properties of the database engine. Click OK and restart //**AwareIM**//. |
| </panel> | </accordion-item> |
| |
| </accordion> | </accordion> |
| |