| Both sides previous revision Previous revision Next revision | Previous revision |
| 1000_quick_tour:1200 [2026/08/13 00:50] – ↷ Page moved from docs:1000_quick_tour:1200 to 1000_quick_tour:1200 localdev | 1000_quick_tour:1200 [2026/08/13 03:09] (current) – external edit 127.0.0.1 |
|---|
| |
| |
| The left-side panel of the Configuration Tool shows the configuration elements tree (see the "[[docs:2500_config_apps:0100_overview|Configuration Tool Overview]]" section. The tree shows the default business space with the name you specified and the two business space versions (1.0 and 1.1). Version 1.1 one is ready to be modified. We will be doing our configuration in this version – this will include configuration of the application details, testing the application and making it operational (see the "[[docs:2000_concepts:1000_config_proc:0100_bsv_version_control|Business Space Versions and Version Control]]" section for details on working with business space versions). | The left-side panel of the Configuration Tool shows the configuration elements tree (see the "[[:2500_config_apps#overview_of_the_configuration_tool|Configuration Tool Overview]]" section. The tree shows the default business space with the name you specified and the two business space versions (1.0 and 1.1). Version 1.1 one is ready to be modified. We will be doing our configuration in this version – this will include configuration of the application details, testing the application and making it operational (see the "[[2000_concepts:1000_config_proc:0100_bsv_version_control|Business Space Versions and Version Control]]" section for details on working with business space versions). |
| |
| ===== Customer management ===== | ===== Customer management ===== |
| |
| We will begin our configuration work by specifying the elements allowing staff members to register, find and maintain customers. First we need to define a Customer business object that is going to represent a company customer in the system. There are several facts that need to be registered for a customer. Each of these facts is stored in a separate attribute with the type that best suits the nature of the fact (see the "[[docs:2000_concepts:0200_basics:0100_business_objects_as_carriers_of_data|Business Objects as Carriers of Data]]" section for more details on business objects and their attributes). For the purpose of our exercise the Customer object will have the following attributes (the attribute name is followed by the attribute type): | We will begin our configuration work by specifying the elements allowing staff members to register, find and maintain customers. First we need to define a Customer business object that is going to represent a company customer in the system. There are several facts that need to be registered for a customer. Each of these facts is stored in a separate attribute with the type that best suits the nature of the fact (see the "[[2000_concepts:0200_basics:0100_business_objects_as_carriers_of_data|Business Objects as Carriers of Data]]" section for more details on business objects and their attributes). For the purpose of our exercise the Customer object will have the following attributes (the attribute name is followed by the attribute type): |
| |
| |
| |
| |
| Since our system is going to send e-mails to customers, we need to nominate Customer as an intelligent business object. In //**AwareIM**// intelligent objects are those that can receive and process information (see the "[[docs:2000_concepts:0900_prod_feats:0300_comm_with_other_systems:0100_intelligent_bus_obj|Intelligent Business Objects]]" section for more information on intelligent objects). Communication with such objects is performed via communication channels. In this case we need to define the e-mail channel. Click on the "Communication" property in the list of properties of the object and tick the checkbox next to the "E-mail" communication channel. We then enter the parameters required to connect to the mail server. These are the same parameters you use to set up your e-mail program. When the definition of the Customer object is finished, we click on the "Save" button in the application toolbar to save the object configuration (or select File/Save command from the menu). | Since our system is going to send e-mails to customers, we need to nominate Customer as an intelligent business object. In //**AwareIM**// intelligent objects are those that can receive and process information (see the "[[2000_concepts:0900_prod_feats:0300_comm_with_other_systems:0100_intelligent_bus_obj|Intelligent Business Objects]]" section for more information on intelligent objects). Communication with such objects is performed via communication channels. In this case we need to define the e-mail channel. Click on the "Communication" property in the list of properties of the object and tick the checkbox next to the "E-mail" communication channel. We then enter the parameters required to connect to the mail server. These are the same parameters you use to set up your e-mail program. When the definition of the Customer object is finished, we click on the "Save" button in the application toolbar to save the object configuration (or select File/Save command from the menu). |
| |
| |
| To we click on the "Update Rules" tab at the bottom of the screen. The rule editor appears in the working area. Click on the {{docs:icons:icon_add.png?nolink&20x20|}} icon – the dialog comes up where we enter 'Age validation' as the rule name. Click OK on the dialog and the entry for the rule is displayed in the list of rules. The rule editor is shown underneath. We will enter the first line of the rule text shown above as the rule condition (without the ''IF'' part) and the second line of the rule text shown above as the rule action (without the ''THEN'' part). Click on the {{docs:icons:icon_check.png?nolink&20x20|}} icon to save the rule. Click on the "Save" button in the application toolbar to save all rules of the Customer object. | To we click on the "Update Rules" tab at the bottom of the screen. The rule editor appears in the working area. Click on the {{docs:icons:icon_add.png?nolink&20x20|}} icon – the dialog comes up where we enter 'Age validation' as the rule name. Click OK on the dialog and the entry for the rule is displayed in the list of rules. The rule editor is shown underneath. We will enter the first line of the rule text shown above as the rule condition (without the ''IF'' part) and the second line of the rule text shown above as the rule action (without the ''THEN'' part). Click on the {{docs:icons:icon_check.png?nolink&20x20|}} icon to save the rule. Click on the "Save" button in the application toolbar to save all rules of the Customer object. |
| |
| Similarly we could add as many rules as necessary to the Customer object to instruct //**Aware IM**// on what our system should do when a customer is registered or updated. See the [[docs:2000_concepts:0800_data_processing:0100_rule_evaluation|Rule Evaluation]] section for details on how rules work. | Similarly we could add as many rules as necessary to the Customer object to instruct //**Aware IM**// on what our system should do when a customer is registered or updated. See the [[2000_concepts:0800_data_processing:0100_rule_evaluation|Rule Evaluation]] section for details on how rules work. |
| |
| Next we will define a query, also called "Customer", to allow staff members to find a particular customer. Queries are used in //**AwareIM**// to find information of interest in the system (see the "[[docs:2000_concepts:0600_data_retrieval|Data Retrieval]]" section for more on queries). This simple query will find and display all Customer objects with names containing text entered by the user and sorted by customer's name. To add the query select the "Queries" item in the tree under version 1.1 and choose the "New" command from the application toolbar. The query editor appears in the working area. Enter 'Customer' as the name of the query (using the Name property), select Customer business object from the drop down of business objects in the "What to look for" section of the editor and enter a condition in the ''Where'' section as follows: | Next we will define a query, also called "Customer", to allow staff members to find a particular customer. Queries are used in //**AwareIM**// to find information of interest in the system (see the "[[2000_concepts:0600_data_retrieval|Data Retrieval]]" section for more on queries). This simple query will find and display all Customer objects with names containing text entered by the user and sorted by customer's name. To add the query select the "Queries" item in the tree under version 1.1 and choose the "New" command from the application toolbar. The query editor appears in the working area. Enter 'Customer' as the name of the query (using the Name property), select Customer business object from the drop down of business objects in the "What to look for" section of the editor and enter a condition in the ''Where'' section as follows: |
| |
| |
| * Find Customer. This operation will allow staff members to find registered customers. | * Find Customer. This operation will allow staff members to find registered customers. |
| |
| The menu, as well as many other details related to screen layout and visual settings, can be configured in the visual perspective editor (see the "[[docs:2000_concepts:0300_ui:0100_vp|Visual Perspective]]" section for more information on visual perspectives). Expand the item 'Visual Perspectives' in the tree under version 1.1 and double click on the item named "Administrator". This is the visual perspective provided by //**AwareIM**// for the system with default settings. Expand the 'Top Bar' entry in the table to show the menu of the system. Click on the 'Menu' entry in the tree and then click on the icon to add a new menu item. In the dialog that appears enter 'New Customer' as the name of the new item and click on the Details button next to the Command to execute entry. Select the 'Create Object' as the item type and tick the Customer object as the parameter of the command. Click OK twice to submit the dialogs. The new menu item appears in the table. | The menu, as well as many other details related to screen layout and visual settings, can be configured in the visual perspective editor (see the "[[2000_concepts:0300_ui:0100_vp|Visual Perspective]]" section for more information on visual perspectives). Expand the item 'Visual Perspectives' in the tree under version 1.1 and double click on the item named "Administrator". This is the visual perspective provided by //**AwareIM**// for the system with default settings. Expand the 'Top Bar' entry in the table to show the menu of the system. Click on the 'Menu' entry in the tree and then click on the icon to add a new menu item. In the dialog that appears enter 'New Customer' as the name of the new item and click on the Details button next to the Command to execute entry. Select the 'Create Object' as the item type and tick the Customer object as the parameter of the command. Click OK twice to submit the dialogs. The new menu item appears in the table. |
| |
| To configure the 'Find Customer' operation, select the 'Menu' entry and click on the icon to add another menu item. Enter 'Find Customer' as the item name and select 'Run Query' as the command type. Select the "Customer" query as the parameter of the "Run Query" command. Click on the "OK" button twice to save the changes to the menu and then click on the "Save" button in the application toolbar to save changes to the visual perspective. | To configure the 'Find Customer' operation, select the 'Menu' entry and click on the icon to add another menu item. Enter 'Find Customer' as the item name and select 'Run Query' as the command type. Select the "Customer" query as the parameter of the "Run Query" command. Click on the "OK" button twice to save the changes to the menu and then click on the "Save" button in the application toolbar to save changes to the visual perspective. |
| Let us now add a few configuration elements to prepare the system for sending birthday greeting e-mails. | Let us now add a few configuration elements to prepare the system for sending birthday greeting e-mails. |
| |
| The personalized greeting e-mail is configured as a notification that we will call ''BirthdayEmail''. In //**AwareIM**// notifications are used to send messages to people or other software systems via different channels. The content of notifications is held in attributes, like those of business objects (see the "[[docs:2000_concepts:0900_prod_feats:0300_comm_with_other_systems|Communication with Other Systems]]" section for more details on notifications). Some channels expect certain attributes from notifications sent through the channels. Since we are going to send ''BirthdayEmail'' via the e-mail channel, it should have the following two attributes: | The personalized greeting e-mail is configured as a notification that we will call ''BirthdayEmail''. In //**AwareIM**// notifications are used to send messages to people or other software systems via different channels. The content of notifications is held in attributes, like those of business objects (see the "[[2000_concepts:0900_prod_feats:0300_comm_with_other_systems|Communication with Other Systems]]" section for more details on notifications). Some channels expect certain attributes from notifications sent through the channels. Since we are going to send ''BirthdayEmail'' via the e-mail channel, it should have the following two attributes: |
| |
| * ''Subject'': Plain Text – used as the email subject line | * ''Subject'': Plain Text – used as the email subject line |
| |
| |
| The tag enclosed in the angle brackets in the first line contains the name of an attribute that //**AwareIM**// will use to replace the tag when the notification is constructed, thereby personalizing the text (see the "[[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]" section for details on working with tags). Click on the "Create" button to save the notification. | The tag enclosed in the angle brackets in the first line contains the name of an attribute that //**AwareIM**// will use to replace the tag when the notification is constructed, thereby personalizing the text (see the "[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]" section for details on working with tags). Click on the "Create" button to save the notification. |
| |
| |
| |
| |
| Now we need to bring together the parts that find birthday customers and send greetings to them. In //**AwareIM**// this is done using processes, which are usually configured as a sequence of rules (more information on processes can be found in the "[[docs:2000_concepts:0200_basics:0300_processes_link_ui_business_logic|Processes as Links between User Interface and Business Logic]]" section. We will call the process ''CongratulateBirthdayCustomers'', and it will contain the following two rules: | Now we need to bring together the parts that find birthday customers and send greetings to them. In //**AwareIM**// this is done using processes, which are usually configured as a sequence of rules (more information on processes can be found in the "[[2000_concepts:0200_basics:0300_processes_link_ui_business_logic|Processes as Links between User Interface and Business Logic]]" section. We will call the process ''CongratulateBirthdayCustomers'', and it will contain the following two rules: |
| |
| <code aim>FIND 'Birthday customers' | <code aim>FIND 'Birthday customers' |
| To configure this process select the "Processes" item in the tree under version 1.1 and choose the "New" command from the application toolbar. The process editor appears in the working area. Enter 'CongratulateBirthdayCustomers' as the process name in the list of process properties and click on the icon to add a new rule. Enter the name of the new rule and then enter the two lines above into the light yellow-colored cells in column Action 1 on the right as actions for Rule 1 and Rule 2 respectively. Note that both rules have no conditions. Click on the "Save" button to save the process. | To configure this process select the "Processes" item in the tree under version 1.1 and choose the "New" command from the application toolbar. The process editor appears in the working area. Enter 'CongratulateBirthdayCustomers' as the process name in the list of process properties and click on the icon to add a new rule. Enter the name of the new rule and then enter the two lines above into the light yellow-colored cells in column Action 1 on the right as actions for Rule 1 and Rule 2 respectively. Note that both rules have no conditions. Click on the "Save" button to save the process. |
| |
| The last element we need to configure is a scheduling rule instructing //**AwareIM**// to start our process on a daily basis, say at 7 o'clock in the morning (see the "[[docs:2500_config_apps:2100_scheduling|Scheduling]]" section for details on how the scheduling works). Click on the "Scheduling" item in the tree under version 1.1 and choose the "New" command from the application toolbar. The scheduling rule editor comes up. Click on the icon to enter a new rule and enter 'Greet customers' as the rule name. The entry for the rule will appear in the list. Select the 'Daily' radio button in the 'Recurrence pattern' section of the rule editor, select the ''CongratulateBirthdayCustomers'' process in the "Actions" section and enter 07:00 as the start time. Click on the "Save" button to save the scheduling rule. | The last element we need to configure is a scheduling rule instructing //**AwareIM**// to start our process on a daily basis, say at 7 o'clock in the morning (see the "[[2500_config_apps:2100_scheduling|Scheduling]]" section for details on how the scheduling works). Click on the "Scheduling" item in the tree under version 1.1 and choose the "New" command from the application toolbar. The scheduling rule editor comes up. Click on the icon to enter a new rule and enter 'Greet customers' as the rule name. The entry for the rule will appear in the list. Select the 'Daily' radio button in the 'Recurrence pattern' section of the rule editor, select the ''CongratulateBirthdayCustomers'' process in the "Actions" section and enter 07:00 as the start time. Click on the "Save" button to save the scheduling rule. |
| |
| The configuration work for our application is done. | The configuration work for our application is done. |