| Both sides previous revision Previous revision Next revision | Previous revision |
| docs:8000_appendices:0400_links_to_operations [2022/08/21 12:10] – ↷ Page moved from start:8000_appendices:0400_links_to_operations to docs:8000_appendices:0400_links_to_operations administrator | docs:8000_appendices:0400_links_to_operations [2025/06/12 04:00] (current) – Change to AwareIM aware_support3 |
|---|
| ====== Appendix D. Links to Aware IM operations ====== | ====== Appendix D. Links to AwareIM operations ====== |
| |
| The following section lists the links to //**Aware IM**// operations that can be invoked from the hyperlinks of HTML pages included either in a visual perspective, custom menu or custom forms. All links have to call a particular JavaScript function supported by //**Aware IM**// in a special object called AwareApp, so the general format of a link is as follows: | The following section lists the links to //**AwareIM**// operations that can be invoked from the hyperlinks of HTML pages included either in a visual perspective, custom menu or custom forms. All links have to call a particular JavaScript function supported by //**AwareIM**// in a special object called AwareApp, so the general format of a link is as follows: |
| |
| <code html><a href=”#” onclick=”AwareApp.functionName(parameters)” >Name of the link</a></code> | <code html><a href="#" onclick="AwareApp.functionName(parameters)" >Name of the link</a></code> |
| |
| Many of these functions use “renderOption” parameter. This parameter indicates where the output of the function will be directed. Possible values are: | Many of these functions use “renderOption" parameter. This parameter indicates where the output of the function will be directed. Possible values are: |
| |
| * ''main'' | * ''main'' |
| |
| * ''#HTMLElementId'' | * ''#HTMLElementId'' |
| If renderOption is a string that starts with the “#” symbol, the string after this symbol indicates a unique id of an HTML element where the output will be directed. The element can be anywhere on the screen. For example, if you have this placeholder element somewhere <div id=”my_id”></div> and you specfy renderOption as #my_id, the output of the operation will be displayed inside the placeholder element. | If renderOption is a string that starts with the “#" symbol, the string after this symbol indicates a unique id of an HTML element where the output will be directed. The element can be anywhere on the screen. For example, if you have this placeholder element somewhere <div id="my_id"></div> and you specfy renderOption as #my_id, the output of the operation will be displayed inside the placeholder element. |
| |
| |
| | startProcess (processName, renderOption) | AwareApp.startProcess ('MyProcess', 'main') | Start the process with the specified name | | | startProcess (processName, renderOption) | AwareApp.startProcess ('MyProcess', 'main') | Start the process with the specified name | |
| | StartProcess2 (processName, ctxObjectName, ctxObjectId, renderOption) | AwareApp.startProcess2('MyProcess', 'MyObject', 256,'main') | Start the process with the specified name and provide the specified object as a context | | | StartProcess2 (processName, ctxObjectName, ctxObjectId, renderOption) | AwareApp.startProcess2('MyProcess', 'MyObject', 256,'main') | Start the process with the specified name and provide the specified object as a context | |
| | startProcessWithInit(processName, renderOption, initObjName, initObjParams, processContext) | AwareApp.startProcessWithInit( 'MyProcess', 'main', 'MyObject', 'Attr1=Value1@Attr2=Value2@…” | Create an object with the specified initialisation values and start a process that uses the created object as input. Initialisation values must be either a string in the form [[mailto:Attr1%3DValue1@Attr2%3DValue2@|Attr1=Value1@Attr2=Value2@]]” etc where Attr1,Attr2 are attribute names in the object or it should be a JSON object with attribute values hashed by attribute names. If this function is used as firstCommand (see firstCommand) initialisation values will be appended automatically from the remaining URL parameters, for example:\\ http://localhost:8080/AwareIM/logonOp.aw?domain=BS&firstCommand=startProcessWithInit,MyProcess,main,MyObject&Attr1=Value1&Attr2=Value2… | | | startProcessWithInit(processName, renderOption, initObjName, initObjParams, processContext) | AwareApp.startProcessWithInit( 'MyProcess', 'main', 'MyObject', 'Attr1=Value1@Attr2=Value2@…' | Create an object with the specified initialisation values and start a process that uses the created object as input. Initialisation values must be either a string in the form ''Attr1=Value1@Attr2=Value2@'' etc where Attr1, Attr2 are attribute names in the object or it should be a JSON object with attribute values hashed by attribute names. If this function is used as firstCommand (see firstCommand) initialisation values will be appended automatically from the remaining URL parameters, for example:\\ http://localhost:8080/AwareIM/logonOp.aw?domain=BS&firstCommand=startProcessWithInit,MyProcess,main,MyObject&Attr1=Value1&Attr2=Value2… | |
| | startProcessFromForm (processName, renderOption, htmlElem, saveFlag) | AwareApp.startProcessFromForm ('MyProcess', 'main', this, true) | Usually used from a custom HTML element on an object form (button or hyperlink). HtmlElem parameter indicates this element. If saveFlag is true will save the form before starting a process. The saved object will be used as a parameter to the process | | | startProcessFromForm (processName, renderOption, htmlElem, saveFlag) | AwareApp.startProcessFromForm ('MyProcess', 'main', this, true) | Usually used from a custom HTML element on an object form (button or hyperlink). HtmlElem parameter indicates this element. If saveFlag is true will save the form before starting a process. The saved object will be used as a parameter to the process | |
| | runQuery(queryName, renderOption) | AwareApp.runQuery ('My query', 'main') | Run the query with the specified name | | | runQuery(queryName, renderOption) | AwareApp.runQuery ('My query', 'main') | Run the query with the specified name | |
| | showPerspective (perspective) | AwareApp.showPerspective ('MyPerspective') | Display the specified perspective | | | showPerspective (perspective) | AwareApp.showPerspective ('MyPerspective') | Display the specified perspective | |
| | systemSettings (renderOption) | AwareApp.systemSettings ('main') | Display the form of the SystemSettings object | | | systemSettings (renderOption) | AwareApp.systemSettings ('main') | Display the form of the SystemSettings object | |
| | logout(logoutPage) | AwareApp.logout (null) | Logout from Aware IM. Optionally provide the URL of the logout page | | | logout(logoutPage) | AwareApp.logout (null) | Logout from AwareIM. Optionally provide the URL of the logout page | |
| |
| |
| |