Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
docs:3400_how_to:1100_miscellaneous [2022/08/25 07:00] – ↷ Page moved and renamed from docs:3400_how_to:1100_miscellaneous:0000_start to docs:3400_how_to:1100_miscellaneous administratordocs:3400_how_to:1100_miscellaneous [2026/02/04 06:01] (current) – aware_support3
Line 2: Line 2:
  
 {{simplenavi>docs:3400_how_to:1100_miscellaneous}} {{simplenavi>docs:3400_how_to:1100_miscellaneous}}
 +
 +<accordion id="miscellaneous " collapsed="true">
 +<panel type="primary" title="How to re-use configurations">
 +On certain occasions you may want to integrate all or parts of configurations of other systems into your system to re-use the definitions of business objects, business rules and other elements. For example, you might want to integrate certain aspects of sample applications into your system. To do this:
 +
 +  - Create a business space representing the system you want to re-use – see the “[[docs:2500_config_apps:2200_add_edit_bus_space|Adding/Editing Business Spaces]]” section.
 +  - Import the configuration you want to re-use from a BSV file – see the “[[docs:2500_config_apps:0200_work_bsv:1200_importing_bsv|Importing Business Space Version]]” section.
 +  - Copy and paste the elements you want to re-use into your system (see the “[[docs:2500_config_apps:0300_work_config_elements:0400_copying_elements|Copying]] and [[docs:2500_config_apps:0300_work_config_elements:0400_pasting_elements|Pasting]] Elements” sections)
 +  - Make the necessary adjustments to the copied elements if required.
 +  - Check integrity of the version to make sure that it remains consistent – see the “[[docs:2500_config_apps:0200_work_bsv:0500_checking_version_integrity|Checking Version Integrity]]” section.
 +</panel>
 +<panel type="primary" title="How to import/export data">
 +
 +This is explained in detail in the “[[docs:2000_concepts:0900_prod_feats:0600_export_import|Export and Import]]” section.
 +
 +</panel>
 +
 +<panel type="primary" title="How to define import/export templates to map data">
 +You can get end users to define their own import and export templates that describe data mapping between their data files and //**AwareIM**// attributes. For this you need to add the command of the “Manage Import/Export Templates” type to your menu. 
 +
 +See [[..:5000_videos:450_import_export_templates|Import and Export Templates]]
 +
 +
 +</panel>
 +
 +<panel type="primary" title="How to set up periodic processes">
 +If you want the system to perform certain actions periodically without any user interaction (for example, regularly delete temporary records) then you need to configure scheduling rules – see the “[[docs:2500_config_apps:2100_scheduling|Scheduling]]” section for details.
 +
 +If you want periodic actions that involve interaction with the user (for example, to periodically inform the user about important events in the system) then you need to setup a “background process”. To do this define a process to perform the work, go to the General tab of the corresponding visual perspective and setup this process as a background process.
 +
 +</panel>
 +<panel type="primary" title="How to extend AwareIM">
 +
 +If you are a programmer then you can easily write programming components that can extend the functionality of your //**AwareIM**// system – for example, you can plug-in new functions, new document types, new communication channels etc. See the [[docs:3500|Programmers Reference Guide]] document for details.
 +
 +</panel>
 +
 +<panel type="primary" title="How to get users to define their own workflows">
 +|Sometimes developers who configure applications cannot predict how their customers will use the system – some of them may have unique requirements, which change dynamically. By letting end users define their own workflows developers can make the system extra flexible. In order to get users to define their own workflows the configurator has to add the command of the “Manage User Defined Processes” to the application menu. There are also other types of commands that can be useful for this module, such as Configure User Defined Processes, Manage Events and a few others.
 +
 +See [[..:5000_videos:440_user_defined_workflows|User Defined Workflows]]
 +
 +</panel>
 +
 +<panel type="primary" title="How to support offline mode">
 +<grid>
 +
 +“Offline mode” is when users work with an application without Internet connection.
 +
 +See [[..:5000_videos:500_offline_mode|Offline Mode Video]]
 +
 +</grid>
 +
 +
 +</panel>
 +<panel type="primary" title="How to count web site visitors">
 +Whenever a new user logs into the system //**AwareIM**// sends the special login notification; whenever a user logs out //**AwareIM**// sends the logout notification. You can attach rules to these notifications to track the activity on your web site (see the “[[docs:2500_config_apps:2400_login_events|Handling Login Events]]” and “[[docs:2500_config_apps:2500_logout_events|Handling Logout Events]]” sections). For example, you can define a business object representing the statistics of your web site and define attributes in this object that will count the number of current users, the number of visitors etc. The rules attached to the login and logout notifications will set the values of these attributes accordingly.
 +
 +</panel>
 +
 +<panel type="primary" title="How to create applications in different languages">
 +This is explained in the “[[docs:2500_config_apps:1800_locales|Creating applications in different languages]]” section. Here is a summary:
 +
 +  - If you want to run AwareIM applications in a single non-English language (or a variation of the English language) you need to do the following:
 +  - Define your configuration strings (attribute labels, messages used in ''[[a_f:a:display_message|DISPLAY MESSAGE]]'' or ''[[a_f:a:report_error|REPORT ERROR]]'' rules etc) using the language of your choice
 +  - Define a locale. When creating a locale //**AwareIM**// will automatically extract all your configuration strings and if you defined them in the language of your choice you don’t need to translate them
 +  - Import system strings from a file (if a file exists for your language)
 +  - Translate the remaining system strings by clicking on the “Translation” column in the locale editor
 +  - Mark the locale as “default”
 +  - If you want to run //**AwareIM**// applications in multiple languages you need to do the following:
 +  - Define a locale for every language you want to use. Provide the translation for your configuration and system strings for every language
 +  - Define a rule attached to your user object (either ''RegularUser'' or some other member of the ''SystemUser'' group) to assign an appropriate locale to the user, for example:
 +<code aim>IF RegularUser.Country = 'Germany' THEN
 +   RegularUser.Locale = 'German' </code>
 +See [[..:5000_videos:430_multi_language|Multi Language Video]]
 +
 +</panel>
 +
 +<panel type="primary" title="How to automatically deploy an application when a new tenant signs up">
 +Many applications are hosted on a server for multiple tenants. Each tenant has his own business space and the same application is deployed into each business space. When a new tenant signs up online the system needs to create a new business space for the new tenant, load the BSV file containing the configuration of the application and publish this BSV (and maybe perform some additional steps, for example send an email to the new tenant. This section explains how this can be done.
 +
 +The signup web page has to be implemented outside of AwareIM – it can be any HTML page hosted on any server. This page has to collect relevant details of the new tenant and when the tenant submits the page, the page has to call the server hosting AwareIM applications using the following URL:
 +
 +[[http://ServerName:ServerPort/AwareIM/req.awcbs?Parameters|http(s)://ServerName:ServerPort/AwareIM/req.awcbs?Parameters]]
 +
 +In this URL Parameters identify parameters of the request – they are separated by the “&” delimiter. Each parameter has the following format:
 +
 +paramName=paramValue
 +
 +Allowed parameter names are specified below:
 +
 +  - domain – this parameter specifies the name of the new business space to create. This parameter is mandatory.
 +  - bsv – this parameter specifies the path on the server to the BSV file that will be deployed into the new business space. The parameter is mandatory
 +  - domain_start – this parameter specifies the name of the “initial business space”. This business space should not be used to deploy an application – it should contain just one published version (of any content). A business space that is created when AwareIM is initially installed on the server can be used for these purposes. This parameter is mandatory
 +  - init_process – this is an optional parameter. If specified it defines the name of the process that will be called after the BSV has been published in the new business space. The process can be useful to register user data collected by the web page (user name, company name, address etc). The process can also send an email to the user.
 +  - object_name – this optional parameter can be used together with the init_process parameter. If specified the system will create an instance of the business object with the specified name and initialise it with extra parameters defined in the request (see below). This will be done just before the init_process is executed. It will then pass this instance as a process input to the process (the process should have this object declared as process input)
 +  - Other parameters – if there are any other parameters in the request and the object_name parameter is specified, these parameters will be used as initialisation values for the instance of the object created. paramName should map to the name of the attribute defined in the object and paramValue will be set into this attribute when the object is created.
 +Here is an example of the request:
 +
 +[[https://www.myserver.com:8080/AwareIM/req.awcbs?domain=IBM&bsv=c%3A/AppDir/app.bsv&domain_start=DefaultApp&init_process=InitApp&object_name=SignupRequest&CompanyName=IBM&EmailAddress=user%40ibm.com&Address=SomeAddress&PnoneNo=12345|https://www.myserver.com:8080/AwareIM/req.awcbs?domain=IBM&bsv=c%3a/AppDir/app.bsv&domain_start=DefaultApp&init_process=InitApp&object_name=SignupRequest&CompanyName=IBM&EmailAddress=user%40ibm.com&Address=SomeAddress&PnoneNo=12345]]
 +
 +This will create a new business space called IBM, load the BSV file from ''c:/AppDir/app.bsv'', publish it, create an instance of the object ''SignupRequest'' and set its ''CompanyName'', ''EmailAddress'', ''Address'' and ''PhoneNo'' attributes and then call the ''InitApp'' process
 +</panel>
 +
 +<panel type="primary" title="How to optimise application for best performance">
 +Out-of-the-box //**AwareIM**// offers a pretty good performance for many applications. However, it does not mean that you should always rely on AwareIM to deliver the best performance. A lot depends on how you write your application as well.  The following areas are important when you write an application:
 +
 +  * Performance of business rules
 +  * Performance of queries
 +  * How quickly each request from the user is processed in your system
 +
 +Below are some recommendations on how to improve performance in each of these areas:
 +
 +  - Check the Log Viewer for the execution of rules that refer to the object (cross reference rules). These may be expensive. Execution of many of them may be unnecessary. Turn them off by going to the Advanced tab of the rule and ticking "Do not check referred"
 +  - Aggregate operations (''SUM'', ''COUNT'' etc) can be expensive if you have lots of data. Try not to use them if you can
 +  - Unconditional rules can be expensive (especially if they use aggregate operations). Make them conditional (using ''WAS CHANGED'' expression, for example)
 +  - Check for repetitive execution of rules. The rule engine can execute rules repetitively if the next rule triggers a condition that causes the previous rule to fire again. Optimise this carefully. Use rule priorities to make sure that expensive rules are only executed once
 +  - If you find that a particular query does not perform well replace it with a stored procedure (//**AwareIM**// allows you to use stored procedures – see the [[a_f:a:exec_sp|EXEC_SP]] and [[a_f:f:af:exec_spf|EXEC_SPF]] for more details)
 +  - If you need to support many concurrent users make sure that there are no CPU-extensive operations in your application. Or make sure that the CPU-extensive operations are executed at night or by a separate server.
 +  - Add additional servers to scale up your system if necessary (//**AwareIM**// supports scaling and load balancing)
 +
 +
 +
 +
 +</panel>
 +</accordion>