Difference between revisions of "Operation daml"

From help.aarenet.com
Jump to: navigation, search
Line 1: Line 1:
{{DISPLAYTITLE: Operational Configuration via DataAccessCenter  }}
+
{{DISPLAYTITLE: Aarenet Template List }}
<!-- {{PAGE_HEADER}} -->
 
 
{{Page_Help_Links | links=5 | width1=225 | width2=225 | width3=225 | width4=225 | width5=100
 
{{Page_Help_Links | links=5 | width1=225 | width2=225 | width3=225 | width4=225 | width5=100
| link1={{NAMESPACE}}:help_operation | descr1=Main Operation Help
+
| link1=nolink
 
| link2=nolink
 
| link2=nolink
 
| link3=nolink
 
| link3=nolink
Line 8: Line 7:
 
| link5=nolink
 
| link5=nolink
 
}}
 
}}
<!-- {{PAGE_SECTION_BEGIN}} -->
+
<!-- {{PAGE_SECTION_BEGIN}} --------------------------------------------------------------><section begin=page />
<section begin=page_section />
 
<!--------------------------------------------------------------------------------------------------------------->
 
  
  
 
<!-- Page Overview Start -----------------------------------------------------------------><section begin=intro />
 
<!-- Page Overview Start -----------------------------------------------------------------><section begin=intro />
The Aarenet VoIP Switch Administrator, Operator and 3rd party CRM programmer find here:
+
Here the Aarenet personnel find all MediaWiki Markup templates for the Aarenet Online Help.
:* How to access the DataAccessCenter
+
 
:* The description of the Data Access Markup Language DAML protocol
+
Productive pages:
 +
:: Page URL: http://help.aarenet.com/wiki/Template:Template_list
 +
<br>
 +
Test page:
 +
:: Page URL: http://test-help.aarenet.com/wiki/Template:Template_list
 +
 
 +
Marking of differences between the productive to the test version: TEMPLATE-DIFFERENCE
 
<!-- Page Overview End  -------------------------------------------------------------------><section end=intro />
 
<!-- Page Overview End  -------------------------------------------------------------------><section end=intro />
  
  
__TOC__ <!-- Table of Contents ---------------------------------------------------------------------------------->
+
<!-- Table of Contents ------------------------------------------------------------------------------------------>
 +
__TOC__
  
  
{{ToTop | OperationDamlOverview }} <!---------------------------------------------------------------------------->
+
<!-- ========================================================================================================= -->
= Overview of the DataAccessCenter {{Help_Status |  | &nbsp }} =
+
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Template Description ;-) =
  
The DataAccessCenter offers a HTTP/HTTPS based interface which allows 3rd-party applications to access the operational data of the Aarenet VoIP Switch. Therefore it is predestined for the configuration of the Aarenet VoIP Switch via a CRM system of the provider.
 
  
The DataAccessCenter offers with the DAML interface (Data Access Markup Language DAML) an API and protocol to configure operational data of the Aarenet VoIP Switch.
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:TEMPLATE_TEMPLATE]] ==
  
 +
'''Description:'''<br>
 +
blabla
  
The following features distinguish the DataAccessCenter:
 
:* The DAML interface allows the configuration of all customer parameters of the VoIP Switch.
 
:* The DAML documents are exchanged with the HTTP/HTTPS protocol.
 
:* The access is protected by a HTTP-Authentication.
 
:* The interface supports XML-based data (version XML 1.0).
 
:* The XLS transformation XSLT is supported for checks and formalizing.
 
:* For the immediate use DAML-Formats are prepared for managing of account, phone numbers and other often used features.
 
:* Customized DAML-Formats can be created when required.
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{TEMPLATE_TEMPLATE | <NUMBER> | <DESCRIPTION> }}
 +
</pre>
  
DAML allows to configure the following operative parameters:
 
:* "Account":
 
:*: For the creation and treatment of customers account
 
:* "Address"
 
:*: For the creation and treatment of public and internal phone numbers in customer accounts and vPBX
 
:* etc.
 
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{TEMPLATE_TEMPLATE | 1 | "Teilnehmer xx" }}
 +
</pre>
  
DAML allows queries of the configured parameters or other data:
 
:* Account:
 
:*: Query of all account names
 
:* Connection list:
 
:*: Query of the CDR of the last N connections of a phone number
 
:* etc.
 
  
 +
'''Result:'''<br>
 +
{{TEMPLATE_TEMPLATE | 1 | Register "Teilnehmer xx" }}
  
The DAML protocol bases on XML formatted documents [http://www.w3schools.com/xml/ (Introduction to XML)]:
 
:* The basic rules of the XML standards are valid, version XML 1.0
 
:* The order of the XML elements is free
 
:* If XML elements are not provided during the creation of an instance, the default value of the Aarenet VoIP Switch is considered.
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#switch: {{{1}}}
 +
| 1 = : bla {{{2}}}
 +
| 2 = :: bla {{{2}}}
 +
| #default = bla default
 +
}}
 +
</pre>
  
The DAML protocol can be customized with XLST script. Possibilities are:
 
:* Make the interface stable
 
:* Define defaults
 
:* Do some rough checks
 
  
With XLST a XML document can be converted into another XML document. With the DAML interface it is possible to treat incoming XML documents, e.g. from a CRM application, with defined XLST commands, before they are processed as DAM-documents. Vice versa outgoing XML documents can be reworked with defined XLST commands and the result sent to the CRM application.
 
  
  
{{Note|
 
XLST conversions must be developed and checked in corporation with the Aarenet engineering.}}
 
  
  
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Aarenet Wiki =
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlHowto}}
 
= How To Start with the DataAccessCenter {{Help_Status | | &nbsp; }} =
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:An_Wiki_Fqdn_Ip]] ==
  
 +
'''Description:'''<br>
 +
Identifies the productive Aarenet Wiki FQDN or IP address:
 +
: FQDN: <tt>http://help.aarenet.com</tt>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlHowtoGetInTouch}}
+
<pre>
<div id="OperationDamlHowtoScriptResidential"></div>
+
{{An_Wiki_Fqdn_Ip}}
<div id="OperationDamlHowtoScriptSipTrunk"></div>
+
</pre>
<div id="OperationDamlHowtoScriptvPBX"></div>
 
== Get in Touch with DAML {{Help_Status | | &nbsp; }} ==
 
  
# Get an DataAccessCenter account on:
 
#:* Test Aarenet VoIP Switch
 
#:* Pre-productive Aarenet VoIP Switch
 
#:
 
# Get IP access to the DataAccessCenter of this Aarenet VoIP Switch
 
#:
 
# Download the executable DAML Test Scripts:
 
#: {{File_Download_Link | daml_residential_scripts_v10.zip | zip | "Download DAML Test Scripts for a Residential User" }}
 
#: {{File_Download_Link | daml_siptrunk_scripts_v10.zip    | zip | "Download DAML Test Scripts for a SIP Trunk" }}
 
#: {{File_Download_Link | daml_vpbx_scripts_v10.zip        | zip | "Download DAML Test Scripts for a vPBX" }}
 
#:
 
# Play around with the DAML Test Scripts for getting a feeling how it works
 
#:
 
# Do configuration in the ConfigCenter and read it out with DAML
 
  
 +
'''Result:'''<br>
 +
<tt>{{An_Wiki_Fqdn_Ip}}</tt>
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
help.aarenet.com
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlHowtoCrmImplementation}}
 
== CRM Implementation {{Help_Status | | &nbsp; }} ==
 
  
  
# Implement the DataAccessCenter access and [[ #OperationDamlExchangeDigest | HTTP-Digest Authentication ]]
 
#:
 
# For a starter implement [[ #OperationDamlExchangeHttpGet | HTTP-Get for a query ]]
 
#:* Basic read
 
#:* Queries for, e.g.:
 
#:** Ruleset
 
#:
 
# Implement the basic [[ #OperationDamlExchangeHttpPost | HTTP-Post data exchange for "write, "read", "delete" ]]
 
#:
 
# Implement the [[ #OperationDamlAcc | "Account Treating" ]]:
 
#:* Basic create, read, delete
 
#:* Parameter add, modify, delete for:
 
#:** account
 
#:** tenant
 
#:** info
 
#:** SIP credentials
 
#:** etc.
 
#:
 
# Implement the [[ #OperationDamlAddr | "Address Treating" ]]:
 
#:* Basic create, read, delete
 
#:* Parameter add, modify, delete for:
 
#:** number
 
#:** etc.
 
#:
 
# Implement the basic [[ #OperationDamlExchangeHttpGet | HTTP-Get data exchange for data queries ]]:
 
#:* Queries for:
 
#:** Ruleset
 
#:** etc.
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:An_Wiki_Fqdn_Ip_Test]] ==
  
 +
'''Description:'''<br>
 +
Identifies the productive Aarenet Wiki FQDN or IP address:
 +
: IP: <tt>test-help.aarenet.com</tt>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlHowtoBestPractices}}
+
<pre>
== Best Practices with DAML Parameters {{Help_Status | | &nbsp; }} ==
+
{{An_Wiki_Fqdn_Ip_Test}}
 +
</pre>
  
  
 +
'''Result:'''<br>
 +
<tt>{{An_Wiki_Fqdn_Ip_Test}}</tt>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Template-Code:'''<br>
{{ToTop | OperationDamlHowtoBestPracticesNotDocParam}}
+
<pre>
== Not Documented DAML Parameter {{Help_Status | | &nbsp; }} ==
+
test-help.aarenet.com
 +
</pre>
  
The DAML interface development evolves continuously. This documentation may lag behind the development of features and parameters
 
  
  
If upon a DAML read out such a DAML parameter is discovered and its naming points to a feature of interest then:
 
# Login into the ConfigCenter
 
# Search for a matching parameter name and study its possible configurations
 
# Modify this possibly matching parameter
 
# Make e new read out via DAML and compare it with the first read out. See if it matches your expectataions.
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:An_Wiki_Site]] ==
  
If this process is not successfull then contact the [[ support_contact_voip_switch_supplier | "VoIP Switch Supplier Support"]]
+
'''Description:'''<br>
 +
Identifies the productive or test AN Wiki site due to <nowiki>{{An_Wiki_Fqdn_Ip_Test}}</nowiki>:
 +
: <tt>"{{An_Wiki_Fqdn_Ip_Test}}"</tt>
 +
If yes the result will be:
 +
* <tt>test_wiki</tt>
 +
else
 +
* <tt>productive_wiki</tt>
  
  
 +
This site page has the follwoing URL:
 +
: <tt>{{fullurl:{{PAGENAMEE}}}}</tt>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlHowtoBestPracticesNotDocParam}}
+
<pre>
== Usage of Diverse DAML Parameter {Help_Status | | Preliminary }} ==
+
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
 +
| "then do this on productive wiki site"
 +
| "else do that on test wiki site"
 +
}}
 +
</pre>
  
:* Use for the "Account Name" the CRM "Customer ID"
 
:* Write in the "Account Info" information that a supporter helps to find a customer, without consulting the CRM for its ID
 
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{An_Wiki_Site}}
 +
</pre>
  
  
 +
'''Result:'''<br>
 +
<tt>{{An_Wiki_Site}}</tt>
 +
<br>
 +
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
 +
| "then do this on productive wiki site"
 +
| "else do that on test wiki site"
 +
}}
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlOverviewProvisioningDac}}
 
= Provisioning the DataAccessCenter for CRM Application Access {{Help_Status | | &nbsp; }} =
 
  
To grant an external CRM application access to the operational data via DataAccessCenter the following configuration at DataAccessCenter component level must be set up:
+
'''Template-Code:'''<br>
 +
<pre>
 +
{{#if: {{#pos:{{fullurl:{{PAGENAMEE}}}}|{{An_Wiki_Fqdn_Ip_Test}}|0}} | test_wiki | productive_wiki }}
 +
</pre>
  
# '''HTTP / HTTPS- Authorization-Credentials:'''
 
#: Defines the username and password the CRM application has to use for accessing the DataAccessCenter
 
#:
 
# '''Group-based Authorization:'''
 
#: Defines to which groups the CRM application has access.
 
#:
 
# '''Authorization for the use of to DAML-Documents and DAML-Queries:'''
 
#: Defines which DAML-Documents and DAML-Queries the CRM application is allowed to use. It is possible to specifiy the rights to "create", "read", "write", "delete".
 
#:
 
# XLTS files to be used for interpretation and formatting:
 
#: Defines, whether the configuration data must be pre and/or reworked by means of XLST conversions.
 
  
  
{{Note |
 
The configuration of the DataAccessCenter component has to be accomplished in close collaboration between the provider and the Aarenet project manager.}}
 
  
<!--
+
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
  
Define User:<br>
+
= Text Blocks =
:* <tt>defineUser  <USERNAME>  "<PASSWORD>"
 
  
  
Define Date/Time Format:<br>
 
:* <tt>dateTimeFormat "yyyy.MM.dd HH:mm:ss"</tt>
 
  
  
Define priorities for call forward CF configured via DataAccessCenter:<br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* <tt>cfu.priority    10</tt>
+
== Divers Text Components ==
:* <tt>cfb.priority    10</tt>
 
:* <tt>cfnr.priority    10</tt>
 
:* <tt>cfo.priority    10</tt>
 
:* <tt>cff.priority    20</tt>
 
  
  
Granted Access to information:<br>
 
:* <tt> grantAccessToAccounts                <USERNAME>  read/write</tt>
 
:* <tt> grantAccessToRulesets                <USERNAME>  read</tt>
 
  
:* <tt> grantAccessToAdmin                  <USERNAME>  read/write</tt>
 
:* <tt> grantAccessToDevice                  <USERNAME>  read/write</tt>
 
:* <tt> grantAccessToGroup                  <USERNAME>  read/write</tt>
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Help_Status]] ===
  
:* <tt> grantAccessToMessages                <USERNAME>  read/write</tt>
+
Documentation status information.<br>
:* <tt> grantAccessToMessageExport          <USERNAME>  mc1 dfs://${DA1}:7107/home/crm/messages</tt>
+
Types of status:
:* <tt> grantAccessToMessageImport          <USERNAME>  mc1 dfs://${DA1}:7107/home/crm/messages</tt>
+
:* comingsoon
 +
:* inwork
 +
:* draft
 +
:* new
 +
:* updated
 +
:* deprecated
  
  
:* <tt> grantAccessToLawfullInterception    <USERNAME>  read/write </tt>
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Help_Status | Feature Descritpion | comingsoon }}
 +
</pre>
  
defineQueryCallList user calllist /home/dataaccesscenter/conf/dataaccesscenter_calllist.xsl
 
-->
 
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{Help_Status | Feature Descritpion | comingsoon }}
 +
{{Help_Status | Feature Descritpion | inwork}}
 +
{{Help_Status | Feature Descritpion | draft }}
 +
{{Help_Status | Feature Descritpion | new}}
 +
{{Help_Status | Feature Descritpion | updated }}
 +
{{Help_Status | Feature Descritpion | deprecated }}
  
 +
For hide a status at a certain position:<br>
 +
{{Help_Status | Feature Descritpion | & nbsp; }} -> &nbsp; : 'space' used as place holder
  
 +
Status in text:
 +
This description will soon be ready {{Help_Status | inwork}}!
  
<!--------------------------------------------------------------------------------------------------------------->
+
Status in title:
{{ToTop | OperationDamlOverviewIpAccessDac}}
+
==== {{Help_Status | Feature Title with Status Variant 1 | Preliminary }} ====
= Access via IP Network to the DataAccessCenter {{Help_Status | | &nbsp; }} =
+
or
 +
==== Feature Title with Status Variant 2 {{Help_Status | &nbsp; | Preliminary }} ====
 +
</pre>
  
For the DataAccessCenter the URL must have the following form:
 
  
'''DAML Access:'''
+
'''Result:'''<br>
:: <tt>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter</tt>
+
{{Help_Status | Feature Descritpion | comingsoon }} <br>
 +
{{Help_Status | Feature Descritpion | inwork}} <br>
 +
{{Help_Status | Feature Descritpion | draft }} <br>
 +
{{Help_Status | Feature Descritpion | new}} <br>
 +
{{Help_Status | Feature Descritpion | updated}} <br>
 +
{{Help_Status | Feature Descritpion | deprecated}} <br>
 +
{{Help_Status | Feature Descritpion | &nbsp; }}
 +
<br>
 +
==== {{Help_Status | Feature Title with Status Variant 1 | inwork }} ====
 +
or<br>
 +
==== Feature Title with Status Variant 2 {{Help_Status | &nbsp; | draft }} ====
 +
<br>
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
 +
| &nbsp;
 +
| {{#switch: {{{2}}}
 +
  | ComingSoon
 +
  | comingsoon =  {{{1}}} '''''<small> <FONT COLOR=#9c9472>&nbsp;&nbsp;&rarr; Coming Soon</FONT></small>'''''
 +
  | InWork
 +
  | inwork =      {{{1}}} '''''<small> <FONT COLOR=#9c9472>&nbsp;&nbsp;&rarr; In Work</FONT></small>'''''
 +
  | Preliminary
 +
  | draft =      {{{1}}} '''''<small> <FONT COLOR=#0061a0>&nbsp;&nbsp;&rarr; Draft</FONT></small>'''''
 +
  | New
 +
  | new =        {{{1}}} '''''<small> <FONT COLOR=#3a817d>&nbsp;&nbsp;&rarr; New</FONT></small>'''''
 +
  | Updated
 +
  | updated =    {{{1}}} '''''<small> <FONT COLOR=#3a817d>&nbsp;&nbsp;&rarr; Updated</FONT></small>'''''
 +
  | deprecated =  {{{1}}} '''''<small> <FONT COLOR=#b8597c>&nbsp;&nbsp;&rarr; Deprecated</FONT></small>'''''
 +
  | #default =    {{{1}}}
 +
  }}
 +
}}
 +
</pre>
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlExchange}}
 
= DAML-Document Exchange via HTTP/HTTPS  {{Help_Status | | &nbsp; }} =
 
  
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:File_Download_Link]] ===
  
 +
'''Description:'''<br>
 +
This allows to introduce a file download link with icon for the file type.<br>
 +
The following icons are available:
 +
:* pdf
 +
:* zip
 +
:* xml
 +
:* img
 +
:* default
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{Note|
{{ToTop | OperationDamlExchangeDigest}}
+
Primarily the file has to be uploaded to the mediawiki!
== HTTP DIGEST Authentication {{Help_Status | | &nbsp; }} ==
+
}}
  
Prior the transfer of DAML-documents a CRM application has to apply the HTTP-Digest authentication in order to get access to the DataAccessCenter interface.
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{ File_Download_Link
 +
| <FILE_NAME>
 +
| <FILE_ICON (pdf | zip | xml | img | default )>
 +
| <DESCRIPTION> }}
 +
</pre>
  
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{ File_Download_Link | manual_voip-switch_filial_subscriber_admincenter_d21.pdf | pdf | "Das web-basierte AdminCenter für den Teilnehmer" }}
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlExchangeHttpPost}}
 
== HTTP POST Data Exchange  {{Help_Status | | &nbsp; }} ==
 
  
The CRM application must transmit its instructions with a HTTP-POST-Request toward the DataAccessCenter. By the use of the directive POST big data volumes can be transmitted in the HTTP body. Moreover, they are not visible within the URL.
+
'''Result:'''<br>
 +
{{File_Download_Link | manual_voip-switch_filial_subscriber_admincenter_d21.pdf |pdf| "Das web-basierte AdminCenter für den Teilnehmer" }}
  
  
The CRM must transfer with HTTP POST a DAML-document with the following directives:
+
'''Template-Code:'''<br>
 +
<pre>
 +
[[Media:{{{1}}} | {{{3}}} ]] {{#switch: {{{2}}}
 +
| pdf = {{Picture_Pdf}}
 +
| zip = {{Picture_Zip}}
 +
| xml = {{Picture_Xml}}
 +
| img = {{Picture_Img}}
 +
| #default = {{Picture_File}}
 +
}}
 +
</pre>
  
'''<tt>write</tt>:'''
 
:* The given data will be written. This directive creates or modifies instances.
 
  
'''<tt>read</tt>:'''
 
:* The given data will be read and delivered.
 
  
'''<tt>delete</tt>:'''
 
:* The given data will be deleted.
 
  
  
'''DAML-Document Example:'''
 
{{ SW_Code | |
 
<daml command&#61;'''"read"'''>
 
:. . .
 
</daml>
 
}}
 
  
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== Notes & Warning Text Box ==
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ToTop | OperationDamlExchangeHttpGet}}
+
=== [[Template:Note]] ===
== HTTP GET Data Exchange  {{Help_Status | | &nbsp; }} ==
 
  
DAMl Queries permit the queries of data which cannot be determined with usual DAML-Directives, e.g. connections list.
+
'''Description:'''<br>
 +
Highlighted text notes of diffrenet types.¨<br>
 +
Types of notes:
 +
:* note (default)
 +
:* warning
 +
:* bestpractice
 +
:* version
 +
<br>
 +
:&rarr; Possible but not recommended for notes: use "hangleft" for hang in from the left side
  
DAML-Queries are executed with HTTP GET Requests.
 
  
For the DataAccessCenter the URL must have the following form:
+
'''Usage:'''<br>
 +
<pre>
 +
{{Note| Place here the note text }}
 +
</pre>
 +
<pre>
 +
{{Note| type=warning | Place here the note text }}
 +
</pre>
 +
<pre>
 +
{{Note| type=bestpractice |
 +
'''Checking "Support Log"'''<br>
 +
Place here the best practice text
 +
}}
 +
</pre>
 +
<pre>
 +
{{Note| type=version | Place here the version text }}
 +
</pre>
  
'''DAML-Query Example:'''
 
:: <tt>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml&#63;query&#61;'''DAML_QUERY_NAME'''</tt>
 
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{Note| Dial on your telephone *99 or go to the AdminCenter ... }}
 +
</pre>
 +
<pre>
 +
{{Note| type=warning | Place here the warning text }}
 +
</pre>
 +
<pre>
 +
{{Note| type=warning | hangleft=50 | Place here the hanging warning text }}
 +
</pre>
 +
<pre>
 +
{{Note| type=version | Place here the version text }}
 +
</pre>
  
  
 +
'''Result:'''<br>
 +
{{Note| Dial on your telephone *99 or go to the AdminCenter ...
 +
}}
 +
<br>
 +
{{Note| type=warning | Place here the warning text }}
 +
<br>
 +
{{Note| type=bestpractice |
 +
'''Checking "Support Log"'''<br>
 +
Place here the best practice text }}
 +
<br>
 +
With hang in from left:
 +
{{Note| type=warning | hangleft=50 | Place here the hanging warning text }}
 +
<br>
 +
Version Note:
 +
{{Note| type=version | AdminCenter Version V5.7 }}
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Template-Code:'''<br>
{{ToTop | OperationDamlExchangeHttpResponse}}
+
<pre>
== HTTP RESPONSE (Execution and Error Codes) {{Help_Status | | &nbsp; }} ==
+
{{{!}} {{Table_Cell_General}}
 +
{{!}}- valign="middle"
  
After the data were successfully transmitted and treated, the response code <tt>"200 OK"</tt> is returned.
+
{{#if: {{{hangleft|}}} |
 +
  {{!}} width={{{hangleft}}} {{!}}
 +
}}
  
 +
{{#switch: {{{type}}}
 +
| warning =
 +
{{!}} width=100 bgcolor={{MANGENTA_70}} {{!}}  {{#switch: {{NAMESPACE}}
 +
                                                | De      = '''Warnung:'''
 +
                                                | #default = '''Warning:'''
 +
                                                }}
 +
{{!}} width=500 bgcolor={{GREY_LIGHT}}  {{!}}  {{{1}}}
  
{{Note |
+
| bestpractice =
<tt>"200 OK"</tt> means that the request could be treated by the DataAccessCenter but '''not''' that the outcome is correct.
+
{{!}} width=100 bgcolor={{BLUE_40}}    {{!}}  {{#switch: {{NAMESPACE}}
 +
                                                | De      = '''Beste Anwendung:'''
 +
                                                | #default = '''Best Practice:'''
 +
                                                }}
 +
{{!}} width=500 bgcolor={{GREY_LIGHT}}  {{!}}  {{{1}}}
  
 +
| version =
 +
{{!}} bgcolor={{GREY_LIGHT}}            {{!}}  {{{1}}}
  
For example:
+
| #default =
:* Unknown XML fields are ignored and not reported with an error code
+
{{!}} width=100 bgcolor={{BEIGE_70}}    {{!}}  {{#switch: {{NAMESPACE}}
:* A read request for an account with a wrong written account name will return a <tt>"200 OK"</tt> with an empty response
+
                                              | De      = '''Hinweis:'''
:* A write request to an account with a wrong written account name will return a <tt>"200 OK"</tt> but the expected account was not modified but a new account with the wrong written name was created with just the modified parameter configuration in it.
+
                                              | #default = '''Note:'''
:* A query without correct query directive will return a <tt>"200 OK"</tt> with an empty response.
+
                                              }}
 +
{{!}} width=500 bgcolor={{GREY_LIGHT}}  {{!}}  {{{1}}}
 
}}
 
}}
 +
{{!}}}
 +
<br style="clear:both">
 +
</pre>
 +
 +
 +
  
  
In the case of an error a code <tt>"4xx <ERROR_DESCRIPTION>"</tt> or <tt>"5xx <ERROR_DESCRIPTION>"</tt> is returned, e.g., <tt>"500 Internal Server Error"</tt>.
 
  
If the cause of the problem is not deductive from the error message, the error situation can be examined from the information in the log file of the component DataAccessCenter.
+
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== Code & Shell Text Box ==
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ToTop | OperationDamlAcc}}
+
=== [[Template:Shell_Command]] ===
= DAML-Document "Account" for Treating Customer Accounts  {{Help_Status | | &nbsp; }} =
 
  
This DAML-document allows the treatment of accounts, its features and parameters:
+
'''Description:''' <br>
:* [[ #OperationDamlAccCreate | Create an account ]]
+
Display shell command lines:
:* [[ #OperationDamlAccDelete | Delete an account ]]
+
:* use "prompt" for displaying a line number and a specific shell prompt.
:* [[ #OperationDamlAccRead  | Read an account ]]
+
:* use "hangleft" for hang in from the left side
:* [[ #OperationDamlAccWriteModify | Modify parameters or features of an existing account ]]
+
:* Text aligns on centered
:* [[ #OperationDamlAccWriteAdd    | Add parameters or features to an existing account ]]
 
:* [[ #OperationDamlAccWriteDelete | Delete parameters or features of an existing account ]]
 
  
  
The SIP addresses (phone numbers) which are associated with the account are treated with the [[ #OperationDamlAddr | DAML-Document for Treating "Address"]].
+
'''Usage:'''<br>
 +
<pre>
 +
{{Shell_Command | prompt# | command 1 }}
 +
</pre>
  
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{Shell_Command | prompt# | command 1 }}
 +
{{Shell_Command | prompt# | command 2 }}
 +
{{Shell_Command | root#  | command 3 }}
 +
{{Shell_Command | | command 4 }}
 +
<br style="clear:both">
  
 +
With hang in from left:
 +
{{Shell_Command | hangleft=50 | root# | command 5 }}
 +
<br style="clear:both">
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAccXMLContainer}}
 
== DAML XML-Container for "Account" {{Help_Status | | &nbsp; }} ==
 
  
All XML fields are listed in the account container:
+
'''Result:'''<br>
:* The XML field '''<tt><account></tt>''' defines the XLS account container
+
{{Shell_Command | prompt# | command 1 }}
:* Mandatory is the XML field '''<tt><accountName></tt>''' which identifies the account unambiguously.
+
{{Shell_Command | prompt# | command 2 }}
:* The order of the XML fields is arbitrary
+
{{Shell_Command | root#  | command 3 }}
 +
{{Shell_Command | | command 4 }}
 +
<br style="clear:both">
  
 +
With hang in from left:
 +
{{Shell_Command | hangleft=50 | root# | command 5 }}
 +
<br style="clear:both">
  
'''Account-Container for "Account":'''<br>
+
 
{{ SW_Code | |
+
'''Template-Code:'''<br>
: <account>
+
<pre>
::< accountName>'''ACC_NAME'''</accountName>
+
{{{!}} {{Table_Cell_General}}
:: . . .
+
 
:: <featureN>
+
{{#if: {{{hangleft|}}} |
::: <parameterN>'''PARAMETER_N'''</parameterN>
+
  {{!}} width={{{hangleft}}} {{!}} &nbsp;
::: . . .
 
:: </featureN>
 
:::. . .
 
:: <parameterA>'''PARAMETER_A'''</parameterA>
 
:: . . .
 
: </account>
 
 
}}
 
}}
 +
 +
{{!}} width=100  bgcolor={{GREEN_40}}  align="right" {{!}} {{#if: {{{1|}}} | <tt>{{{1}}}</tt> }}
 +
{{!}} width=900  bgcolor={{GREY_LIGHT}}              {{!}} <tt>{{{2}}}</tt>
 +
{{!}}}
 +
</pre>
  
  
  
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
  
<!--------------------------------------------------------------------------------------------------------------->
+
=== [[Template:SW_Code]] ===
{{ToTop | OperationDamlAccTreat}}
 
== DAML-Document for Create, Delete, Read and Write an "Account" {{Help_Status | | &nbsp; }} ==
 
  
 +
'''Description:''' <br>
 +
Display SW code or script command lines:
 +
:* use "ln" for displaying a line number.
 +
:* use "hangleft" for hang in from the left side
 +
:* Text aligns on top
  
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{SW_Code | <LINE> | code line 1 }}
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAccCreate}}
 
=== Create an "Account" {{Help_Status | | &nbsp; }} ===
 
  
By creating an account all its features and parameters may be configured too.
+
'''Example:'''<br>
 +
Variante 1:
 +
<pre>
 +
{{ SW_Code | 01 | code line 1 }}
 +
{{ SW_Code | 02 | code line 2 }}
 +
{{ SW_Code | 03 | code line 3 }}
 +
<br style="clear:both">
 +
</pre>
  
'''DAML-Document:'''<br>
+
Variante 2:
{{ SW_Code | |
+
<pre>
<daml command&#61;'''"write"'''><br>
+
{{ SW_Code |
:<account>
+
| 04<br>05<br>06 |
::<accountName>'''ACC_NAME'''</accountName>
+
code line 4<br>
:: . . .
+
code line 5<br>
::<featureN>
+
code line 6
:::<parameterN>'''PARAMETER_N'''</parameterN>
 
::: . . .
 
::</featureN>
 
:::. . .
 
::<parameterA>'''PARAMETER_A'''</parameterA>
 
:: . . .
 
:</account>
 
</daml>
 
 
}}
 
}}
 +
<br style="clear:both">
 +
</pre>
  
 +
Variante 3:
 +
<pre>
 +
{{ SW_Code |
 +
code line 7<br>
 +
code line 8<br>
 +
code line 9
 +
}}
 +
<br style="clear:both">
 +
</pre>
  
'''Examples see:'''<br>
+
With hang in from left:
:* [[ #OperationDamlExampleCreateAccResidential | Create a "Residential Account" with 1 Public Number ]]
+
<pre>
:* [[ #OperationDamlExampleCreateAccCommercial  | Create a "SIP Trunk" Account with 100 Public Numbers for ISDN PBX behind SIP CPE ]]
+
{{ SW_Code | hangleft=50 | 10 | code line 10 }}
:* [[ #OperationDamlExampleCreateAccVpbx        | Create a vPBX Account with 5 Public Numbers ]]
+
<br style="clear:both">
 +
</pre>
  
  
 +
'''Result:'''<br>
 +
Variante 1:
 +
{{ SW_Code | 01 | code line 1 }}
 +
{{ SW_Code | 02 | code line 2 }}
 +
{{ SW_Code | 03 | code line 3 }}
 +
<br style="clear:both">
  
 +
Variante 2:
 +
{{ SW_Code |
 +
04<br>05<br>06 |
 +
code line 4<br>
 +
code line 5<br>
 +
code line 6
 +
}}
 +
<br style="clear:both">
 +
 +
Variante 3:
 +
{{ SW_Code |
 +
code line 7<br>
 +
code line 8<br>
 +
code line 9
 +
}}
 +
<br style="clear:both">
  
<!--------------------------------------------------------------------------------------------------------------->
+
With hang in from left:
{{ToTop | OperationDamlAccDelete}}
+
{{ SW_Code | hangleft=50 | 10 | code line 10 }}
=== Delete an "Account" {{Help_Status | | &nbsp; }} ===
+
<br style="clear:both">
  
By deleting an account all its:
 
:* Feature and parameter configurations will be deleted too
 
:* Associated addresses and their configurations will be deleted too
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{{!}} {{Table_Cell_General}}
  
'''DAML-Document Example:'''<br>
+
{{#if: {{{hangleft|}}} |
{{ SW_Code | |
+
  {{!}} width={{{hangleft}}} {{!}} &nbsp;
<daml command&#61;'''"delete"'''><br>
 
:<account>
 
::<accountName>'''an-acc-0021'''</accountName>
 
:</account>
 
</daml>
 
 
}}
 
}}
  
 +
{{!}} width=100  bgcolor={{GREEN_40}}  align="right" {{!}} {{#if: {{{1|}}} | <tt>{{{1}}}</tt> }}
 +
{{!}} width=900  bgcolor={{GREY_LIGHT}}              {{!}} <tt>{{{2}}}</tt>
 +
{{!}}}
 +
</pre>
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ToTop | OperationDamlAccRead}}
+
== [[Template:Star_Procedure]] ==
=== Read an "Account" {{Help_Status | | &nbsp; }} ===
 
  
By reading an account all its:
+
'''Description:''' <br>
:* Feature and parameter configurations will be read
+
Table for *# Procedure description.
 +
The headers are set according the language.
  
  
'''DAML-Document Example:'''<br>
+
'''Usage:'''<br>
{{ SW_Code | |
+
<pre>
<daml command&#61;'''"read"'''><br>
+
{{Star_Procedure
:<account>
+
|link= Diversion for a internal page link reference
:: <accountName>'''an-acc-0021'''</accountName>
+
|service_nmb= Service number
:</account>
+
|description= Kurzbeschreibung des Service
</daml>
+
|line= Anzahl Zielen mit Aktivitäten
 +
|activity1= Aktivität |code1= *#-Code  | remark1= Bemerkung
 +
|activity2= Aktivität |code2= *#-Code  | remark2= Bemerkung
 +
|activity3= Aktivität |code3= *#-Code  | remark3= Bemerkung
 +
|activity4= Aktivität |code4= *#-Code  | remark4= Bemerkung
 +
|version= Aarenet VoIP Switch V3.0
 
}}
 
}}
 +
</pre>
 +
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{Star_Procedure
 +
|link= Service21
 +
|service_nmb= 21 & 28
 +
|description= Unbedingte Umleitung (CFU)
 +
|lines= 4
 +
|activity1= Aktivierung                        |code1= *21(*)<UMLEITUNG>(#) | remark1= <UMLEITUNG> ist die Telefonnummer, auf welche umgeleitet wird.
 +
|activity2= Anrufumleitung zum Anrufbeantworter |code2= *28(#)              | remark2=
 +
|activity3= Deaktivierung                      |code3= #28(#)              | remark3=
 +
|activity4= Statusabfrage                      |code4= *#28(#)              | remark4=
 +
|version= Aarenet VoIP Switch V3.0
 +
}}
 +
</pre>
  
  
 +
'''Result:'''<br>
 +
{{Star_Procedure
 +
|link= Service21
 +
|service_nmb= 21 & 28
 +
|description= Unbedingte Umleitung (CFU)
 +
|lines= 4
 +
|activity1= Aktivierung                        |code1= *21(*)<UMLEITUNG>(#) | remark1= <UMLEITUNG> ist die Telefonnummer, auf welche umgeleitet wird.
 +
|activity2= Anrufumleitung zum Anrufbeantworter |code2= *28(#)              | remark2=
 +
|activity3= Deaktivierung                      |code3= #28(#)              | remark3=
 +
|activity4= Statusabfrage                      |code4= *#28(#)              | remark4=
 +
|version= Aarenet VoIP Switch V3.0
 +
}}
 +
<br>
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#if: {{{link|}}} | <div id="{{{link}}}"></div> }}
 +
{{{!}} {{Table_Cell_General}}
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}
{{ToTop | OperationDamlAccWrite}}
+
{{!}} width=325 {{!}}  {{#switch: {{NAMESPACE}}
=== Modify, Add or Delete an Account's Parameter or Feature {{Help_Status | | &nbsp; }} ===
+
                      | DE =      <font color=#ffffff>'''Service: {{{service_nmb}}}: {{{description}}}'''</font>
 +
                      | #default = <font color=#ffffff>'''Service: {{{service_nmb}}}: {{{description}}}'''</font>
 +
                      }}
 +
{{!}} width=175 {{!}}  {{#switch: {{NAMESPACE}}
 +
                      | DE =      <font color=#ffffff>'''<tt>*#</tt>-Code:'''</font>
 +
                      | #default = <font color=#ffffff>'''<tt>*#</tt>-Code:'''</font>
 +
                      }}
 +
{{!}} width=500 {{!}}  {{#switch: {{NAMESPACE}}
 +
                      | DE =       <font color=#ffffff>'''Bemerkung:'''</font>
 +
                      | #default = <font color=#ffffff>'''Remark:'''</font>
 +
                      }}
  
By writing to an existing account its parameters can be:
+
{{#switch: {{{lines}}}
:* Modified
+
| 1 =
:* Added
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
:* Deleted
+
{{!}} {{{activity1}}}:
 +
{{!}} {{{code1}}}
 +
{{!}} {{{remark1}}}
  
 +
| 2 =
 +
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
 +
{{!}} {{{activity1}}}:
 +
{{!}} {{{code1}}}
 +
{{!}} {{{remark1}}}
  
{{Note | type=warning |
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Darkened}}
Make sure that you write the account name and/or XML names correctly. Else the result may be unpredictable even when the response is <tt>200 OK</tt>!
+
{{!}} {{{activity2}}}:
 +
{{!}} {{{code2}}}
 +
{{!}} {{{remark2}}}
  
For details see chapter [[ #OperationDamlExchangeHttpResponse | "HTTP RESPONSE" ]] }}
+
| 3 =
 +
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
 +
{{!}} {{{activity1}}}:
 +
{{!}} {{{code1}}}
 +
{{!}} {{{remark1}}}
  
 +
{{!}}- valign="top" bgcolor{{Table_Cell_Bgcolor_Darkened}}
 +
{{!}} {{{activity2}}}:
 +
{{!}} {{{code2}}}
 +
{{!}} {{{remark2}}}
  
<div id=" OperationDamlAccWriteModify "></div>
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
'''Modifing:'''<br>
+
{{!}} {{{activity3}}}:
By re-writing an account's parameter its configuration will be changed:
+
{{!}} {{{code3}}}
:* The feature and/or parameter configurations will be modified
+
{{!}} {{{remark3}}}
:* Special modifying procedures are required for:
 
::* [[ #OperationDamlAccParamRuleset    | "Ruleset" ]]
 
::* [[ #OperationDamlAccParamAccTopStop | "TopStop" ]]
 
  
 +
| #default =
 +
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
 +
{{!}} {{{activity1}}}:
 +
{{!}} {{{code1}}}
 +
{{!}} {{{remark1}}}
  
<div id="OperationDamlAccWriteAdd"></div>
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Darkened}}
'''Adding:'''<br>
+
{{!}} {{{activity2}}}:
By adding a parameter its configuration will be created:
+
{{!}} {{{code2}}}
:* The feature and/or parameter configurations will be created
+
{{!}} {{{remark2}}}
  
 +
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
 +
{{!}} {{{activity3}}}:
 +
{{!}} {{{code3}}}
 +
{{!}} {{{remark3}}}
  
<div id="OperationDamlAccWriteDelete"></div>
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Darkened}}
'''Deleting:'''<br>
+
{{!}} {{{activity4}}}:
By writing an "empty" value to a parameter:
+
{{!}} {{{code4}}}
:* The feature and/or parameter will be deleted
+
{{!}} {{{remark4}}}
:* Special deleting procedures are required for:
+
}}
::* [[ #OperationDamlAccParamRuleset    | "Ruleset" ]]
 
::* [[ #OperationDamlAccParamAccTopStop | "TopStop" ]]
 
  
 +
{{!}}}
 +
<br style="clear:both">
 +
</pre>
  
''' DAML-Document Example "Modify a parameter":'''<br>
+
 
{{ SW_Code | |
+
 
<daml command&#61;'''"write"'''><br>
+
 
: <account>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:: <accountName>'''an-acc-0021'''</accountName>
+
== [[Template:FAQ]] ==
::
+
 
:: <info>Test Account: Tel 012 345 67 89, '''invalidated 1.1.2016'''</info>
+
'''Description:''' <br>
::
+
Table for FAQ question/response. The headers are set according the language.
: </account>
+
 
</daml>
+
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{FAQ
 +
|question= Place here the question
 +
|response= Place here the response
 
}}
 
}}
 +
</pre>
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{FAQ
 +
|question= How do I reject anonymous calls?
 +
|response= Dial on your telephone *99 or go to the AdminCenter ...
 +
}}
 +
</pre>
  
''' DAML-Document Example "Add a parameter":'''<br>
+
 
{{ SW_Code | |
+
'''Result:'''<br>
<daml command&#61;'''"write"'''><br>
+
{{FAQ
: <account>
+
|question= How do I reject anonymous calls?
:: <accountName>'''an-acc-0021'''</accountName>
+
|response= Dial on your telephone *99 or go to the AdminCenter ...
::
 
:: '''<validUntil>2016-01-01T09:30:00</validUntil>'''
 
::
 
: </account>
 
</daml>
 
 
}}
 
}}
  
  
''' DAML-Document Example "Delete a parameter ":'''<br>
+
'''Template-Code:'''<br>
{{ SW_Code | |
+
<pre>
<daml command&#61;'''"write"'''><br>
+
=== FAQ: {{{question}}} ===
: <account>
+
 
:: <accountName>'''an-acc-0021'''</accountName>
+
{{{!}} {{Table_Cell_General}}
::
+
 
::
+
{{!}}- valign="top" bgcolor={{BLUE_15}}
<nowiki><!-- Variant 1: --></nowiki>
+
{{!}} width=100 bgcolor={{BLUE_100}} {{!}}  {{#switch: {{NAMESPACE}}
:: '''<parameterA></parameterA>'''
+
                                            | DE =      <font color=#ffffff>'''Antwort:'''</font>
::
+
                                            | #default = <font color=#ffffff>'''Response:'''</font>
:
+
                                            }}
<nowiki><!-- Variant 2: --></nowiki>
+
{{!}} width=900 {{!}} {{{response}}}
:: '''<parameter/>'''
+
 
::
+
{{!}}}
: </account>
+
<br style="clear:both">
</daml>
+
</pre>
}}
+
 
 +
 
 +
 
  
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Feature Description in Web GUI =
  
 +
Here templates for feature descrition in the Web GUI (e.g. AdminCenter, ConfigCenter) are available.
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAccParam}}
 
== "Account" Parameter Configuration {{Help_Status | | &nbsp; }} ==
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:Navigation_List]] ==
  
 +
'''Description:''' <br>
 +
Is used for creating menu navigation descriptions
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlAccParamAccBasic}}
+
<pre>
=== "Account" Basic Parameter {{Help_Status | | &nbsp; }} ===
+
{{Navigation_List | <LEVEL 1 | 2 | 3 | 4 | 5 | 6 | 7> | <DESCRIPTION> }}
 +
</pre>
  
  
'''[[ #OperationDamlOverviewProvisioningDac | DAML Authorization ]] needed for:'''<br>
+
'''Example:'''<br>
{{SW_Code | | grantAccessToAccounts <USERNAME> read/write }}
+
<pre>
 +
{{Navigation_List | 1 | Register "Teilnehmer xx" }}
 +
{{Navigation_List | 2 | Register "Umleitungen" }}
 +
{{Navigation_List | 3 | Level 3 }}
 +
{{Navigation_List | 4 | Level 4 }}
 +
{{Navigation_List | 5 | Level 5 }}
 +
{{Navigation_List | 6 | Level 6 }}
 +
{{Navigation_List | 7 | Level 7 }}
 +
{{Navigation_List | 8 | Not defined level 8 remains on level 7}}
 +
</pre>
  
  
'''List of Parameters:'''<br>
+
'''Result:'''<br>
{{SW_Code | |
+
{{Navigation_List | 1 | Register "Teilnehmer xx" }}
: <account>
+
{{Navigation_List | 2 | Register "Umleitungen" }}
:: . . .
+
{{Navigation_List | 3 | Level 3 }}
:: <accountName>ACC_NAME</accountName>
+
{{Navigation_List | 4 | Level 4 }}
:: <info>ACC_INFO</info>
+
{{Navigation_List | 5 | Level 5 }}
:: <tenant>ACC_TENANT</tenant>
+
{{Navigation_List | 6 | Level 6 }}
:: . . .
+
{{Navigation_List | 7 | Level 7 }}
:: <username>ACC_SIP_USERNAME</username>
+
{{Navigation_List | 8 | Not defined level 8 remains on level 7}}
:: <password>ACC_SIP_PASSWORD</password>
+
 
:: <maxChannels>ACC_CHANNEL</maxChannels>
+
 
:: <emergencyLocation>ACC_LOCATION</emergencyLocation>
+
'''Template-Code:'''<br><pre>
:: . . .
+
{{#switch: {{{1}}}
: </account>
+
| 1 = : [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
 +
| 2 = :: [[File:admincenter_icon_navigation.gif|link=|14px|nav]]  {{{2}}}
 +
| 3 = ::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
 +
| 4 = :::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
 +
| 5 = ::::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
 +
| 6 = :::::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
 +
| #default = ::::::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
 
}}
 
}}
 +
</pre>
 +
 +
  
  
  
{{Table_Start}}
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{Xml_Table_Header
+
== [[Template:Parameter_Configuration]] ==
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
 
}}
+
'''Description:''' <br>
{{Xml_Table_Line
+
Table for parameter configuration description. The headers are set according the language.
|link= OperationDamlAccParamAccountName
+
 
|line= 1
 
|xml= accountName
 
|name= ACC_NAME
 
|format= String
 
|range= max. 32 characters
 
|default= none
 
|description=
 
<font color=#b8597c>'''Mandatory configuration!'''</font><br>
 
  
Assigns the unambiguous name of the account
+
'''Usage:'''<br>
|version= 5.2
+
<pre>
 +
{{Parameter_Configuration
 +
|link= Diversion for a internal page link reference
 +
|name= Parameter name
 +
|description= Description of the parameter
 +
|range= Describes the possible settings
 +
|default= Describes the default value
 +
|version= Describes possible AS version dependencies, by default the first apperance of this parameter
 
}}
 
}}
{{Xml_Table_Line
+
</pre>
|link= OperationDamlAccParamTenant
 
|line= 2
 
|xml= tenant
 
|name= ACC_TENANT
 
|format= String
 
|range= max. 128 characters
 
|default= none
 
|description=
 
Assigns the tenant of the account
 
  
<font color=#b8597c>'''Note:'''</font><br>
 
The tenant must be already created in the system of the VoIP Switch!
 
  
|version= 5.2
+
'''Example:'''<br>
}}
+
<pre>
{{Xml_Table_Line
+
{{Parameter_Configuration
|link= OperationDamlAccParamInfo
+
|link= VoiceMailNumber
|line= 3
+
|name= '''Example:''' Number of VoiceBox
|xml= info
 
|name= ACC_INFO
 
|format= String
 
|range= max. 128 characters
 
|default= none
 
 
|description=
 
|description=
Any information
+
Anzeige der Rufnummer, mit welcher der Anrufbeantworter innerhalb der vPBX direkt angerufen werden kann
|version= 5.2
+
|range= Selektion : Yes {{!}} No
 +
|default= Yes
 +
|version= Aarenet VoIP Switch V.57
 
}}
 
}}
{{Xml_Table_Line
+
</pre>
|link= OperationDamlAccParamUsername
 
|line= 4
 
|xml= username
 
|name= ACC_SIP_USERNAME
 
|format= String
 
|range= max. 32 characters
 
|default= none
 
|description=
 
<font color=#b8597c>'''Mandatory configuration!'''</font><br>
 
  
Assigns the unambiguous SIP user name of the account
 
  
<font color=#b8597c>'''Note:'''</font><br>
+
'''Result:'''<br>
Without SIP username no SIP CPE can register to a telephone number (SIP address) of this account!
+
{{Parameter_Configuration
|version= 5.2
+
|link= VoiceMailNumber
 +
|name= '''Example:''' Number of VoiceBox
 +
|description=
 +
Anzeige der Rufnummer, mit welcher der Anrufbeantworter innerhalb der vPBX direkt angerufen werden kann
 +
|range= Selektion : Yes {{!}} No
 +
|default= Yes
 +
|version= Aarenet VoIP Switch V.57
 
}}
 
}}
{{Xml_Table_Line
 
|link= OperationDamlAccParamPassword
 
|line= 5
 
|xml= password
 
|name= ACC_SIP_PASSWORD
 
|format= String
 
|range= max. 32 characters
 
|default= none
 
|description=
 
<font color=#b8597c>'''Mandatory configuration!'''</font><br>
 
  
Assigns the SIP password of the account
 
  
<font color=#b8597c>'''Note:'''</font><br>
+
'''Template-Code:'''<br>
Without SIP password no SIP CPE can register to a telephone number (SIP address) of this account!
+
<pre>
|version= 5.2
+
{{#if: {{{link|}}} | <div id="{{{link}}}"></div> }}
}}
+
=== Parameter: "{{{name}}}" ===
{{Xml_Table_Line
+
{{{!}} {{Table_Cell_General}}
|link= OperationDamlAccParamMaxChannels
+
 
|line= 6
+
{{!}}- align="left" valign="top"
|xml= maxChannels
+
{{!}} width=100  bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
|name= ACC_CHANNEL
+
{{#switch: {{NAMESPACE}}
|format= String
+
| De = '''Beschreibung:'''
|range= Empty<br>
+
| #default = '''Description:''' }} </font>
or<br>
+
{{!}} width=900 bgcolor={{Table_Cell_Bgcolor_Darkened}} {{!}} {{{description}}}
number >=0
 
|default= empty
 
|description=
 
Determines how many concurrent connections are possible for this account.
 
  
Value Range:
+
{{!}}- align="left" valign="top"
:* empty: No limitations
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
:* 0    : no channels &rarr; no incoming and outgoing connections are possible
+
{{#switch: {{NAMESPACE}}
:* >=1  : Exact number of possible channels
+
| De = '''Konfiguration:'''
|version= 5.2
+
| #default = '''Configuration:''' }} </font>
}}
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Light}} {{!}} {{{range}}}
{{Xml_Table_Line
 
|link= OperationDamlAccParamEmergencyLocation
 
|line= 7
 
|xml= emergencyLocation
 
|name= ACC_LOCATION
 
|format= String
 
|range= empty or defined emergency location; max. 64 characters
 
|default= empty
 
|description=
 
Assigns one Emergency Location to the account.
 
  
Value Range:
+
{{!}}- align="left" valign="top"
:* empty:
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
:: The system-wide default emergency location is used
+
{{#switch: {{NAMESPACE}}
:* Location Name:
+
| De = '''Grundwert:'''
:: The location must be already configured in the emergency call configuration of this Aarenet VoIP Switch!
+
| #default = '''Default:''' }} </font>
 +
{{!}} bgcolor={{Table_Cell_Bgcolor_Darkened}} {{!}} {{{default}}}
  
The available locations can be requested with [[ #OperationDamlQueryEmergencyLocation | DAML-Query: "List of all Emergency Locations" ]]
+
{{!}}- align="left" valign="top"
|version= 5.2
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
}}
+
{{#switch: {{NAMESPACE}}
{{Table_End}}
+
| De = '''Version:'''
 +
| #default = '''Version:''' }} </font>
 +
{{!}} bgcolor={{Table_Cell_Bgcolor_Light}} {{!}} {{{version}}}
  
 +
{{!}}}
 +
<br style="clear:both">
 +
</pre>
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAccParamAccRouting}}
 
=== "Account" Routing Parameter {{Help_Status | | &nbsp; }} ===
 
  
'''[[ #OperationDamlOverviewProvisioningDac | DAML Authorization ]] needed for:'''<br>
 
{{SW_Code | | grantAccessToAccounts <USERNAME> read/write }}
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== Web GUI Parameter Description ==
  
'''List of Parameters:'''<br>
 
{{SW_Code | |
 
: <account>
 
:: . . .
 
:: <routingTable>ACC_ROUTING_TABLE</routingTable>
 
:: <ruleset>ACC_RULESET</ruleset>
 
:: . . .
 
: <account>
 
}}
 
  
  
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamRoutingTable
 
|line= 1
 
|xml= routingTable
 
|name= ACC_ROUTING_TABLE
 
|format= String
 
|range= empty or defined Routing Table Name; max. 45 characters
 
|default= empty
 
|description=
 
Assigns one Routing Table to the account
 
  
Value Range:
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* empty:
+
=== [[Template:Dialog_Button]] ===
:: Only OnNet connections are possible
 
:* Routing Table Name:
 
:: The routing table name must be already configured in the routing configuration of this Aarenet VoIP Switch!
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamRuleset
 
|line= 2
 
|xml= ruleset
 
|name= ACC_RULESET
 
|format= String
 
|range= defined Ruleset Name; max. 128 characters
 
|default= none
 
|description=
 
Assigns none or n Rulesets to the account
 
  
Value Range:
+
'''Description:''' <br>
:* none:
+
Is used for creating a "Dialog Button" within a parameter description.
:: No Ruleset are used
 
:* Ruleset Name:
 
:: The Ruleset name must be already configured in the routing configuration of this Aarenet VoIP Switch!
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
{{Note |
 
'''Remarks for modifying or deleting of Ruleset:'''<br>
 
# If a Ruleset Name has to be modified/deleted then all configured Ruleset’s of this account must be deleted first, e.g.:
 
#:<tt><daml command&#61;"write"></tt>
 
#:: <tt><account></tt>
 
#::: <tt><accountName>SIP_TRUNK_DAML</accountName></tt>
 
#::::<tt><ruleset/></tt>
 
#:: <tt></account></tt>
 
#:<tt></daml></tt>
 
#:
 
# Then all needed Ruleset have to be rewritten again, e.g.:
 
#:<tt><daml command&#61;"write"></tt>
 
#:: <tt><account></tt>
 
#::: <tt><accountName>SIP_TRUNK_DAML</accountName></tt>
 
#:::: <tt><ruleset>Subscriber</ruleset></tt>
 
#:::: <tt><ruleset>Block : All Outgoing 090* Calls</ruleset></tt>
 
#:::: <tt><ruleset>Signal : 3 Digit Signaling</ruleset></tt>
 
#:: <tt></account></tt>
 
#:<tt></daml></tt>
 
}}
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Dialog_Button | <DESCRIPTION_BUTTON>}}
 +
</pre>
  
  
 +
'''Example:'''<br>
 +
<pre>
 +
Please press {{Dialog_Button | Create … }} for ...
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAccParamAccRating}}
 
=== "Account" Rating Parameter {{Help_Status | | &nbsp; }} ===
 
  
'''[[ #OperationDamlOverviewProvisioningDac | DAML Authorization ]] needed for:'''<br>
+
'''Result:'''<br>
{{SW_Code | | grantAccessToAccounts <USERNAME> read/write }}
+
Please press {{Dialog_Button | Create … }} for ...
  
  
'''List of Parameters:'''<br>
+
'''Template-Code:'''<br>
{{SW_Code | |
+
<pre>
: <account>
+
{{#switch: {{NAMESPACE}}
:: . . .
+
| De = Schaltfläche:
:: <pricelist>ACC_PRICELIST</pricelist>
+
| #default = Button:
:: <sendAoc>ACC_AOC</sendAoc>
 
:: . . .
 
: <account>
 
 
}}
 
}}
 +
<span style="background:#eaeaea">[ {{{1}}} ]</span>
 +
</pre>
  
  
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamPricelist
 
|line= 1
 
|xml= pricelist
 
|name= ACC_PRICELIST
 
|format= String
 
|range= empty or defined Pricelist Name; max. 32 characters
 
|default= empty
 
|description=
 
A configured Pricelist Name
 
  
Value Range:
 
:* empty:
 
:: No AOC, TopStop or Call Rating is possible if no price list is assigned to the account
 
:* Pricelist Name:
 
:: The pricelist must be already configured in the rating configuration of this Aarenet VoIP Switch!
 
  
|version= 5.2
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
}}
+
=== [[Template:Configuration_String]] ===
{{Xml_Table_Line
+
 
|link= OperationDamlAccParamSendAoc
+
'''Description:''' <br>
|line= 2
+
Is used for creating any type of "Configuration String" within the parameter description.
|xml= sendAoc
+
 
|name= ACC_AOC
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Activate sending advice of charge AOC to all addresses of the account.
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Configuration_String | <DESCRIPTION_STRING> }}
 +
</pre>
  
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{Configuration_String      | Password String }}
 +
{{Configuration_String_Item | minimun 8 character }}
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAccParamAccTopStop}}
 
=== "Account" TopStop Parameter {{Help_Status | | &nbsp; }} ===
 
  
'''[[ #OperationDamlOverviewProvisioningDac | DAML Authorization ]] needed for:'''<br>
+
'''Result:'''<br>
{{SW_Code | | grantAccessToAccounts <USERNAME> read/write }}
+
{{Configuration_String      | Password String }}
 +
{{Configuration_String_Item | minimun 8 character }}
  
  
'''List of Parameters:'''<br>
+
'''Template-Code:'''<br>
{{SW_Code | |
+
<pre>
: <account>
+
{{#switch: {{NAMESPACE}}
:: . . .
+
| De = Konfigurationstext:
::: <sysAccountTopStop>
+
| #default = Configuration String:
:::: <type>TOPSTOP_OWNER</type>
 
:::: &nbsp;
 
:::: <valueMax>TOPSTOP_MAX</valueMax>
 
:::: <monthlyReset>TOPSTOP_RESET</monthlyReset>
 
:::: <alarmLevel>TOPSTOP_ALARM_LEVEL</alarmLevel>
 
:::: &nbsp;
 
:::: <dailyMax>TOPSTOP_DAILY_MAX</dailyMax>
 
:::: <dailyReset>TOPSTOP_DAILY_RESET</dailyReset>
 
:::: &nbsp;
 
:::: <alarmEmail>TOPSTOP_EMAIL</alarmEmail>
 
:::: <blockAlarmSent>TOPSTOP_EMAIL_SENT</blockAlarmSent>
 
:::: &nbsp;
 
:::: <valueCurrent>TOPSTOP_CURRENT_VALUE</valueCurrent>
 
:::: <valueCurrent mode&#61;"TOPSTOP_CURRENT_VALUE_UPDATE_MODE">TOPSTOP_CURRENT_VALUE_UPDATE</dailyCurrent>
 
:::: &nbsp;
 
:::: <dailyCurrent>TOPSTOP_CURRENT_DAILY_VALUE</dailyCurrent>
 
:::: <dailyCurrent mode&#61;"TOPSTOP_CURRENT_DAILY_UPDATE_MODE">TOPSTOP_DAILY_VALUE_UPDATE</dailyCurrent>::: </sysAccountTopStop>
 
:: . . .
 
: </account>
 
 
}}
 
}}
 +
:* {{{1}}}
 +
</pre>
  
  
  
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopType
 
|line= 1
 
|xml= type
 
|name= TOPSTOP_OWNER
 
|format= String
 
|range=
 
Selection:
 
:* SYS
 
:* ACC
 
:* ADD
 
|default= SYS
 
|description=
 
Assigns with which user role a TopStop was created. This defines also for which role the TopStop is visible.
 
  
SYS:
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
: The TopStop was created by a system administrator. It is visible only for the role system administrator.
+
=== [[Template: Configuration_String_Item]] ===
ACC:
 
: The TopStop was created by an account operator. It is visible for the roles system administrator and account operator.
 
ADD:
 
: The TopStop was created by a subscriber. It is visible for the roles system administrator, account operator and subscriber.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopValueMax
 
|line= 2
 
|xml= valueMax
 
|name= TOPSTOP_MAX
 
|format= Number
 
|range=
 
Empty<br>
 
or<br>
 
value >= 0.00
 
|default= Empty
 
|description=
 
Assigns the charging limit per month for the account. It may not be exceeded by the charging sum of all connections of this account.
 
  
Empty:
+
'''Description:''' <br>
: No charging limit is supervised
+
Is used for adding a new line to the "Configuration String"
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopMonthlyReset
 
|line= 3
 
|xml= monthlyReset
 
|name= TOPSTOP_RESET
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= true
 
|description=
 
Assigns if the monthly maximum limit is reset at the starting of a new month.
 
  
If set to "false" the maximum limit can be interpreted as prepaid charge.
 
  
|version= 5.9
+
'''Usage:'''<br>
}}
+
<pre>
{{Xml_Table_Line
+
{{Configuration_String_Item | <DESCRIPTION_STRING> }}
|link= OperationDamlAccParamTopStopAlarmLevel
+
</pre>
|line= 4
 
|xml= alarmLevel
 
|name= TOPSTOP_ALARM_LEVEL
 
|format= Number
 
|range=
 
Empty<br>
 
or<br>
 
value = 0.0 – 1.0
 
|default= Empty
 
|description=
 
Assigns at with percentage of the monthly maximum limit a warning email is generated; e.g. 70%:
 
: <tt>150.00 * 0.7 = 105.00</tt>
 
  
Empty:
 
: No near limit is monitored.
 
  
|version= 5.2
+
'''Example:'''<br>
}}
+
<pre>
{{Xml_Table_Line
+
{{Configuration_String      | Password String }}
|link= OperationDamlAccParamTopStopDailyMax
+
{{Configuration_String_Item | minimun 8 character }}
|line= 5
+
</pre>
|xml= dailyMax
 
|name= TOPSTOP_DAILY_MAX
 
|format= Number
 
|range=
 
Empty <br>
 
or <br>
 
value >= 0.00
 
|default= Empty
 
|description=
 
Assigns the charging limit per day for the account. It may not be exceeded by the charging sum of all connections of this account.
 
  
Empty:
 
: No charging limit is supervised
 
  
|version= 5.2
+
'''Result:'''<br>
}}
+
{{Configuration_String      | Password String }}
{{Xml_Table_Line
+
{{Configuration_String_Item | minimun 8 character }}
|link= OperationDamlAccParamTopStopDailyReset
 
|line= 6
 
|xml= dailyReset
 
|name= TOPSTOP_DAILY_RESET
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= true
 
|description=
 
Assigns if the daily maximum limit is reset at the starting of a new day.
 
  
If set to "false" the maximum limit can be interpreted as prepaid charge.
 
  
|version= 5.9
+
'''Template-Code:'''<br>
}}
+
<pre>
{{Xml_Table_Line
+
:* {{{1}}}
|link= OperationDamlAccParamTopStopEmail
+
</pre>
|line= 7
 
|xml= alarmEmail
 
|name= TOPSTOP_EMAIL
 
|format= String
 
|range=
 
Empty <br>
 
or <br>
 
Email Address, max. 64 characters
 
|default= Empty
 
|description=
 
Assigns the email address which is informed when the:
 
:* the monthly near limit level is reached
 
:* the daily or monthly charging limits is reached
 
  
Empty:
 
: No email will be sent.
 
  
Email address:
 
: At overrun of the level and the charging limit an email is sent.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopBlockAlarmSent
 
|line= 8
 
|xml= blockAlarmSent
 
|name= TOPSTOP_EMAIL_SENT
 
|format= String
 
|range= Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
<font color=#b8597c>'''Read Only!'''</font><br>
 
  
Indicates that an email was sent when the daily or monthly charging limit was reached.
 
|version= 5.9
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopValueCurrent
 
|line= 9
 
|xml= valueCurrent
 
|name= TOPSTOP_CURRENT_VALUE
 
|format= Number
 
|range= >= 0.00
 
|default=
 
|description=
 
<font color=#b8597c>'''Read Only!'''</font><br>
 
  
Current total charges since resetting the charging limit.
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
|version= 5.9
+
=== [[Template:Selection_Menu]] ===
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopValueCurrentMode
 
|line= 10
 
|xml=
 
|name=
 
mode&#61;"TOPSTOP_CURRENT_VALUE_UPDATE_MODE"
 
|format= String
 
|range= Selection:
 
* force
 
* update
 
|default=
 
|description=
 
To modify current value in <tt><valueCurrent></tt> the <tt>"mode"</tt> attribute is required
 
  
 +
'''Description:''' <br>
 +
Is used for creating drop down "Selection Menu" within the parameter description with the first selection item.
  
* force:
 
::* This forces the counter to be set to the given value.
 
::: The current value is lost, the daily-max may be exceeded.
 
  
* update:
+
'''Usage:'''<br>
::* No value may be specified as it is recalculated from rating-database.
+
<pre>
::: &rarr; This might slow down the provisioning!
+
{{Selection_Menu | <DESCRIPTION_MENU_ITEM> }}
 +
</pre>
  
  
'''Examples:'''<br>
+
'''Example:'''<br>
<small><tt><valueCurrent mode="force">10.00<valueCurrent/></tt></small>
+
<pre>
 +
{{Selection_Menu      | de : Deutsch }}
 +
{{Selection_Menu_Item | en : English }}
 
<br>
 
<br>
<small><tt><valueCurrent mode="update"/></tt></small>
+
{{Selection_Menu | List of all available languages }}
|version= 5.9
+
</pre>
 +
 
 +
 
 +
'''Result:'''<br>
 +
{{Selection_Menu      | de : Deutsch }}
 +
{{Selection_Menu_Item | en : English }}
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#switch: {{NAMESPACE}}
 +
| De = Selektionsmenu:
 +
| #default = Selection Menu:
 
}}
 
}}
{{Xml_Table_Line
+
:: <span style="background:#eaeaea">{{{1}}}</span>
|link= OperationDamlAccParamTopStopValueCurrentModeValue
+
</pre>
|line= 11
+
 
|xml=
+
 
|name= TOPSTOP_CURRENT_VALUE_UPDATE
+
 
|format= Number
+
 
|range=
+
 
value >= 0.00
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
|default=
+
=== [[Template:Selection_Menu_Item]] ===
|description=
+
 
Assigns the new value for the <tt>"mode=force"</tt>
+
'''Description:'''<br>
 +
Is used for adding selection item to a "Selection Menu".
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Selection_Menu_Item | <DESCRIPTION_MENU_ITEM> }}
 +
</pre>
 +
 
  
 
'''Example:'''<br>
 
'''Example:'''<br>
<small><tt><valueCurrent mode="force">10.00<valueCurrent/></tt></small>
+
<pre>
|version= 5.9
+
{{Selection_Menu      | de : Deutsch }}
}}
+
{{Selection_Menu_Item | en : English }}
{{Xml_Table_Line
+
</pre>
|link= OperationDamlAccParamTopStopDailyValueCurrent
+
 
|line= 12
+
 
|xml= dailyCurrent
+
'''Result:'''<br>
|name= TOPSTOP_CURRENT_DAILY_VALUE
+
{{Selection_Menu      | de : Deutsch }}
|format= Number
+
{{Selection_Menu_Item | en : English }}
|range= >= 0.00
 
|default=
 
|description=
 
<font color=#b8597c>'''Read Only!'''</font><br>
 
  
Current total charges since resetting the charging limit.
 
|version= 5.9
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopValueDailyMode
 
|line= 13
 
|xml=
 
|name=
 
mode&#61;"TOPSTOP_CURRENT_DAILY_UPDATE_MODE"
 
|format= String
 
|range= Selection:
 
* force
 
* update
 
|default=
 
|description=
 
To modify current daily value in <tt><dailyCurrent></tt> the <tt>"mode"</tt> attribute is required
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
:: <span style="background:#eaeaea">{{{1}}}</span>
 +
</pre>
  
* force:
 
::* This forces the counter to be set to the given value.
 
::: The current value is lost, the daily-max may be exceeded.
 
  
* update:
 
::* No value may be specified as it is recalculated from rating-database.
 
::: &rarr; This might slow down the provisioning!
 
  
  
'''Examples:'''<br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
<small><tt><dailyCurrent mode="force">10.00<dailyCurrent/></tt></small>
+
=== [[Template:Selection_Box]] ===
<br>
 
<small><tt><dailyCurrent mode="update"/></tt></small>
 
|version= 5.9
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamTopStopValueDailyModeValue
 
|line= 14
 
|xml=
 
|name= TOPSTOP_DAILY_VALUE_UPDATE
 
|format= Number
 
|range=
 
value >= 0.00
 
|default=
 
|description=
 
Assigns the new value for the <tt>"mode=force"</tt>
 
  
'''Example:'''<br>
+
'''Description:''' <br>
<small><tt><dailyCurrent mode="force">10.00<dailyCurrent/></tt></small>
+
Is used for creating "Selection Box" within the parameter description.
|version= 5.9
 
}}
 
{{Table_End}}
 
  
  
{{Note |
+
'''Usage:'''<br>
'''Remarks for modifying or deleting of TopStop:'''<br>
+
<pre>
# If a TopStop has to be modified/deleted then all configured TopStop of this account must be deleted first, e.g.:
+
{{Selection_Box}}
#:<tt><daml command&#61;"write"></tt>
+
</pre>
#:: <tt><account></tt>
 
#::: <tt><accountName>SIP_TRUNK_DAML</accountName></tt>
 
#:::: <tt><sysAccountTopStop/></tt>
 
#:: <tt></account></tt>
 
#:<tt></daml></tt>
 
#:
 
# Then all needed TopStop have to be rewritten again, e.g.:
 
#:<tt><daml command&#61;"write"></tt>
 
#:: <tt><account></tt>
 
#::: <tt><accountName>SIP_TRUNK_DAML</accountName></tt>
 
#::: <tt><sysAccountTopStop></tt>
 
#:::: <tt><type>SYS</type></tt>
 
#:::: <tt><valueMax>20.0</valueMax></tt>
 
#:::: <tt><alarmLevel>0.7</alarmLevel></tt>
 
#:::: <tt><monthlyReset>true</monthlyReset></tt>
 
#:::: <tt><alarmEmail>info@company.com</alarmEmail></tt>
 
#:::: <tt><valueCurrent mode&#61;"update"/></tt>
 
#::: <tt></sysAccountTopStop></tt>
 
#:: <tt></account></tt>
 
#:<tt></daml></tt>
 
}}
 
  
  
 +
'''Example:'''<br>
 +
<pre>
 +
{{Selection_Box}}
 +
</pre>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Result:'''<br>
{{ToTop | OperationDamlAccParamAcc}}
+
{{Selection_Box}}
=== "Account" Advanced Parameter {{Help_Status | | &nbsp; }} ===
 
  
'''[[ #OperationDamlOverviewProvisioningDac | DAML Authorization ]] needed for:'''<br>
 
{{SW_Code | | grantAccessToAccounts <USERNAME> read/write }}
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#switch: {{NAMESPACE}}
 +
| De =
 +
Selektionsknopf: [[File:admincenter_icon_selection_box_on.gif|link=|14px|box on]] Aktiviert; [[File:admincenter_icon_selection_box_off.gif|link=|14px|box off]] Nicht aktiviert
  
'''List of Parameters:'''<br>
+
| #default =
{{SW_Code | |
+
Selection Button: [[File: admincenter_icon_selection_box_on.gif|link=|14px|box on]] Activated; [[File:admincenter_icon_selection_box_off.gif|link=|14px|box off]] Not activated
: <account>
 
:: . . .
 
::: <validAfter>ACC_VALID_AFTER</validAfter>
 
::: <validUntil>ACC_VALID_UNTIL</validUntil>
 
::: &nbsp;
 
::: <specialArrangement>ACC_SPECIAL_ARRAGEMENT</specialArrangement>
 
::: <useMediaServer>ACC_USE_MEDIA_SERVER</useMediaServer>
 
::: <network/>
 
::: &nbsp;
 
::: <sendingHoldStream>ACC_HOLD_STREAM</sendingHoldStream>
 
::: &nbsp;
 
::: <alarmOnExpiry>ACC_ALARM_ON_EXPIRY</alarmOnExpiry>
 
::: <maliciousCallerId>ACC_MCID</maliciousCallerId>
 
:::
 
:: . . .
 
: </account>
 
 
}}
 
}}
 +
</pre>
  
  
  
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamValidAfter
 
|line= 1
 
|xml= validAfter
 
|name= ACC_VALID_AFTER
 
|format= String
 
|range=
 
Empty<br>
 
or<br>
 
Date/Time
 
|default= Empty
 
|description=
 
Date/time of the activation of the account (and its associated addresses)
 
  
Empty:
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
: The account is active.
+
=== [[Template:IP_Address]] ===
  
Account Valid From:
+
'''Description:''' <br>
: The account is active beginning at Date/Time.
+
Is used for creating an "IP Address" within a parameter description.
  
  
Date/Time-Format:
+
'''Usage:'''<br>
: The format conforms to the XML standard „xml-DateTime Data Type“:
+
<pre>
: <tt>yyyy-MM-dd'T'HH:mm:ss</tt>
+
{{IP_Address | type=<mask | <cidr> | <VALUE_IP> | <VALUE_SUBNET>}}
|version= 5.2
+
</pre>
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamValidUntil
 
|line= 2
 
|xml= validUntil
 
|name= ACC_VALID_UNTIL
 
|format= String
 
|range=
 
Empty<br>
 
or<br>
 
Date/Time
 
|default= Empty
 
|description=
 
Date/Time of the deactivation of the account (and its associated addresses)
 
  
Empty:
 
: The account is active.
 
  
Account Valid Until:
+
'''Example:'''<br>
: The account is deactivated beginning at Date/Time.
+
<pre>
 +
{{IP_Address | type=mask | 10.10.10.10 | 255.255.255.0}}
 +
{{IP_Address | type=cidr | 10.10.10.10 | 24}}
 +
</pre>
  
  
Date/Time-Format:
+
'''Result:'''<br>
: The format conforms to the XML standard „xml-DateTime Data Type“:
+
{{IP_Address | type=mask | 10.10.10.10 | 255.255.255.0}}
: <tt>yyyy-MM-dd'T'HH:mm:ss</tt>
+
<br>
|version= 5.2
+
{{IP_Address | type=cidr | 10.10.10.10 | 24}}
}}
 
  
  
{{Xml_Table_Line
+
'''Template-Code:'''<br>
|link= OperationDamlAccParamSpecialArrangement
+
<pre>
|line= 3
+
{{#switch: {{{type}}}
|xml= specialArrangement
+
| cidr =
|name= ACC_SPECIAL_ARRAGEMENT
+
    {{#switch: {{NAMESPACE}}
|format= String
+
    | De =
Selection:
+
    IP Adresse durch Punkte getrenne Dezimaldarstellung im CDIR Stil: &nbsp;&nbsp;{{{1}}}/{{{2}}}
* true
+
    | #default =
* false
+
    IP address in dotted decimal notation in CDIR style: &nbsp;&nbsp;{{{1}}}/{{{2}}}
|default= false
+
    }}
|description=
 
When "Special Arrangement" is enabled then the CLIP delivered by the SIP CPE is accepted by the Aarenet VoIP Switch. The feature is also known as "CLIP no Screening".
 
  
If it is not activated then the Aarenet VoIP Switch compares the delivered CLIP with the addresses of this account and replaces it with the best match. If there is no best no best then the main number is used as CLIP. If the account has no main number defined in then the Aarenet VoIP Switch rejects the connection setup.
+
| #default =
<font color=#b8597c>'''Note:'''</font><br>
+
    {{#switch: {{NAMESPACE}}
According to the juridical situation of a country this feature may not used or only restrictively!
+
    | De =
|version= 5.2
+
    IP Adresse durch Punkte getrenne Dezimaldarstellung mit Subnetzmaske: &nbsp;&nbsp;{{{1}}}&nbsp;&nbsp; Subnetzmaske {{{2}}}
 +
    | #default =
 +
    IP address in dotted decimal notation with subnet mask: &nbsp;&nbsp;{{{1}}}&nbsp;&nbsp; Mask {{{2}}}
 +
    }}
 
}}
 
}}
{{Xml_Table_Line
+
</pre>
|link= OperationDamlAccParamUseMediaServer
+
 
|line= 4
 
|xml= useMediaServer
 
|name= ACC_USE_MEDIA_SERVER
 
|format= String
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamSendingHoldStream
 
|line= 5
 
|xml= sendingHoldStream
 
|name= ACC_HOLD_STREAM
 
|format= String
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
  
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamAlarmOnExpiry
 
|line= 6
 
|xml= alarmOnExpiry
 
|name= ACC_ALARM_ON_EXPIRY
 
|format= String
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAccParamMaliciousCallerId
 
|line= 7
 
|xml= maliciousCallerId
 
|name= ACC_MCID
 
|format= String
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddr}}
 
= DAML-Document for Treating "Address" {{Help_Status | | &nbsp; }} =
 
  
This DAML-document allows the treatment of a SIP address (telephone number), its features and parameters:
+
<!-- ========================================================================================================= -->
:* [[ #OperationDamlAddrCreate | Create an address]]
+
<!-- ========================================================================================================= -->
:* [[ #OperationDamlAddrDelete | Delete an address]]
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* [[ #OperationDamlAddrRead  | Read an address]]
+
= Tables =
:* [[ #OperationDamlAddrWriteModify | Modify parameters or features of an existing address]]
 
:* [[ #OperationDamlAddrWriteAdd    | Add parameters or features to an existing address]]
 
:* [[ #OperationDamlAddrWriteDelete | Delete parameters or features of an existing address]]
 
  
The account which is associated with an address is treated with the [[ #OperationDamlAcc | DAML-Document for Treating "Account"]].
+
The table templates allow to create standard tables with a maximum of 5 columns.
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ToTop | OperationDamlAddrXMLContainer}}
+
== Table Definitions ==
== DAML XML-Container for "Address"                                              {{Help_Status | | &nbsp; }} ==
 
  
All XML fields are listed in the address container:
 
:* The XML field '''<tt><address></tt>''' defines the XLS address container
 
:* Mandatory is the XML field '''<tt><number></tt>''' which identifies the address unambiguously.
 
:* Mandatory is the XML field is '''<tt><account></tt>''' which identifies the associated account unambiguously
 
:* The order of the XML fields is arbitrary
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Table_Start]] ===
  
'''XLS Address-Container for "Address":'''<br>
+
'''Description:''' <br>
{{ SW_Code | |
+
Starts a table.
:<address>
+
There is the possibility to add a hash tag.
:: <account>'''ACC_NAME'''</account>
 
:: <number>'''ADDR_NUMBER'''</number>
 
:: . . .
 
:: <featureN>
 
::: <parameterN>'''PARAMETER_N'''</parameterN>
 
::: . . .
 
:: </featureN>
 
:::. . .
 
:: <parameterA>'''PARAMETER_A'''</parameterA>
 
:: . . .
 
:</address>
 
}}
 
  
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Table_Start | link=<TABLE_HASHTAG>}}
 +
{{Table_Start}}
 +
</pre>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlAddrTreat}}
+
<pre>
== DAML-Document for Create, Delete, Read and Write an "Address" (Telephony Number) {{Help_Status | | &nbsp; }} ==
+
{{Table_Start | link=<TABLE_HASHTAG>}}
 +
</pre>
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#if: {{{link|}}} | <div id="{{{link}}}"></div> }}
 +
{{{!}} {{Table_Cell_General}}
 +
</pre>
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrCreate}}
 
=== Create an "Address" {{Help_Status | | &nbsp; }} ===
 
  
By creating an address all its features and parameters may be configured too.
 
  
'''DAML-Document:'''<br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ SW_Code | |
+
=== [[Template:Table_End]] ===
<daml command&#61;'''"write"'''><br>
 
: <address>
 
:: <accountName>'''ACC_NAME'''</accountName>
 
:: <number>'''ADDR_NUMBER'''</number>
 
:: . . .
 
:: <featureN>
 
::: <parameterN>'''PARAMETER_N'''</parameterN>
 
::: . . .
 
:: </featureN>
 
:::. . .
 
:: <parameterA>'''PARAMETER_A'''</parameterA>
 
:: . . .
 
: </address>
 
</daml>
 
}}
 
  
 +
'''Description:''' <br>
 +
Closes a standard table.
  
'''Examples see:'''<br>
 
:* [[ #OperationDamlExampleCreateAccResidential | Create a "Residential Account" with 1 Public Number ]]
 
:* [[ #OperationDamlExampleCreateAccCommercial  | Create a "SIP Trunk" Account with 100 Public Numbers for ISDN PBX behind SIP CPE ]]
 
:* [[ #OperationDamlExampleCreateAccVpbx        | Create a vPBX Account with 5 Public Numbers ]]
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Table_End}}
 +
</pre>
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{!}}}
 +
<br style="clear:both">
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrDelete}}
 
=== Delete an "Address" {{Help_Status | | &nbsp; }} ===
 
  
By deleting an address all its:
 
:* Feature and parameter configurations will be deleted too
 
:* Associated VoiceBox messages will be deleted too
 
  
  
'''DAML-Document Example:'''<br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ SW_Code | |
+
=== [[Template:Table_Cell_General]] ===
<daml command&#61;'''"delete"'''><br>
 
: <address>
 
:: <accountName>'''an-acc-0021'''</accountName>
 
:: <number>'''0123456789'''</number>
 
: </address>
 
</daml>
 
}}
 
  
 +
'''Description:''' <br>
 +
Defines the basic table look.
  
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Table_Cell_General}}
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrRead}}
 
=== Read an "Address" {{Help_Status | | &nbsp; }} ===
 
  
By reading an address all its:
+
'''Template-Code:'''<br>
:* Feature and parameter configurations will be read
+
<pre>
 +
align="left" cellspacing="1" cellpadding="2" bgcolor={{WHITE}}
 +
</pre>
  
  
'''DAML-Document Example:'''<br>
 
{{ SW_Code | |
 
<daml command&#61;'''"read"'''><br>
 
: <address>
 
:: <accountName>'''an-acc-0021'''</accountName>
 
:: <number>'''0123456789'''</number>
 
: </address>
 
</daml>
 
}}
 
  
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Table_Cell_Bgcolor_Header]] ===
  
 +
'''Description:'''<br>
 +
Normalized background color table header cell.
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrWrite}}
 
=== Modify, Add or Delete an Address's Parameter or Feature {{Help_Status | | &nbsp; }} ===
 
  
By writing to an existing address its parameters can be:
+
'''Usage:'''<br>
:* Modified
+
<pre>
:* Added
+
{{Table_Cell_Bgcolor_Header}}
:* Deleted
+
</pre>
  
  
{{Note | type=warning |
+
'''Result:'''<br>
Make sure that you write the account name, number and/or XML names correctly. Else the result may be unpredictable even when the response is <tt>200 OK</tt>!
+
{{Table_Start}}
 +
{{Table_Header | columns=1
 +
| width1=100
 +
| header1= Title 1
 +
}}
 +
{{Table_End}}
  
For details see [[ #OperationDamlExchangeHttpResponse | HTTP RESPONSE ]] }}
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{BLUE_100}}
 +
</pre>
  
<div id=" OperationDamlAddrWriteModify "></div>
 
'''Modifing:'''<br>
 
By re-writing an account's parameter its configuration will be changed:
 
:* The feature and/or parameter configurations will be modified
 
  
  
<div id="OperationDamlAddrWriteAdd"></div>
 
'''Adding:'''<br>
 
By adding a parameter its configuration will be created:
 
:* The feature and/or parameter configuration will be created
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Table_Cell_Bgcolor_Darkened]] ===
  
<div id="OperationDamlAccWriteDelete"></div>
+
'''Description:'''<br>
'''Deleting:'''<br>
+
Normalized background color table for a darkened cell.
By writing an "empty" value to a parameter:
 
:* the feature and/or parameter will be deleted
 
  
  
''' DAML-Document Example "Modify a parameter":'''<br>
+
'''Usage:'''<br>
{{ SW_Code | |
+
<pre>
<daml command&#61;'''"write"'''><br>
+
{{Table_Cell_Bgcolor_Darkened}}
: <account>
+
</pre>
:: <accountName>'''an-acc-0021'''</accountName>
 
:: <number>'''0123456789'''</number>
 
::
 
:: '''<language>en</language>'''
 
: </account>
 
</daml>
 
}}
 
  
  
''' DAML-Document Example "Add a parameter":'''<br>
+
'''Result:'''<br>
{{ SW_Code | |
+
{{{!}} width=100
<daml command&#61;'''"write"'''><br>
+
{{Table_Line | line=1  | columns=1 | bgcell1={{BLUE_40}}
: <account>
+
| col1= Cell 1
:: <accountName>'''an-acc-0021'''</accountName>
 
:: <number>'''0123456789'''</number>
 
::
 
:: '''<validUntil>2016-01-01T09:30:00</validUntil>'''
 
: </account>
 
</daml>
 
 
}}
 
}}
 +
{{Table_End}}
  
  
''' DAML-Document Example "Delete a parameter ":'''<br>
+
'''Template-Code:'''<br>
{{ SW_Code | |
+
<pre>
<daml command&#61;'''"write"'''><br>
+
{{BLUE_40}}
: <address>
+
</pre>
:: <accountName>'''an-acc-0021'''</accountName>
 
::
 
<nowiki><!-- Variant 1: --></nowiki>
 
:: '''<validUntil></validUntil>'''
 
::
 
<nowiki><!-- Variant 2: --></nowiki>
 
:: '''<validUntil/>'''
 
: </address>
 
</daml>
 
}}
 
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
{{ToTop | OperationDamlAddrParam}}
+
=== [[Template:Table_Cell_Bgcolor_Light]] ===
== "Address" Parameter Configuration {{Help_Status | | &nbsp; }} ==
 
  
 +
'''Description:'''<br>
 +
Normalized background color table for a light cell.
  
'''[[ #OperationDamlOverviewProvisioningDac | DAML Authorization ]] needed for:'''<br>
 
{{SW_Code | | grantAccessToAccounts <USERNAME> read/write }}
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Table_Cell_Bgcolor_Light}}
 +
</pre>
  
  
'''List of Parameters:'''<br>
+
'''Result:'''<br>
{{SW_Code | |
+
{{{!}} width=100
: <address>
+
{{Table_Line | line=1  | columns=1 | bgcell1={{BLUE_15}}
<nowiki><!-- SIP Address Main Parameterr --></nowiki>
+
| col1= Cell 1
:: <account>ADDR_ACC_NAME</account>
 
:: <number>ADDR_NUMBER</number>
 
:: <domain>ADDR_DOMAIN</domain>
 
:: <displayName>ADDR_DISPLAY</displayName>
 
:: &nbsp;
 
<nowiki><!-- SIP Address Registration Parameter --></nowiki>
 
:: <validAfter>ADDR_VALID_AFTER</validAfter>
 
:: <validUntil>ADDR_VALID_UNTIL</validUntil>
 
:: <portoutNumber>ADDR_PORTOUT_NUMBER</portoutNumber>
 
:: <registersViaMainNumber>ADDR_REG_VIA_MAIN</registersViaMainNumber>
 
:: <balancedRouting>ADDR_REG_BALANCED</balancedRouting>
 
:: &nbsp;
 
<nowiki><!-- Number Attributes & Directives --></nowiki>
 
:: <mainNumber>ADDR_MAIN_NUMB</mainNumber>
 
:: <privateNumber>ADDR_PRIVATE_NUMB</privateNumber>
 
:: <baseNumber>ADDR_BASE_NUMB</baseNumber>
 
:: <signalingOnly>ADDR_SIGNAL_ONLY</signalingOnly>
 
:: <singleLocation>ADDR_SINGLE_LOCATION</singleLocation>
 
:: <preferredNumber>ADDR_PREFERRED_NUMB</preferredNumber>
 
:: <disabled>ADDR_DISABLED</disabled>
 
:: <blocked>ADDR_BLOCKED</blocked>
 
:: &nbsp;
 
:: <queueLen>ADDR_QUEUE_LENGTH</queueLen>
 
:: <priorityCall>ADDR_PRIORITY_CALL</priorityCall>
 
:: &nbsp;
 
:: <endpointName>ADDR_ENPOINT_NAME</endpointName>
 
:: <mgcpProfile>ADDR_MGCP_PROfIL</mgcpProfile>
 
:: <msisdn>ADDR_FMC_1</msisdn>
 
:: <msisdn2>ADDR_FMC_2</msisdn2>
 
:: &nbsp;
 
<nowiki><!-- Feature: Outgoing Number Presentation --></nowiki>
 
:: <showClip>ADDR_CLIP_SHOW</showClip>
 
:: <hideClip>ADDR_CLIP_HIDE</hideClip>
 
:: <publicClip>ADDR_CLIP_PUBLIC</publicClip>
 
:: &nbsp;
 
<nowiki><!-- Feature: VoiceMail Box --></nowiki>
 
:: <messageBox>
 
::: <autoAuthentication>ADDR_VM_AUTO_AUTH</autoAuthentication>
 
::: <skipMessageMenu>ADDR_VM_SKIP_MESSAGE</skipMessageMenu>
 
::: <language>ADDR_VM_LANGUAGE</language>
 
::: <signalNewMessage>ADDR_VM_SIGNAL_NEW_MESSAGE</signalNewMessage>
 
::: <subscribedMwiOnly>ADDR_VM_SIGNAL_MWI_ONLY</subscribedMwiOnly>
 
::: <email>ADDR_VM_EMAIL</email>
 
::: <formatMp3>ADDR_VM_AUDIO_FORMAT</formatMp3>
 
::: <blocked>ADDR_VM_BLOCKED</blocked>
 
::: <faxOnly>ADDR_VM_FAX_ONLY</faxOnly>
 
::: <faxAutoDetect>ADDR_VM_FAX_VOICE_DETECT</faxAutoDetect>
 
:: </messageBox>
 
:: &nbsp;
 
<nowiki><!-- Feature: Call Forwarding --></nowiki>
 
:: <cfu>ADDR_CFU</cfu>
 
:: <cff>ADDR_CFF</cff>
 
:: <cfb>ADDR_CFB</cfb>
 
:: <cfnr>ADDR_CFNR</cfnr>
 
:: <cfo>ADDR_CFO</cfo>
 
:: <dnd>ADDR_DND</dnd>
 
:: <rrn>ADDR_RRN</rrn>
 
:: &nbsp;
 
<nowiki><!-- Feature: Diverse --></nowiki>
 
:: <language>ADDR_LANGUAGE</language>
 
:: <callWaiting>ADDR_MGCP_CALL_WAITING</callWaiting>
 
:: <callHold>ADDR_MGCP_CALL_HOLD</callHold>
 
:: <noOfferOnBusy>ADDR_CALL_NO_OFFER</noOfferOnBusy>
 
:: <autoRecord>ADDR_CALL_RECORD_AUTOMATIC</autoRecord>
 
:: <recordingEmail>ADDR_CALL_RECORD_EMAIL<recordingEmail>
 
:: &nbsp;
 
<nowiki><!-- Feature: vPBX --></nowiki>
 
:: <pbx>ADDR_GROUP_VPBX</pbx>
 
:: <groupMember>ADDR_GROUP_VPBX_MEMBER</groupMember>
 
:: <presenceGroup>ADDR_GROUP_PRESENCE</presenceGroup>
 
:: <monitorGroup>ADDR_GROUP_MONITOR</monitorGroup>
 
:: <messageGroup>ADDR_GROUP_MESSAGE</messageGroup>
 
:: &nbsp;
 
<nowiki><!-- Feature: AdminCenter Access --></nowiki>
 
:: <addressAdmin>
 
::: <username>ADDR_ADMIN_UN</username>
 
::: <password>ADDR_ADMIN_PW</password>
 
::: <language>ADDR_ADMIN_LANGUAGE</language>
 
::: <email>ADDR_ADMIN_EMAIL</email>
 
:: </addressAdmin>
 
: </address>
 
 
}}
 
}}
 +
{{Table_End}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{BLUE_15}}
 +
</pre>
 +
 +
  
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:Table_Header]] ==
  
 +
'''Description:''' <br>
 +
Standart Table Header line with max 5 columns
 +
:* use "hangleft" for hang in from the left side
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrParamSipAddrMain}}
 
=== "Address" SIP Address Main Parameter {{Help_Status | | &nbsp; }} ===
 
  
 +
'''Usage:'''<br>
 +
<pre>
 
{{Table_Start}}
 
{{Table_Start}}
{{Xml_Table_Header
+
{{Table_Header | columns=2
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
| width1=200 | width2=500
 +
| header1= Title 1 | header2= Title 2
 +
}}
 +
{{Table_End}}
 +
</pre>
 +
<pre>
 +
{{Table_Start | link=myTestTable}}
 +
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_End}}
|link= OperationDamlAddrParamAccount
+
</pre>
|line= 1
+
 
|xml= account
 
|name= ADDR_ACC_NAME
 
|format= String
 
|range= max. 32 characters
 
|default= Empty
 
|description=
 
<font color=#b8597c>'''Mandatory configuration!'''</font><br>
 
  
Assigns the unambiguous name of the account to which the telephone number belongs
+
'''Result:'''<br>
|version= 5.2
+
{{Table_Start}}
 +
{{Table_Header | columns=2
 +
| width1=200 | width2=500
 +
| header1= Title 1 | header2= Title 2
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_End}}
|link= OperationDamlAddrParamNumber
 
|line= 2
 
|xml= number
 
|name= ADDR_NUMBER
 
|format= Number
 
|range= max. 50 characters
 
|default= false
 
|description=
 
<font color=#b8597c>'''Mandatory configuration!'''</font><br>
 
  
Assigns an unambiguous telephone number
+
{{Table_Start | link=myTestTable}}
|version= 5.2
+
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_End}}
|link= OperationDamlAddrParamDomain
+
 
|line= 3
+
With hang in from left:
|xml= domain
+
{{Table_Start}}
|name= ADDR_DOMAIN
+
{{Table_Header | hangleft=50 | columns=2
|format= String
+
| width1=50 | width2=100
|range= max. 128 characters
+
| header1= Title 1 | header2= Title 2
|default= Empty
 
|description=
 
IP address or FQDN of the Aarenet VoIP Switch.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamDisplayName
 
|line= 4
 
|xml= displayName
 
|name= ADDR_DISPLAY
 
|format= String
 
|range= max. 64 characters
 
|default= Empty
 
|description=
 
Displayed name information at the called party side.
 
|version= 5.2
 
 
}}
 
}}
 
{{Table_End}}
 
{{Table_End}}
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
 +
Variante 1: Doesn't work correctly
 +
 +
{{{!}} {{Table_Cell_General}}
 +
 +
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}
 +
 +
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
 +
 +
{{#if: {{{header1|}}}  | {{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font> }}
 +
{{#if: {{{header2|}}}  | {{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font> }}
 +
{{#if: {{{header3|}}}  | {{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font> }}
 +
{{#if: {{{header4|}}}  | {{!}} width={{{width4}}} {{!}} <font color=#ffffff>'''{{{header4}}}'''</font> }}
 +
{{#if: {{{header5|}}}  | {{!}} width={{{width5}}} {{!}} <font color=#ffffff>'''{{{header5}}}'''</font> }}
 +
 +
 +
Variante 2: Works
 +
 +
 +
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}
 +
 +
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
 +
 +
{{#switch: {{{columns}}}
 +
 +
| 1 =
 +
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
  
 +
| 2 =
 +
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
 +
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
  
<!--------------------------------------------------------------------------------------------------------------->
+
| 3 =
{{ToTop | OperationDamlAddrParamSipAddrRegistration}}
+
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
=== "Address" SIP Address Registration Parameter {{Help_Status | | &nbsp; }} ===
+
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
 +
{{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
 +
 
 +
| 4 =
 +
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
 +
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
 +
{{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
 +
{{!}} width={{{width4}}} {{!}} <font color=#ffffff>'''{{{header4}}}'''</font>
 +
 
 +
| #default =
 +
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
 +
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
 +
{{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
 +
{{!}} width={{{width4}}} {{!}} <font color=#ffffff>'''{{{header4}}}'''</font>
 +
{{!}} width={{{width5}}} {{!}} <font color=#ffffff>'''{{{header5}}}'''</font>
  
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
</pre>
|link= OperationDamlAddrParamValidAfter
+
 
|line= 1
+
 
|xml= validAfter
+
 
|name= ADDR_VALID_AFTER
+
 
|format= String
+
 
|range= Date/Time
 
|default=
 
Empty<br>
 
or<br>
 
yyyy-MM-dd'T'HH:mm:ss
 
|description=
 
Date/time of the activation of the telephony number (SIP address)
 
  
Empty:<br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* The number is active.
+
== [[Template:Table_Header_Col1]] ==
Address Valid From:<br>
 
:* The number becomes active starting at Date/Time.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamValidUntil
 
|line= 2
 
|xml= validUntil
 
|name= ADDR_VALID_UNTIL
 
|format= String
 
|range= Date/Time
 
|default=
 
Empty<br>
 
or<br>
 
yyyy-MM-dd'T'HH:mm:ss
 
|description=
 
Date/time of the '''deactivation''' of the telephony number (SIP address)
 
  
Empty:<br>
+
'''Description:''' <br>
:* The number is active.
+
Table Header in the first coloumn with max 5 columns
Address Valid Until:<br>
+
:* use "hangleft" for hang in from the left side
:* The number becomes inactive starting at Date/Time.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamPortoutNumber
 
|line= 3
 
|xml= portoutNumber
 
|name= ADDR_PORTOUT_NUMBER
 
|format= String
 
|range=
 
Empty<br>
 
or<br>
 
Outpotzing Prefix, max. 50 characters
 
|default= Empty
 
|description=
 
Needed in Switzerland only!
 
  
When ADD_PORT_OUT_NUMBER is assigned and the number deactivated in ADD_VALID_UNTIL then the Aarenet VoIP Switch will redirect an incoming call toward this telephone number back into the PSTN.
 
  
Example:<br>
+
'''Usage:'''<br>
:* Outported Number : 0123456789
+
<pre>
:* NPRN new provider : 098000
+
{{Table_Start}}
:* Setting in ADD_PORT_OUT_NUMBER : 98000
+
{{Table_Header_Col1 | columns=2 | line=1 | width1=200 | width2=500
:* The rewriting result will be: 0980000123456789
+
| header1= Title 1 | col2= Cell 2
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_End}}
|link= OperationDamlAddrParamRegistersViaMainNumber
+
</pre>
|line= 4
+
<pre>
|xml= registersViaMainNumber
+
{{Table_Start}}
|name= ADDR_REG_VIA_MAIN
+
{{Table_Header_Col1 | columns=5 | line=2 | width1=200 | width2=200 | width3=150 | width4=150 | width5=150
|format= String
+
| bgcell3={{GREEN_70}}
|range=
+
| header1= Title 1 | col2= Cell 2 | col3= Cell 3 | col4= Cell 4 | col5= Cell 5
Selection:<br>
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that this telephone number is registered via the main number of this account.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_End}}
|link= OperationDamlAddrParamSingleLocation
+
</pre>
|line= 5
+
 
|xml= singleLocation
+
 
|name= ADDR_SINGLE_LOCATION
+
'''Result:'''<br>
|format= String
+
{{Table_Start}}
|range=
+
{{Table_Header_Col1 | columns=2 | line=1 | width1=200 | width2=500
Selection:
+
| header1= Title 1 | col2= Cell 2
* true
 
* false
 
|default= false
 
|description=
 
Assigns that only one SIP CPE can register to this telephone number.
 
|version= 5.10
 
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_End}}
|link= OperationDamlAddrParamBalancedRouting
 
|line= 6
 
|xml= balancedRouting
 
|name= ADDR_REG_BALANCED
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that registering SIP CPEs can provide a balancing Q value directive.
 
  
The Aarenet VoIP Switch will routing incoming calls according the balancing directive toward the SIP CPEs.
+
{{Table_Start}}
|version= 5.2
+
{{Table_Header_Col1 | columns=5 | line=2 | width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| bgcell3={{GREEN_70}}
 +
| header1= Title 1 | col2= Cell 2 | col3= Cell 3 | col4= Cell 4 | col5= Cell 5
 
}}
 
}}
 
{{Table_End}}
 
{{Table_End}}
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{Table_Cell_General}}
 +
 +
{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}
 +
 +
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
 +
 +
{{#switch: {{{columns}}}
 +
 +
| 1 =
 +
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
 +
 +
 +
| 2 =
 +
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
 +
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
 +
 +
 +
| 3 =
 +
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
 +
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
 +
{{!}} width={{{width3}}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} }} {{!}}                        {{{col3}}}
 +
 +
 +
| 4 =
 +
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
 +
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
 +
{{!}} width={{{width3}}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} }} {{!}}                        {{{col3}}}
 +
{{!}} width={{{width4}}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} }} {{!}}                        {{{col4}}}
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
| #default =
{{ToTop | OperationDamlAddrParamSipAddrAttributesDirectives}}
+
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
=== "Address" Number Attributes & Directives {{Help_Status | | &nbsp; }} ===
+
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
 +
{{!}} width={{{width3}}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} }} {{!}}                        {{{col3}}}
 +
{{!}} width={{{width4}}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} }} {{!}}                       {{{col4}}}
 +
{{!}} width={{{width5}}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} }} {{!}}                        {{{col5}}}
  
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
</pre>
|link= OperationDamlAddrParamMainNumber
+
 
|line= 1
+
 
|xml= mainNumber
+
 
|name= ADDR_MAIN_NUMB
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns this telephone number as the main number of this account.
 
  
'''&rarr; Per account only one main number is allowed!'''
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
|version= 5.2
+
== [[Template:Table_Line]] ==
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamPrivateNumber
 
|line= 2
 
|xml= privateNumber
 
|name= ADDR_PRIVATE_NUMB
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns this telephone number as the internal telephone number of this vPBX.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamBaseNumber
 
|line= 3
 
|xml= baseNumber
 
|name= ADDR_BASE_NUMB
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
This number is the base number of this account. The base number serves as a search pattern to identify an open number space.
 
  
'''&rarr; Per account there can be only one base number!'''
+
'''Description:'''<br>
 +
Table line with max 5 columns with:
 +
:* Even line number generates a darker background color where an uneven number generates a light color
 +
:* use "hangleft" for hang in from the left side
 +
:* "column1=header" generates an dark title cell on the left side
  
Example:<br>
 
: Base Number : 012345
 
::Regexp: 012345.*
 
  
  
Matches, e.g. the numbers:<br>
+
'''Usage:'''<br>
: 012345 0
+
<pre>
: 012345 100
+
Example 1:
: 012345 99999
+
{{Table_Start}}
|version= 5.2
+
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 
}}
 
}}
{{Xml_Table_Line
 
|link= OperationDamlAddrParamSignalingOnly
 
|line= 4
 
|xml= signalingOnly
 
|name= ADDR_SIGNAL_ONLY
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that this telephone number can be used only for outgoing connections.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_Line | line=1
|link= OperationDamlAddrParamPreferredNumber
+
| col1= Cell 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
|line= 5
+
}}
|xml= preferredNumber
+
{{Table_Line | line=2
|name= ADDR_PREFERRED_NUMB
+
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
|format= String
+
}}
|range=
+
{{Table_End}}
Selection:
+
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that this telephone number will always be used as CLIP for all outgoing calls from any telephone number of this account.
 
  
The number will be signaled as preferred. Either in the SIP Header "From-" or "P-Preferred".
+
Example 2: Column 1 is header
|version= 5.2
+
{{Table_Start}}
 +
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 
}}
 
}}
{{Xml_Table_Line
 
|link= OperationDamlAddrParamDisabled
 
|line= 6
 
|xml= disabled
 
|name= ADDR_DISABLED
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that this telephone number is disabled for incoming and outgoing connections.
 
 
This number cannot be created a second time on this Aarenet VoIP Switch.
 
This feature can be used for the reservation of a telephone number.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_Line | column1=header | line=1
|link= OperationDamlAddrParamBlocked
+
| col1= Header 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
|line= 7
+
}}
|xml= blocked
+
{{Table_Line | column1=header | line=2
|name= ADDR_BLOCKED
+
| col1= Header 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that this telephone number cannot used for outgoing connections.
 
Incoming connection to this telephone number are possible.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_End}}
|link= OperationDamlAddrParamQueueLen
 
|line= 8
 
|xml= queueLen
 
|name= ADDR_QUEUE_LENGTH
 
|format= Number
 
|range=
 
Empty<br>
 
or <br>
 
value >= 0
 
|default= 0
 
|description=
 
Assigns how many concurrent incoming calls toward this internal vPBX telephone number can be offered at the same time.
 
The calling sides receive the alerting tone.
 
  
The call queue is used for presenting incoming calls by the monitor function (see below VPBX_MONITOR_GROUP).
 
  
If this this feature is working depends also from the implementation on the called SIP device!
+
Example 3: Cell with special background color
|version= 5.2
+
{{Table_Start}}
 +
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 11 | header2= Title 12 | header3= Title 13 | header4= Title 14 | header5= Title 15
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamPriorityCall
 
|line= 9
 
|xml= priorityCall
 
|name= ADDR_PRIORITY_CALL
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that outgoing calls from this telephone number are handled with priority.
 
 
In extreme cases the Aarenet VoIP Switch terminates existing connections for routing a priority call toward the PSTN.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_Line |line=1 | bgcell3={{GREEN_70}}
|link= OperationDamlAddrParamEndpointName
+
| col1= Cell 1 | col2= Cell 2 | col3= Cell 3 | col4= Cell 4 | col5= Cell 5
|line= 10
 
|xml= endpointName
 
|name= ADDR_ENPOINT_NAME
 
|format= String
 
|range=
 
|default=
 
|description=
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
 
|version= 6.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_Line | line=2 | bgcell4={{MANGENTA_40}}
|link= OperationDamlAddrParamMgcpProfile
+
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
|line= 11
 
|xml= mgcpProfile
 
|name= ADDR_MGCP_PROfIL
 
|format= String
 
|range=
 
|default=
 
|description=
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_End}}
|link= OperationDamlAddrParamMsisdn
+
 
|line= 12
 
|xml= msisdn
 
|name= ADDR_FMC_1
 
|format=
 
|range=
 
|default=
 
|description=
 
'''Do not use!'''
 
  
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
+
With hang in from left:
|version= 5.10
+
{{Table_Start}}
 +
{{Table_Header | hangleft=50
 +
| width1=50 | width2=100 | columns=2
 +
| header1= Title 1 | header2= Title 2
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_Line | line=1 | bgcell1={{GREEN_70}}
|link= OperationDamlAddrParamMsisdn2
+
| col1= Cell 11 | col2= Cell 12
|line= 13
+
}}
|xml= msisdn2
+
{{Table_Line | line=2 | bgcell2={{MANGENTA_40}}
|name= ADDR_FMC_2
+
| col1= Cell 21 | col2= Cell 22
|format= String
 
|range=
 
|default=
 
|description=
 
'''Do not use!'''
 
 
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
 
|version= 5.10
 
 
}}
 
}}
 
{{Table_End}}
 
{{Table_End}}
  
 +
</pre>
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrParamFeatureClip}}
 
=== "Address" Feature: Outgoing Number Presentation {{Help_Status | | &nbsp; }} ===
 
  
 +
 +
'''Result:'''<br>
 +
 +
Example 1:<br>
 
{{Table_Start}}
 
{{Table_Start}}
{{Xml_Table_Header
+
{{Table_Header  | columns=5
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 +
}}
 +
{{Table_Line | line=1 | columns=5
 +
| col1= Cell 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
 +
}}
 +
{{Table_Line | line=2 | columns=5
 +
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_End}}
|link= OperationDamlAddrParamShowClip
 
|line= 1
 
|xml= showClip
 
|name= ADDR_CLIP_SHOW
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
These two parameters ADDR_CLIP_SHOW and ADDR_CLIP_HIDE determine whether and how the CLIP of the calling side is modified by the Aarenet VoIP Switch.
 
  
  
'''ADD_SHOW_CLIP:''' <tt>false</tt>
+
Example 2: Column 1 is header<br>
'''ADD_HIDE_CLIP:''' <tt>false</tt>
+
{{Table_Start}}
: The CLIP will not be modified by the Aarenet VoIP Switch
+
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 +
}}
 +
{{Table_Line | column1=header | line=1 | columns=5
 +
| col1= Header 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
 +
}}
 +
{{Table_Line | column1=header | line=2 | columns=5
 +
| col1= Header 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
 +
}}
 +
{{Table_End}}
  
  
'''ADD_SHOW_CLIP:''' <tt>true</tt>
+
Example 3: Cell with special background color<br>
'''ADD_HIDE_CLIP:''' <tt>false</tt>
+
{{Table_Start}}
: The Aarenet VoIP Switch forces to display the CLIP.
+
{{Table_Header | columns=5
 +
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
 +
}}
 +
{{Table_Line | line=1 | columns=5 | bgcell3={{GREEN_70}}
 +
| col1= Cell 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
 +
}}
 +
{{Table_Line | line=2 | columns=5 | bgcell4={{MANGENTA_40}}
 +
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
 +
}}
 +
{{Table_End}}
  
  
'''ADD_SHOW_CLIP:''' <tt>false</tt>
+
Example 4:<br>
'''ADD_HIDE_CLIP:''' <tt>true</tt>
+
{{Table_Start}}
: The Aarenet VoIP Switch forces to hide the CLIP &rarr; Calling Restriction CLIR
+
{{Table_Header | columns=3
 +
| width1=200 | width2=200 | width3=150
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3
 +
}}
 +
{{Table_Line | line=1 | columns=3
 +
| col1= Cell 11 | col2= Cell 12 | col3= Cell 13
 +
}}
 +
{{Table_Line | line=2 | columns=3
 +
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23
 +
}}
 +
{{Table_End}}
  
  
'''ADD_SHOW_CLIP:''' <tt>true</tt>
+
With hang in from left:<br>
'''ADD_HIDE_CLIP:''' <tt>true</tt>
+
{{Table_Start}}
: Invalid, the result is undefined!
+
{{Table_Header | hangleft=50 | columns=2
|version= 5.2
+
| width1=50 | width2=100
 +
| header1= Title 1 | header2= Title 2
 
}}
 
}}
{{Xml_Table_Line
+
{{Table_Line | hangleft=50  | line=1 | columns=2 | bgcell1={{GREEN_70}}
|link= OperationDamlAddrParamHideClip
+
| col1= Cell 11 | col2= Cell 12
|line= 2
 
|xml= hideClip
 
|name= ADDR_CLIP_HIDE
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
See description of ADDR_CLIP_SHOW above.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_Line | hangleft=50  | line=2 | columns=2 | bgcell2={{MANGENTA_40}}
|link= OperationDamlAddrParamPublicClip
+
| col1= Cell 21 | col2= Cell 22
|line= 3
 
|xml= publicClip
 
|name= ADDR_CLIP_PUBLIC
 
|format= Number
 
|range= max. 50 characters
 
|default= Empty
 
|description=
 
Assigns this telephone number as CLIP of this internal vPBX telephone number for outgoing connections toward the PSTN. The assigned public number must be from the public number range of this vPBX.
 
 
 
Note:<br>
 
* This parameter is valid only with private numbers.
 
* If no public number is configured as a public identity then no outgoing connections from this internal vPBX telephone number toward the PSTN is possible!
 
|version= 5.4
 
 
}}
 
}}
 
{{Table_End}}
 
{{Table_End}}
Line 2,182: Line 1,747:
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Template-Code:'''<br>
{{ToTop | OperationDamlAddrParamFeatureVm}}
+
<pre>
=== "Address" Feature: VoiceMail Box {{Help_Status | | &nbsp; }} ===
 
 
 
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamVmMessageBox
 
|line= 1
 
|xml= messageBox
 
|name= . . .
 
|format=
 
|range=
 
|default=
 
|description=
 
XML container which defines the VoiceMail Box parameters that is associated with this telephone number.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamVmPin
 
|line= 2
 
|xml= autoAuthentication
 
|name= ADDR_VM_PIN
 
|format= Number
 
|range=
 
Empty<br>
 
or <br>
 
value >= 0
 
|default=
 
|description=
 
<font color=#b8597c>'''Write only!'''</font><br>
 
  
 +
Variant 1: Doesn't work correctly
  
Assigns the PIN to be used for the VoiceMail Box access.
+
{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}
  
 +
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
  
Note:
+
{{#if: {{{col1|}}} |
:It is recommended to use only digits, else the user will have problems with a legacy telephone keypad.
+
{{#switch: {{{column1}}}
|version= 5.2
+
| header  =
 +
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
 +
| #default=
 +
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamVmAutoAuthentication
 
|line= 3
 
|xml= autoAuthentication
 
|name= ADDR_VM_AUTO_AUTH
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns whether the PIN is needed when the access is coming from this telephone number.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
 
|link= OperationDamlAddrParamSkipVmMessageMenu
+
{{#if: {{{col2|}}} |
|line= 4
+
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
|xml= skipMessageMenu
+
}}
|name= ADDR_VM_SKIP_MESSAGE
+
 
|format= String
+
{{#if: {{{col3|}}} |
|range=
+
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that the main menu of the VoiceMail Box are recited.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamVmLanguage
 
|line= 5
 
|xml= language
 
|name= ADDR_VM_LANGUAGE
 
|format= String
 
|range=
 
Selection:
 
* de
 
* en
 
* fr
 
* it
 
|default= Depends on the address language ADDR_LANGUAGE
 
|description=
 
Assigns the language of the announcement texts of the VoiceMail Box.
 
  
<tt>de:</tt> German<br>
+
{{#if: {{{col4|}}} |
<tt>en:</tt> English<br>
+
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
<tt>fr:</tt> French<br>
 
<tt>it:</tt> Italian
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
 
|link= OperationDamlAddrParamVmSignalNewMessage
+
{{#if: {{{col5|}}} |
|line= 6
+
{{!}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} {{!}} }}                        {{{col5}}}
|xml= signalNewMessage
 
|name= ADDR_VM_SIGNAL_NEW_MESSAGE
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= true
 
|description=
 
Assigns that a new recorded message is signaled by the message server of the Aarenet VoIP Switch to the SIP CPE.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamVmSubscribedMwiOnly
 
|line= 7
 
|xml= subscribedMwiOnly
 
|name= ADDR_VM_SIGNAL_MWI_ONLY
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= true
 
|description=
 
Defines whether and how the telephone is informed about a new message in the VoiceMailBox. The format is „Message Waiting Information MWI”.
 
  
  
<tt>true: </tt>
+
Variant 2: Doesn't work correctly
: Explicit MWI Subscription only:
+
 
: MWI messages are sent to the telephone when it prior subscribed for the WMI service.
+
{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}
<tt>false: </tt>
+
 
: Implicitly, all registered devices:
+
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
: A MWI message is automatically sent to all telephones registered to this address. The telephone must not log in with the WMI service.
+
 
|version= 5.2
+
{{#switch: {{{columns}}}
 +
| 1
 +
| 2
 +
| 3
 +
| 4
 +
| 5 =
 +
{{#switch: {{{column1}}}
 +
| header  =
 +
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
 +
| #default=
 +
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
 
}}
 
}}
{{Xml_Table_Line
 
|link= OperationDamlAddrParamVmEmail
 
|line= 8
 
|xml= email
 
|name= ADDR_VM_EMAIL
 
|format= String
 
|range=
 
Empty<br>
 
or <br>
 
Email Address, max. 64 characters
 
|default= Empty
 
|description=
 
Assigns the email address to which a VoiceMail message will be sent.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamVmFormatMp3
 
|line= 9
 
|xml= formatMp3
 
|name= ADDR_VM_AUDIO_FORMAT
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that the message audio file is MP3 formatted.
 
  
Note:<br>
+
{{#switch: {{{columns}}}
The default is WAV PCM coded.
+
| 2
|version= 5.2
+
| 3
 +
| 4
 +
| 5 =
 +
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
 
}}
 
}}
{{Xml_Table_Line
 
|link= OperationDamlAddrParamVmBlocked
 
|line= 10
 
|xml= blocked
 
|name= ADDR_VM_BLOCKED
 
|format= String
 
|range=
 
Status:
 
* no
 
* Blocked Minutes
 
|default= no
 
|description=
 
<font color=#b8597c>'''Read Only!'''</font><br>
 
  
States, if the VoiceMail Box is blocked and how long it is blocked.
+
{{#switch: {{{columns}}}
 +
| 3
 +
| 4
 +
| 5 =
 +
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
 +
}}
  
<tt>no:</tt>
+
{{#switch: {{{columns}}}
: If “no” is returned then the VoiceMailBox is not blocked.
+
| 4
 +
| 5 =
 +
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
 +
}}
  
<tt>Blocked Minutes: </tt>
+
{{#switch: {{{columns}}}
: Remaining duration of the blocking in minutes
+
| 5 =
|version= 5.2
+
{{!}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} {{!}} }}                        {{{col5}}}
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamVmFaxOnly
 
|line= 11
 
|xml= faxOnly
 
|name= ADDR_VM_FAX_ONLY
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns if this VoiceMail Box is enabled to receive Fax only.
 
|version= 5.7
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamVmFaxAutoDetect
 
|line= 12
 
|xml= faxAutoDetect
 
|name= ADDR_VM_FAX_VOICE_DETECT
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns that this VoiceMail Box detects automatically if an incoming message is a voice message or a Fax.
 
|version= 5.7
 
}}
 
{{Table_End}}
 
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrParamFeatureCf}}
 
=== "Address" Feature: Call Forwarding {{Help_Status | | &nbsp; }} ===
 
  
{{Note |
+
Variant 3: works
It is recommended not to use the call forward CF for vPBX call distributions. Use the AdminCenter feature "Distributions" for this purpose.}}
+
 
 +
{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}
 +
 
 +
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
  
 +
{{#switch: {{{columns}}}
  
{{Table_Start}}
+
| 1 =
{{Xml_Table_Header
+
{{#switch: {{{column1}}}
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
| header  =
 +
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
 +
| #default=
 +
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
 
|link= OperationDamlAddrParamCfu
+
 
|line= 1
+
| 2 =
|xml= cfu
+
{{#switch: {{{column1}}}
|name= ADDR_CFU
+
| header  =
|format= Telephone Number
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
|range= max. 50 characters
+
| #default=
|default= Empty
+
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
|description=
 
Assigns an "Call Forwarding Unconditional CFU" redirection telephone number for this telephone number.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
|link= OperationDamlAddrParamCff
+
 
|line= 2
+
 
|xml= cff
+
| 3 =
|name= ADDR_CFF
+
{{#switch: {{{column1}}}
|format= Telephone Number
+
| header  =
|range= max. 50 characters
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
|default= Empty
+
| #default=
|description=
+
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
Assigns a "Call Forwarding Fallback CFF" redirection telephone number for this telephone number.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
|link= OperationDamlAddrParamCfb
+
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
|line= 3
+
 
|xml= cfb
 
|name= ADDR_CFB
 
|format= Telephone Number
 
|range= max. 50 characters
 
|default= Empty
 
|description=
 
Assigns a "Call Forwarding Busy CFB" redirection telephone number for this telephone number.
 
  
|version= 5.2
+
| 4 =
 +
{{#switch: {{{column1}}}
 +
| header  =
 +
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
 +
| #default=
 +
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
 
}}
 
}}
{{Xml_Table_Line
+
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
|link= OperationDamlAddrParamCfnr
+
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
|line= 4
+
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
|xml= cfnr
+
 
|name= ADDR_CFNR
+
 
|format= Telephone Number
+
| #default =
|range= max. 50 characters
+
{{#switch: {{{column1}}}
|default= Empty
+
| header  =
|description=
+
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}        {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
Assigns a "Call Forwarding Not Reachable CFNR" redirection telephone number for this telephone number.
+
| #default=
|version= 5.2
+
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
|link= OperationDamlAddrParamCfo
+
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
|line= 5
+
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
|xml= cfo
+
{{!}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} {{!}} }}                        {{{col5}}}
|name= ADDR_CFO
+
 
|format= Telephone Number
 
|range= max. 50 characters
 
|default= Empty
 
|description=
 
Assigns an "Call Forking CFO" redirection telephone number for this telephone number.
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
 
|link= OperationDamlAddrParamDnd
+
 
|line= 6
+
</pre>
|xml= dnd
 
|name= ADDR_DND
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns "Do not Disturb DND" for this telephone number. Incoming calls are connected to a corresponding announcement.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamRrn
 
|line= 7
 
|xml= rrn
 
|name= ADDR_RRN
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns "Reject anonymous calls RRN" for this telephone number. Incoming calls are connected to a corresponding announcement.
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
  
  
  
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== DAML XML Parameter Table ==
  
<!--------------------------------------------------------------------------------------------------------------->
+
Example DAML Parameter Table:<br>
{{ToTop | OperationDamlAddrParamFeaturesDiv}}
 
=== "Address" Feature: Diverse {{Help_Status | | &nbsp; }} ===
 
  
 
{{Table_Start}}
 
{{Table_Start}}
 
{{Xml_Table_Header
 
{{Xml_Table_Header
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
}}
+
 
{{Xml_Table_Line | bgcolor= light
+
{{Xml_Table_Line | link= XmlAccountName1
|link= OperationDamlAddrParamLanguage
 
 
|line= 1
 
|line= 1
|xml= language
+
|xml= accountName1
|name= ADDR_LANGUAGE
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
Selection:
+
|default= empty
* de
 
* en
 
* fr
 
* it
 
|default= Depends on the address language ADDR_LANGUAGE
 
 
|description=
 
|description=
Assigns the language of the announcement, e.g. do not disturb, used for this telephone number.
+
Unambiguous name of the account<br>
 +
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 +
}}
  
<tt>de:</tt> German<br>
+
{{Xml_Table_Line | link= XmlAccountName2
<tt>en:</tt> English<br>
 
<tt>fr:</tt> French<br>
 
<tt>it:</tt> Italian
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamCallWaiting
 
 
|line= 2
 
|line= 2
|xml= callWaiting
+
|xml= accountName2
|name= ADDR_MGCP_CALL_WAITING
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
Selection:
+
|default= empty
* true
 
* false
 
|default= false
 
 
|description=
 
|description=
Assigns for MGCP MTA if it is allowed to signal a new incoming call during a running call
+
Unambiguous name of the account<br>
 +
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 +
}}
 +
{{Table_End}}
  
<tt>false</tt>:
 
: Incoming calls in busy state are not signaled.
 
<tt>true:</tt>
 
: Incoming calls in busy state are signaled.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamCallHold
 
|line= 3
 
|xml= callHold
 
|name= ADDR_MGCP_CALL_HOLD
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns for MGCP MTA if it is allowed to set the calling side on hold.
 
  
<tt>false</tt>:
+
 
: Incoming calls cannot be set on hold.
+
'''Example:'''<br>
<tt>true:</tt>
+
<pre>
: Incoming calls can be set on hold.
+
{{Table_Start}}
|version= 5.2
+
{{Xml_Table_Header
}}
+
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
 +
 
 
{{Xml_Table_Line
 
{{Xml_Table_Line
|link= OperationDamlAddrParamNoOfferOnBusy
+
|link= XmlAccountName1
|line= 4
+
|line= 1
|xml= noOfferOnBusy
+
|xml= accountName
|name= ADDR_CALL_NO_OFFER
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
Selection:
+
|default= empty
* true
 
* false
 
|default= false
 
 
|description=
 
|description=
Assigns if this telephone number is signaled a new incoming call during busy state.
+
Unambiguous name of the account<br>
|version= 5.9
+
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 
}}
 
}}
 +
 
{{Xml_Table_Line
 
{{Xml_Table_Line
|link= OperationDamlAddrParamRecordingEmail
+
|link= XmlAccountName2
|line= 5
+
|line= 2
|xml= recordingEmail
+
|xml= accountName
|name= ADDR_CALL_RECORD_EMAIL
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
Empty<br>
+
|default= empty
or <br>
 
Email Address, max. 64 characters
 
|default= Empty
 
 
|description=
 
|description=
Assigns the email address to which a recorded call will be sent.
+
Unambiguous name of the account<br>
 +
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 +
}}
  
Note:
 
: The recording is started and stopped on a by call basis by the user due to pressing the record key or stimulus *#-procedure on its telephone keypad.
 
|version= 5.7
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamAutoRecord
 
|line= 6
 
|xml= autoRecord
 
|name= ADDR_CALL_RECORD_AUTOMATIC
 
|format= String
 
|range=
 
Selection:
 
* true
 
* false
 
|default= false
 
|description=
 
Assigns if all calls will be recorded automatically and sent to the assigned email address in ADDR_CALL_RECORD_EMAIL.
 
|version= 5.8
 
}}
 
 
{{Table_End}}
 
{{Table_End}}
 +
</pre>
 +
 +
 +
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Xml_Table_Header]] ===
  
 +
'''Description:'''<br>
 +
Header line for DAML XMP parameter descriptions
 +
:* use "hangleft" for hang in from the left side
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlAddrParamFeatureVpbx}}
+
<pre>
=== "Address" Feature: Group {{Help_Status | | &nbsp; }} ===
+
{{Xml_Table_Header | hangleft= Number
 +
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5 | header6= Title 6
 +
}}
 +
</pre>
  
{{Note |
+
 
Groups are an important feature for the creation of a vPBX and the presence services within a vPBX.}}
+
'''Example:'''<br>
 +
<pre>
 +
{{Xml_Table_Header
 +
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
 +
</pre>
 +
<pre>
 +
{{Xml_Table_Header | hangleft=50
 +
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
 +
</pre>
  
  
 +
'''Result:'''<br>
 
{{Table_Start}}
 
{{Table_Start}}
 
{{Xml_Table_Header
 
{{Xml_Table_Header
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
}}
+
{{Table_End}}
{{Xml_Table_Line | bgcolor= light
+
 
|link= OperationDamlAddrParamGroupVpbx
+
{{Table_Start}}
|line= 1
+
{{Xml_Table_Header | hangleft=50
|xml= pbx
+
|header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
|name= ADDR_GROUP_VPBX
+
{{Table_End}}
|format= String
 
|range= max. 64 characters
 
|default= none
 
|description=
 
Assigns to which vPBX this telephone number belongs.
 
  
  
<font color=#b8597c>'''Note:'''</font><br>
+
'''Template-Code:'''<br>
* The vPBX group must be created already in the system of the VoIP Switch!
+
<pre>
|version= 5.2
+
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamGroupMember
 
|line= 2
 
|xml= groupMember
 
|name= ADDR_GROUP_VPBX_MEMBER
 
|format= String
 
|range=
 
|default=
 
|description=
 
Assigns from which other groups this telephone number may refer additional authorizations.
 
A telephone number can be member of n groups.
 
  
 +
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
  
<font color=#b8597c>'''Note:'''</font><br>
+
{{!}} width=25  align="right" valign="middle" bgcolor={{Table_Cell_Bgcolor_Header}}  {{!}} &nbsp;
* The groups must be created already in the system of the VoIP Switch!
+
{{!}} width=350 {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
|version= 5.2
+
{{!}} width=100 {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
}}
+
{{!}} width=100 {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
{{Xml_Table_Line | bgcolor= light
+
{{!}} width=100 {{!}} <font color=#ffffff>'''{{{header4}}}'''</font>
|link= OperationDamlAddrParamPresenceGroup
+
{{!}} width=275 {{!}} <font color=#ffffff>'''{{{header5}}}'''</font>
|line= 3
+
{{!}} width=50  {{!}} <font color=#ffffff>'''{{{header6}}}'''</font>
|xml= presenceGroup
 
|name= ADDR_GROUP_PRESENCE
 
|format= String
 
|range= max. 64 characters
 
|default= none
 
|description=
 
Assigns the group whose members are allowed to subscribe for the Presence service of this telephone number.
 
  
 +
</pre>
  
<font color=#b8597c>'''Note:'''</font><br>
 
* The group must be created already in the system of the VoIP Switch!
 
* Presence information are visible in this group and related superior groups
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link= OperationDamlAddrParamMonitorGroup
 
|line= 4
 
|xml= monitorGroup
 
|name= ADDR_GROUP_MONITOR
 
|format= String
 
|range= max. 64 characters
 
|default= none
 
|description=
 
Assigns the group whose members are allowed to subscribe for the Monitor service of this telephone number.
 
  
  
<font color=#b8597c>'''Note:'''</font><br>
 
* The group must be created already in the system of the VoIP Switch!
 
* Monitoring information are visible in this group and related superior groups
 
|version= 5.2
 
}}
 
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamMessageGroup
 
|line= 5
 
|xml= messageGroup
 
|name= ADDR_GROUP_MESSAGE
 
|format= String
 
|range= max. 64 characters
 
|default= none
 
|description=
 
Assigns the group whose members are allowed to subscribe for the Message service of this telephone number.
 
  
  
<font color=#b8597c>'''Note:'''</font><br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
* The group must be created already in the system of the VoIP Switch!
+
=== [[Template:Xml_Table_Line]] ===
* Message information are visible in this group and related superior groups
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
 +
'''Description:''' <br>
 +
Parameter line for XMP parameter descriptions
 +
:* use "hangleft" for hang in from the left side
 +
:* different line coloring due to even or odd line number
  
  
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Xml_Table_Line | hangleft= Number
 +
|link= Hash tag for a internal page link reference
 +
|line= Line Number
 +
|xml= XML Tag Name
 +
|name= Parameter name
 +
|range= Describes the possible settings
 +
|default= Describes the default value
 +
|description= Description of the parameter
 +
|version= Describes possible AS version dependencies, by default the first apperance of this parameter
 +
}}
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlAddrParamFeatureAcAccess}}
 
=== "Address" Feature: AdminCenter Access {{Help_Status | | &nbsp; }} ===
 
  
{{Table_Start}}
+
'''Example:'''<br>
{{Xml_Table_Header
+
<pre>
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
{{Xml_Table_Line
}}
+
|link= XmlAccountName1
{{Xml_Table_Line | bgcolor= light
 
|link= OperationDamlAddrParamAddressAdmin
 
 
|line= 1
 
|line= 1
|xml= addressAdmin
+
|xml= accountName
|name= . . .
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
|default=
+
|default= empty
 
|description=
 
|description=
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
+
Unambiguous name of the account<br>
|version= 5.2
+
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 
}}
 
}}
 +
</pre>
 +
<pre>
 
{{Xml_Table_Line
 
{{Xml_Table_Line
|link= OperationDamlAddrParamAddressAdminUsername
+
|link= XmlAccountName2
 
|line= 2
 
|line= 2
|xml= username
+
|xml= accountName
|name= ADDR_ADMIN_UN
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
|default=
+
|default= empty
 
|description=
 
|description=
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
+
Unambiguous name of the account<br>
|version= 5.2
+
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
</pre>
|link= OperationDamlAddrParamAddressAdminPassword
+
 
|line= 3
+
 
|xml= password
+
'''Result:'''<br>
|name= ADDR_ADMIN_PW
+
{{Table_Start}}
 +
{{Xml_Table_Header
 +
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
 +
 
 +
{{Xml_Table_Line
 +
|link= XmlAccountName1
 +
|line= 1
 +
|xml= accountName1
 +
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
|default=
+
|default= empty
 
|description=
 
|description=
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
+
Unambiguous name of the account<br>
|version= 5.2
+
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 
}}
 
}}
 +
 
{{Xml_Table_Line
 
{{Xml_Table_Line
|link= OperationDamlAddrParamAddressAdminLanguage
+
|link= XmlAccountName2
|line= 4
+
|line= 2
|xml= language
+
|xml= accountName2
|name= ADDR_ADMIN_LANGUAGE
+
|name= '''ACC_NAME'''
 
|format= String
 
|format= String
|range=
+
|range= max. 32 characters
|default=
+
|default= empty
 
|description=
 
|description=
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
+
Unambiguous name of the account<br>
|version= 5.2
+
<font color=#b8597c>'''Mandatory configuration!'''</font>
 +
|version= V5.2
 
}}
 
}}
{{Xml_Table_Line | bgcolor= light
+
{{Table_End}}
|link= OperationDamlAddrParamAddressAdminEmail
+
 
|line= 5
+
 
|xml= email
+
'''Template-Code:'''<br>
|name= ADDR_ADMIN_EMAIL
+
<pre>
|format= String
+
{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}
|range=
+
 
|default= Empty
+
{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}} &nbsp; }}
|description=
+
 
This parameter is not yet described in detail. Proposed procedure see section [[ #OperationDamlHowtoBestPracticesNotDocParam | "Not Documented DAML Parameter" ]]
+
{{!}} align="middle" bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>'''{{{line}}}'''</font>
|version= 5.2
+
 
 +
{{#if: {{{xml|}}} |
 +
    {{!}} <{{{xml}}}><font color=#0061a0>'''{{{name}}}'''</font></{{{xml}}}> | {{!}} <font color=#0061a0>'''{{{name}}}'''</font>
 
}}
 
}}
{{Table_End}}
 
  
 +
{{!}} {{{format}}}
 +
{{!}} {{{range}}}
 +
{{!}} {{{default}}}
 +
{{!}} {{{description}}}
 +
{{!}} {{{version}}}
 +
 +
{{#if: {{{link|}}} | {{!}} width=0  bgcolor={{WHITE}} {{!}} <div id="{{{link}}}"></div> | &nbsp; }}
 +
 +
</pre>
 +
 +
 +
 +
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Wiki Look Like (Theme) =
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== Pictures, Graphics, Icon ==
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_Help_Link]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined help link picture. The default size is 100pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_Help_Link | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_Help_Link }}
 +
<br>
 +
 +
{{Picture_Help_Link | size=50}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_Help_Link }}
 +
<br>
 +
 +
{{Picture_Help_Link | size=50}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:help_link_arrow.gif|link=|{{#if: {{{size|}}}|{{{size}}}|100}}px |nav]]
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_Pdf]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined PDF file picture. The default size is 14pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_Pdf | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_Pdf}}
 +
<br>
 +
 +
{{Picture_Pdf | size=25}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_Pdf}}
 +
<br>
 +
 +
{{Picture_Pdf | size=25}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:icon_file_pdf.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |PDF]]
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_Zip]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined ZIP file picture. The default size is 14pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_Zip | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_Zip}}
 +
<br>
 +
 +
{{Picture_Zip | size=25}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_Zip}}
 +
<br>
 +
 +
{{Picture_Zip | size=25}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:icon_file_zip.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |ZIP]]
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_Xml]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined XML file picture. The default size is 14pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_XML | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_Xml}}
 +
<br>
 +
 +
{{Picture_Xml | size=25}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_Xml}}
 +
<br>
 +
 +
{{Picture_Xml | size=25}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:icon_file_xml.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |XML]]
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_Img]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined image file picture. The default size is 14pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_Img | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_Img}}
 +
<br>
 +
 +
{{Picture_Img | size=25}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_Img}}
 +
<br>
 +
 +
{{Picture_Img | size=25}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:icon_file_img.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |IMG]]
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_File]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined file picture. The default size is 14pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_File | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_File}}
 +
<br>
 +
 +
{{Picture_File | size=25}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_File}}
 +
<br>
 +
 +
{{Picture_File | size=25}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:icon_file_unknown.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |File]]
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:Picture_PrintOut]] ===
 +
 +
'''Description:'''<br>
 +
Shows a defined "print out" picture. The default size is 14pt.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Picture_PrintOut | size=<PIXEL> }}
 +
</pre>
 +
 +
 +
'''Example:'''<br>
 +
<pre>
 +
{{Picture_PrintOut}}
 +
<br>
 +
 +
{{Picture_PrintOut | size=25}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{Picture_PrintOut}}
 +
<br>
 +
 +
{{Picture_PrintOut | size=25}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[File:icon_print_out.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |Print Out]]
 +
</pre>
 +
 +
 +
 +
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== Color Scheme ==
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BLUE_100]] ===
 +
 +
'''Description:'''<br>
 +
Color blue RGB 100%
 +
: R 0
 +
: G 97
 +
: B 160
 +
: #0061a0
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BLUE_100}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_100}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#0061a0"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BLUE_70]] ===
 +
 +
'''Description:'''<br>
 +
Color blue RGB 70%
 +
: R 76
 +
: G 144
 +
: B 189
 +
: #4c90bd
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BLUE_70}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_70}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#4c90bd"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BLUE_40]] ===
 +
 +
'''Description:'''<br>
 +
Color blue RGB 40%
 +
: R 153
 +
: G 192
 +
: B 217
 +
: #99c0d9
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BLUE_40}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_40}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#99c0d9"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BLUE_15]] ===
 +
 +
'''Description:'''<br>
 +
Color blue RGB 15%
 +
: R 217
 +
: G 231
 +
: B 241
 +
: #d9e7f1
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BLUE_15}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_15}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#d9e7f1"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BEIGE_100]] ===
 +
 +
'''Description:'''<br>
 +
Color beige RGB 100%
 +
: R 156
 +
: G 148
 +
: B 114
 +
: #9c9472
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BEIGE_100}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BEIGE_100}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#9c9472"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BEIGE_70]] ===
 +
 +
'''Description:'''<br>
 +
Color beige RGB 70%
 +
: R 192
 +
: G 180
 +
: B 156
 +
: #c0b49c
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BEIGE_70}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BEIGE_70}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#c0b49c"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BEIGE_40]] ===
 +
 +
'''Description:'''<br>
 +
Color beige RGB 40%
 +
: R 219
 +
: G 212
 +
: B 199
 +
: #dbd4c7
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BEIGE_40}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BEIGE_40}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#dbd4c7"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BEIGE_15]] ===
 +
 +
'''Description:'''<br>
 +
Color beige RGB 15%
 +
: R 242
 +
: G 239
 +
: B 234
 +
: #f2efea
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BEIGE_15}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BEIGE_15}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#f2efea"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREEN_100]] ===
 +
 +
'''Description:'''<br>
 +
Color green RGB 100%
 +
: R 58
 +
: G 129
 +
: B 125
 +
: #3a817d
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREEN_100}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{GREEN_100}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#3a817d"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREEN_70]] ===
 +
 +
'''Description:'''<br>
 +
Color green RGB 70%
 +
: R 117
 +
: G 167
 +
: B 164
 +
: #75a7a4
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREEN_70}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{GREEN_70}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#75a7a4"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREEN_40]] ===
 +
 +
'''Description:'''<br>
 +
Color green RGB 40%
 +
: R 176
 +
: G 205
 +
: B 203
 +
: #b0cdcb
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREEN_40}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{GREEN_40}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#b0cdcb"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREEN_15]] ===
 +
 +
'''Description:'''<br>
 +
Color green RGB 15%
 +
: R 226
 +
: G 236
 +
: B 236
 +
: #e2ecec
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREEN_1}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{GREEN_15}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#e2ecec"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:LILA_100]] ===
 +
 +
'''Description:'''<br>
 +
Color lila/purple RGB 100%
 +
: R 146
 +
: G 111
 +
: B 164
 +
: #926fa4
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{LILA_100}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{LILA_100}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#926fa4"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:LILA_70]] ===
 +
 +
'''Description:'''<br>
 +
Color lila/purple RGB 70%
 +
: R 178
 +
: G 154
 +
: B 191
 +
: #b29abf
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{LILA_70}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{LILA_70}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#b29abf"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:LILA_40]] ===
 +
 +
'''Description:'''<br>
 +
Color lila/purple RGB 40%
 +
: R 211
 +
: G 197
 +
: B 219
 +
: #d3c5db
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{LILA_40}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{LILA_40}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#d3c5db"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:LILA_15]] ===
 +
 +
'''Description:'''<br>
 +
Color lila/purple RGB 15%
 +
: R 239
 +
: G 234
 +
: B 241
 +
: #efeaf1
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{LILA_15}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{LILA_15}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#efeaf1"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:MANGENTA_100]] ===
 +
 +
'''Description:'''<br>
 +
Color magenta RGB 100%
 +
: R 184
 +
: G 89
 +
: B 124
 +
: #b8597c
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{MANGENTA_100}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{MANGENTA_100}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#b8597c"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:MANGENTA_70]] ===
 +
 +
'''Description:'''<br>
 +
Color magenta RGB 70%
 +
: R 205
 +
: G 138
 +
: B 163
 +
: #cd8aa3
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{MANGENTA_70}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{MANGENTA_70}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#cd8aa3"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:MANGENTA_40]] ===
 +
 +
'''Description:'''<br>
 +
Color magenta RGB 40%
 +
: R 227
 +
: G 189
 +
: B 203
 +
: #e3bdcb
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{MANGENTA_40}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{MANGENTA_40}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#e3bdcb"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:MANGENTA_15]] ===
 +
 +
'''Description:'''<br>
 +
Color magenta RGB 15%
 +
: R 244
 +
: G 230
 +
: B 235
 +
: #f4e6eb
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{MANGENTA_15}}
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{MANGENTA_15}} {{!}} &nbsp;
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#f4e6eb"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:BLACK]] ===
 +
 +
'''Description:'''<br>
 +
Color black RGB
 +
: R 00
 +
: G 00
 +
: B 00
 +
: #000000
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{BLACK_100}}
 +
 +
Text:
 +
<span style=color:#000000>BLACK on BLUE_15</span>
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_15}} {{!}} <span style=color:#000000>BLACK on BLUE_15</span>
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#000000"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREY_DARK]] ===
 +
 +
'''Description:'''<br>
 +
Color grey dark RGB
 +
: R 150
 +
: G 150
 +
: B 150
 +
: #969696
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREY_DARK}}
 +
 +
Text:
 +
<span style=color:#969696>GREY_DARK on BLUE_15</span>
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_15}} {{!}} <span style=color:#969696>GREY_DARK on BLUE_15</span>
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#969696"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREY_MEDIUM]] ===
 +
 +
'''Description:'''<br>
 +
Color grey medium RGB
 +
: R 192
 +
: G 192
 +
: B 192
 +
: #c0c0c0
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREY_MEDIUM}}
 +
 +
Text:
 +
<span style=color:#c0c0c0>GREY_MEDIUM on BLUE_100</span>
 +
</pre>
 +
 +
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_100}} {{!}} <span style=color:#c0c0c0>GREY_MEDIUM on BLUE_100</span>
 +
{{!}}}
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
"#c0c0c0"
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
=== [[Template:GREY_LIGHT]] ===
 +
 +
'''Description:'''<br>
 +
Color grey light RGB
 +
: R 234
 +
: G 234
 +
: B 234
 +
: #eaeaea
  
  
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{GREY_LIGHT}}
  
<!--------------------------------------------------------------------------------------------------------------->
+
Text:
{{ToTop | OperationDamlQuery}}
+
<span style=color:#eaeaea>GREY_LIGHT on BLUE_100</span>
= DAML-Query  {{Help_Status | | &nbsp; }} =
+
</pre>
  
  
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_100}} {{!}} <span style=color:#eaeaea>GREY_LIGHT on BLUE_100</span>
 +
{{!}}}
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Template-Code:'''<br>
{{ToTop | OperationDamlQueryAccountNames}}
+
<pre>
== DAML-Query: "List of All Account Names" {{Help_Status | | &nbsp; }} ==
+
"#eaeaea"
 +
</pre>
  
This Query requests the names of all accounts which are configured in this Aarenet VoIP Switch.
 
  
  
The CRM must transfer a HTTP GET with the following parameters:
 
  
'''<tt>query=account</tt>'''
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* Query directive to request all account names
+
=== [[Template:WHITE]] ===
  
 +
'''Description:'''<br>
 +
Color white RGB 100%
 +
: R 255
 +
: G 255
 +
: B 255
 +
: #ffffff
  
'''DAML-Query Example''':<br>
 
{{ SW_Code | |
 
<nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml?query&#61;'''account'''
 
}}
 
  
 +
'''Usage:'''<br>
 +
<pre>
 +
bgcolor={{WHITE}}
  
'''DAML-Response Example''':<br>
+
Text:
{{ SW_Code | |
+
<span style=color:#ffffff>WHITE on BLUE_100</span>
<daml status&#61;'''"ok"'''>
+
</pre>
: <account>'''an-acc-0020'''</account>
 
: <account>'''an-acc-0021'''</account>
 
: <account>'''an-acc-0022'''</account>
 
: <account>'''an-acc-0023'''</account>
 
</daml>
 
}}
 
  
  
 +
'''Result:'''<br>
 +
{{{!}} {{Table_Cell_General}}
 +
{{!}} width=100  bgcolor={{BLUE_100}} {{!}} <span style=color:#ffffff>WHITE on BLUE_100</span>
 +
{{!}}}
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Template-Code:'''<br>
{{ToTop | OperationDamlQueryLastConnections}}
+
<pre>
== DAML-Query: "List of the n Last Connections of a Telephone Number" {{Help_Status | | &nbsp; }} ==
+
"#ffffff"
 +
</pre>
  
This query requests a list of the last n connections and connection attempts of a phone number.
 
This DAML query delivers the raw data of a connection. It is the job of the CRM application to transform these data into the desired form and representation.
 
  
  
{{Note | type=warning |
 
Limit the requested number of entries as it blocks the database during the query execution!<br>
 
This can cause alarming messages from the Aarenet VoIP Switch monitoring.}}
 
  
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Page Header and Footer =
  
The CRM must transfer a HTTP GET with the following parameters:
 
  
'''<tt>query=calls</tt>'''
 
:* Query directive to request the last connections and connection attempts of a telephone number
 
  
'''<tt>account=QUERY_ACCOUNT</tt>'''
 
:* Unambiguous name of an account
 
  
'''<tt>number=QUERY_NUMBER</tt>'''
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* Unambiguous telephone number or SIP address
+
== [[Template:PAGE_HEADER]] ==
  
'''<tt>entries=QUERY_ENTRY</tt>'''
+
'''Description:'''<br>
:* Number of the requested connections and connection attempts
+
Customized Page Header for all help pages.
  
  
'''DAML-Query Example:'''<br>
+
'''Usage:'''<br>
{{ SW_Code | |
+
<pre>
<nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml&#63;query&#61;'''calls'''&#38;account&#61;'''an-acc-0021'''&#38;number&#61;'''01234567890'''&#38;entries&#61;'''10'''
+
{{PAGE_HEADER}}
}}
+
</pre>
  
  
'''DAML-Response:'''<br>
+
'''Example:'''<br>
{{ SW_Code | |
+
<pre>
<daml status&#61;'''"ok"'''><br>
+
{{PAGE_HEADER}}
: <call>
+
</pre>
:: <nowiki><time></nowiki>'''CALL_START'''<nowiki></time></nowiki>
+
 
:: <duration>'''CALL_DURATION'''</duration>
 
:: <direction>'''CALL_DIRECTION'''</direction>
 
:: <number>'''CALL_PEER_NUMBER'''</number>
 
:: <charge>'''CALL_CHARGE'''</charge>
 
: </call>
 
: . . .
 
</daml>
 
}}
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
  
'''DAML-Response Example:'''<br>
+
</pre>
{{ SW_Code | |
 
<daml status&#61;'''"ok"'''><br>
 
: <call>
 
:: <nowiki><time></nowiki>'''2013-05-24T14:55:13'''<nowiki></time></nowiki>
 
:: <duration>'''12527'''</duration>
 
:: <direction>'''out'''</direction>
 
:: <number>'''0987654321'''</number>
 
:: <charge>'''0.16'''</charge>
 
: </call>
 
: <call>
 
:: <nowiki><time></nowiki>'''2013-05-24T10:20:38'''<nowiki></time></nowiki>
 
:: <duration>'''0'''</duration>
 
:: <direction>'''in'''</direction>
 
:: <number>'''0987654321'''</number>
 
: </call>
 
</daml>
 
}}
 
  
  
'''Parameters:'''
 
{{Table_Start}}
 
{{Xml_Table_Header
 
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 1
 
|xml= call
 
|name= <br> . . . <br>
 
|format= none
 
|range= none
 
|default= none
 
|description= Container which holds the call details
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 2
 
|xml= <nowiki>time</nowiki>
 
|name= CALL_START
 
|format= yyyy-MM-dd'T'HH:mm:ss
 
|range= none
 
|default= none
 
|description= Date/time of the call’s start
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 3
 
|xml= duration
 
|name= CALL_DURATION
 
|format= yyyy-MM-dd'T'HH:mm:ss
 
|range= >=0
 
|default= none
 
|description=
 
Duration of the connection in milliseconds.
 
  
If the duration is 0 then it was a call attempt.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 4
 
|xml= direction
 
|name= CALL_DIRECTION
 
|format= String
 
|range=
 
Selection:
 
: in
 
: out
 
|default= none
 
|description=
 
Indicates whether it is an incoming or outgoing connection.
 
  
in:
 
: Incoming connection
 
out:
 
: Outgoing connection
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 5
 
|xml= number
 
|name= CALL_PEER_NUMBER
 
|format= String
 
|range= Telephone Number
 
|default= none
 
|description=
 
Shows the telephone number of the other participant of the connection.
 
  
The meaning depends on the '''CALL_DIRECTION''' :<br>
 
in:
 
: At incoming connections this is the number of the calling side (CLIP)
 
out:
 
: At Outgoing connection this is the dialed number
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 6
 
|xml= charge
 
|name= CALL_CHARGE
 
|format= String
 
|range= >= 0.00
 
|default= none
 
|description= Charge of an outgoing connection
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_FOOTER]] ==
  
 +
'''Description:''' <br>
 +
Customized Page Footer for all online help pages.
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlQueryRuleset}}
+
<nowiki>
== DAML-Query: "List of all Ruleset Names" {{Help_Status | | &nbsp; }} ==
+
{{PAGE_FOOTER}}
 +
</nowiki>
  
This Query requests the names of all ruleset which are configured in this Aarenet VoIP Switch.
 
  
The CRM must transfer a HTTP GET with the following parameters:
+
'''Example:'''<br>
 +
<pre>
 +
{{PAGE_FOOTER}}
 +
</pre>
  
'''<tt>query=rulesets</tt>'''
 
:* Query directive to request all configured ruleset names
 
  
 +
'''Result:'''<br>
 +
©  Copyright Aarenet Inc., Switzerland. Copying of this document or parts of it is prohibited!
  
'''DAML-Query Example''':<br>
 
{{ SW_Code | |
 
<nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml&#63;query&#61;'''rulesets'''
 
}}
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<br style="clear:both">
 +
----
 +
<small>© &nbsp; Copyright {{SITENAME}}. Copying of this document or parts of it is prohibited!</small>
 +
</pre>
  
'''DAML-Response Example:'''<br>
 
{{ SW_Code | |
 
<daml status&#61;'''"ok"'''><br>
 
: <ruleset>Route: Subscriber</ruleset>
 
: <ruleset>Signal: 2 Digit Signaling</ruleset>
 
: <ruleset>Signal: 3 Digit Signaling</ruleset>
 
: <ruleset>Block: International Calls</ruleset>
 
: <ruleset>Block: Satellite Calls</ruleset>
 
: <ruleset>Block: Block All Except Emergency Calls</ruleset>
 
</daml>
 
}}
 
  
  
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:Page_Pdf_Article]] ==
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Description:'''<br>
{{ToTop | OperationDamlQueryEmergencyLocation}}
+
Provides the "command" link for downloading the article as PDF file
== DAML-Query: "List of all Emergency Locations" {{Help_Status | | &nbsp; }} ==
 
  
This Query requests the names of all emergency locations which are configured in this Aarenet VoIP Switch.
 
  
The CRM must transfer a HTTP GET with the following parameters:
+
'''Usage:'''<br>
 +
<pre>
 +
{{Page_Pdf_Article}}
 +
</pre>
  
'''<tt>query=emergencyLocations</tt>'''
 
:* Query directive to request all configured emergency locations
 
  
 +
'''Result:'''<br>
 +
{{Page_Pdf_Article}}
  
'''DAML-Query Example:'''<br>
 
{{ SW_Code | |
 
<nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml&#63;query&#61;'''emergencyLocations'''
 
}}
 
  
  
'''DAML-Response Example:'''<br>
+
'''Template-Code:'''<br>
{{ SW_Code | |
+
<pre>
<daml status&#61;'''"ok"'''><br>
+
{{fullurl:{{FULLPAGENAME}}|action=pdfbook&format=single}}
: <emergencyLocation>GN0001 Aeugst am Albis</emergencyLocation>
+
</pre>
: <emergencyLocation>GN0002 Affoltern am Albis</emergencyLocation>
 
: <emergencyLocation>GN0003 Bonstetten</emergencyLocation>
 
</daml>
 
}}
 
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlQueryAnnouncementName}}
 
== DAML-Query: "List of All Announcement Names of a Telephone Number" {{Help_Status | | &nbsp; }} ==
 
  
This query requests the names of all announcement names of a telephone number.
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:Page_Help_Links]] ==
  
 +
'''Description:'''<br>
 +
* Contains a search field
 +
* Offers the possibility to insert up to 5 navigation or other links:
 +
:* nolink : cell is empty
 +
:* pdfdarticle : The article will be downloaded as PDF file
 +
:* any other string is interpreted as link
  
The CRM must transfer a HTTP GET with the following parameters:
 
  
'''<tt>query=announcements</tt>'''
+
'''Usage:'''<br>
:* Query directive to request all announcement names of a telephone number.
+
<pre>
 +
Example 1:
 +
{{Page_Help_Links
 +
| width1=225 | link1=nolink
 +
| width2=225 | link2=nolink
 +
| width3=225 | link3=nolink
 +
| width4=225 | link4=pdfarticle
 +
| width5=100 | link5=nolink
 +
}}
  
'''<tt>account=QUERY_ACCOUNT</tt>'''
 
:* Unambiguous name of an account
 
  
'''<tt>number=QUERY_NUMBER</tt>'''
+
Example 2:
:* Unambiguous telephone number or SIP address
+
{{Page_Help_Links
 +
| width1=225 | link1={{NAMESPACE}}:help_user                | descr1=Main Help for users and vPBX admins
 +
| width2=225 | link2={{NAMESPACE}}:admincenter_feature_list | descr2=List of all features
 +
| width3=225 | link3=nolink
 +
| width4=225 | link4=pdfarticle
 +
| width5=100 | link5={{Page_Language_Selection | lang=de }} | descr5=Deutsch
 +
}}
 +
</pre>
  
  
'''DAML-Query Example:'''<br>
+
'''Result:'''<br>
{{ SW_Code | |
+
Example 1:
<nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml&#63;query&#61;'''announcements'''&#38;account&#61;'''an-acc-0021'''&#38;number&#61;'''01234567890'''
+
{{Page_Help_Links
 +
| width1=225 | link1=nolink
 +
| width2=225 | link2=nolink
 +
| width3=225 | link3=nolink
 +
| width4=225 | link4=pdfarticle
 +
| width5=100 | link5=nolink
 
}}
 
}}
  
  
'''DAML-Response:'''<br>
+
Example 2:
{{ SW_Code | |
+
{{Page_Help_Links
<daml status&#61;'''"ok"'''><br>
+
| width1=225 | link1={{NAMESPACE}}:help_user                | descr1=Main Help for users and vPBX admins
: <message>
+
| width2=225 | link2={{NAMESPACE}}:admincenter_feature_list | descr2=List of all features
:: <id>'''ANNONCEMENT_ID'''</id>
+
| width3=225 | link3=nolink
:: <duration>'''ANNONCEMENT_DURATION'''</duration>
+
| width4=225 | link4=pdfarticle
:: <name>'''ANNONCEMENT_NAME'''</name>
+
| width5=100 | link5={{Page_Language_Selection | lang=de }} | descr5=Deutsch
: </message>
 
: . . .
 
</daml>
 
 
}}
 
}}
  
  
'''DAML-Response Example:'''<br>
+
 
{{ SW_Code | |
+
'''Template-Code:'''<br>
<daml status&#61;'''"ok"'''><br>
+
<pre>
: <message>
+
{{{!}} {{Table_Cell_General}} width=1000
:: <id>179</id>
+
 
:: <name>Office Time</name>
+
{{!}} bgcolor={{WHITE}} {{!}}
:: <duration>16325</duration>
+
{{#switch: {{NAMESPACE}}
: </message>
+
| De =
: <message>
+
<div style="float:right">
:: <id>180</id>
+
  <inputbox>
:: <name>Weekend</name>
+
    type=search
:: <duration>253346</duration>
+
    Namespaces=De
: </message>
+
    width=30
</daml>
+
    placeholder=Durchsuche die Online-Hilfe
 +
    searchbuttonlabel=Suchen
 +
    fulltextbutton=false
 +
    break=no
 +
  </inputbox>
 +
| #default =
 +
<div style="float:right">
 +
  <inputbox>
 +
    type=search
 +
    Namespaces=Main
 +
    width=30
 +
    placeholder=Search the Online Help
 +
    searchbuttonlabel=Search
 +
    fulltextbutton=false
 +
    break=no
 +
  </inputbox>
 +
</div>
 
}}
 
}}
 +
{{!}}}
 +
<br style="clear:both">
  
 +
{{{!}} {{Table_Cell_General}} width=1000
 +
{{!}}- valign="top" bgcolor={{BLUE_15}}
  
'''Parameters:'''
+
{{!}} width={{{width1}}} {{!}}
{{Table_Start}}
+
{{#switch: {{{link1}}}
{{Xml_Table_Header
+
| nolink  = &nbsp;
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
 
 +
| pdfarticle =
 +
  {{#switch: {{NAMESPACE}}
 +
  | De =
 +
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
 +
  | #default =
 +
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
 +
  }}
 +
 
 +
| #default =
 +
  {{#if: {{#pos:{{{link1|}}}|http}}
 +
  | &rarr; [{{{link1}}} <small>{{{descr1}}}</small>]
 +
  | &rarr; [[{{{link1}}} | <small>{{{descr1}}}</small>]]
 +
  }}
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
+
{{!}} width={{{width2}}} {{!}}
|line= 1
+
{{#switch: {{{link2}}}
|xml= message
+
| nolink  = &nbsp;
|name= <br> . . . <br>
+
 
|format= none
+
| pdfarticle =
|range= none
+
  {{#switch: {{NAMESPACE}}
|default= none
+
  | De =
|description= Container which holds the announcement parameters
+
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
|version= 5.2
+
  | #default =
 +
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
 +
  }}
 +
 
 +
| #default =
 +
  {{#if: {{#pos:{{{link2}}}|http}}
 +
  | &rarr; [{{{link2}}} <small>{{{descr2}}}</small>]
 +
  | &rarr; [[{{{link2}}} | <small>{{{descr2}}}</small>]]
 +
  }}
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
+
{{!}} width={{{width3}}} {{!}}
|line= 2
+
{{#switch: {{{link3}}}
|xml= id
+
| nolink  = &nbsp;
|name= ANNONCEMENT_ID
+
 
|format= Number
+
| pdfarticle =
|range= >=0
+
  {{#switch: {{NAMESPACE}}
|default= none
+
  | De =
|description= Unambiguous identification of the announcement
+
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
|version= 5.2
+
  | #default =
 +
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
 +
  }}
 +
 
 +
| #default =
 +
  {{#if: {{#pos:{{{link3}}}|http}}
 +
  | &rarr; [{{{link3}}} <small>{{{descr3}}}</small>]
 +
  | &rarr; [[{{{link3}}} | <small>{{{descr3}}}</small>]]
 +
  }}
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
+
{{!}} width={{{width4}}} {{!}}
|line= 3
+
{{#switch: {{{link4}}}
|xml= name
+
| nolink  = &nbsp;
|name= ANNONCEMENT_NAME
+
 
|format= String
+
| pdfarticle =
|range=
+
  {{#switch: {{NAMESPACE}}
|default= none
+
  | De =
|description= Name of the announcement
+
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
|version= 5.2
+
  | #default =
 +
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
 +
  }}
 +
 
 +
| #default =
 +
  {{#if: {{#pos:{{{link4}}}|http}}
 +
  | &rarr; [{{{link4}}} <small>{{{descr4}}}</small>]
 +
  | &rarr; [[{{{link4}}} | <small>{{{descr4}}}</small>]]
 +
  }}
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
+
{{!}} width={{{width5}}} {{!}}
|line= 4
+
{{#switch: {{{link5}}}
|xml= duration
+
| nolink  = &nbsp;
|name= ANNONCEMENT_DURATION
+
 
|format= Number
+
| pdfarticle =
|range= >=0, in milliseconds
+
  {{#switch: {{NAMESPACE}}
|default= none
+
  | De =
|description= Duration of the announcement
+
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
|version= 5.2
+
  | #default =
 +
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
 +
  }}
 +
 
 +
| #default =
 +
  {{#if: {{#pos:{{{link5}}}|http}}
 +
  | &rarr; [{{{link5}}} <small>{{{descr5}}}</small>]
 +
  | &rarr; [[{{{link5}}} | <small>{{{descr5}}}</small>]]
 +
  }}
 
}}
 
}}
{{Table_End}}
+
 
 +
{{!}}}
 +
<br style="clear:both">
 +
 
 +
</pre>
  
  
  
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlQueryMessageName}}
 
== DAML-Query: "List of all VoiceMail Messages of a Telephone Number" {{Help_Status | | &nbsp; }} ==
 
  
This query requests the identifications of all messages of a telephone number's VoiceMail box.
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
  
 +
== [[Template:Page_Version]] ==
  
The CRM must transfer a HTTP GET with the following parameters:
+
'''Description:'''<br>
 +
Shows the page release version.
 +
<br>
 +
&rarr; TEMPLATE-DIFFERENCE
  
'''<tt>query=voiceMessages</tt>'''
 
:* Query directive to request all message information of a telephone number’s VoiceMail Box.
 
  
'''<tt>account=QUERY_ACCOUNT</tt>'''
+
'''Usage:'''<br>
:* Unambiguous name of an account
+
<pre>
 +
{{PAGE_VERSION |version=1.2 |author=Aarenet |date=October 2015}}
 +
</pre>
  
'''<tt>number=QUERY_NUMBER</tt>'''
 
:* Unambiguous telephone number or SIP address
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
  
'''DAML-Query Example:'''<br>
+
<br style="clear:both"><br>
{{ SW_Code | |
+
<small>Version: {{{version}}}</small><br>
<nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml&#63;query&#61;'''voiceMessages'''&#38;account&#61;'''an-acc-0021'''&#38;number&#61;'''01234567890'''
+
<small>Author&nbsp;: {{{author}}}</small><br>
 +
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
 +
| &nbsp;
 +
| <small>Date&nbsp;&nbsp;&nbsp;: {{REVISIONDAY}}.{{REVISIONMONTH}}.{{REVISIONYEAR}}</small><br>
 
}}
 
}}
 +
 +
<!--Alternative date: {{{date}}} -->
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:Page_Language_Selection]] ==
 +
 +
'''Description:''' <br>
 +
Change the language of the page:
 +
: en  : English
 +
: de  : German
 +
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
{{Page_Language_Selection | lang=en }}
 +
</pre>
  
  
'''DAML-Response:'''<br>
+
'''Template-Code:'''<br>
{{ SW_Code | |
+
<pre>
<daml status&#61;'''"ok"'''><br>
+
{{#switch: {{{lang}}}
: <message>
+
| de =      {{Page_Help_Url | lang=de }}:{{PAGENAMEE}}
:: <id>'''MESSAGE_ID'''</id>
+
| #default = {{Page_Help_Url | lang=en }}:{{PAGENAMEE}}
:: <name>'''MESSAGE_NAME'''</name>
 
:: <number>'''MESSAGE_NUMBER'''</number>
 
:: <timeStart>'''MESSAGE_DATE_TIME'''</timeStart>
 
:: <timePlayed>'''MESSAGE_PLAYED'''</timePlayed>
 
:: <duration>'''MESSAGE_DURATION'''</duration>
 
:: <saved>'''MESSAGE_SAVED'''</saved>
 
: </message>
 
: . . .
 
</daml>
 
 
}}
 
}}
 +
</pre>
 +
 +
 +
  
 +
== [[Template:Page_Help_Url]] ==
 +
'''Description:''' <br>
 +
Defines the Help page URL or IP address of a
 +
: lang=en : URL for English help pages, eg http://test-help.aarenet.com/wiki/
 +
: lang=de : URL for German  help pages,  eg http://test-help.aarenet.com/wiki/De
 +
&rarr; TEMPLATE-DIFFERENCE
 +
 +
 +
'''Usage:'''<br>
 +
<nowiki>
 +
{{Page_Help_Url | lang=de }}
 +
</nowiki>
  
'''DAML-Response Example:'''<br>
 
{{ SW_Code | |
 
<daml status&#61;'''"ok"'''><br>
 
: <message>
 
:: <id>167</id>
 
:: <name>Dani</name>
 
:: <number>0987654321</number>
 
:: <timeStart>2016-01-14T10:29:00</timeStart>
 
:: <timePlayed>never</timePlayed>
 
:: <duration>35563</duration>
 
:: <saved>false</saved>
 
: </message>
 
: <message>
 
:: <id>786</id>
 
:: <name></name>
 
:: <number>0283746551</number>
 
:: <timeStart>2016-01-20T16:12:54</timeStart>
 
:: <timePlayed>never</timePlayed>
 
:: <duration>13876</duration>
 
:: <saved>false</saved>
 
: </message>
 
</daml>
 
}}
 
  
 +
'''Template-Code:'''<br>
 +
<pre>
  
'''Parameters:'''
+
{{#switch: {{{lang}}}
{{Table_Start}}
+
| de =
{{Xml_Table_Header
+
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version:
+
| http://{{An_Wiki_Fqdn_Ip}}/wiki/De
 +
| http://{{An_Wiki_Fqdn_Ip_Test}}/wiki/De
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
+
| #default =
|line= 1
+
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
|xml= message
+
| http://{{An_Wiki_Fqdn_Ip}}/wiki/
|name= <br> . . . <br>
+
| http://{{An_Wiki_Fqdn_Ip_Test}}/wiki/
|format= none
 
|range= none
 
|default= none
 
|description= Container which holds the message parameters
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
 
|line= 2
 
|xml= id
 
|name= MESSAGE_ID
 
|format= Number
 
|range= >=0
 
|default= none
 
|description= Unambiguous identification of the message
 
|version= 5.2
 
 
}}
 
}}
{{Xml_Table_Line
+
 
|link=
+
</pre>
|line= 3
+
 
|xml= name
+
 
|name= MESSAGE_NAME
+
 
|format= String
+
 
|range=
+
<!-- ========================================================================================================= -->
|default= none
+
<!-- ========================================================================================================= -->
|description= Name in the <Display> part of the SIP-Header "From:"
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
|version= 5.2
+
= Page Text Sections =
 +
 
 +
These templates offers to include defined text sections of a page to be included (Wikipedia: transclude) in another page.
 +
 
 +
{{Note|
 +
A page can have only one standardized section transclusion as offered with these templates.
 
}}
 
}}
{{Xml_Table_Line
 
|link=
 
|line= 4
 
|xml= number
 
|name= MESSAGE_NUMBER
 
|format= Number
 
|range= >=0
 
|default= none
 
|description= Telephony number of the calling side.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 5
 
|xml= timeStart
 
|name= MESSAGE_DATE_TIME
 
|format= yyyy-MM-dd'T'HH:mm:ss
 
|range=
 
|default= none
 
|description= Date/time of the recording of the message
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 6
 
|xml= timePlayed
 
|name= MESSAGE_PLAYED
 
|format= String
 
|range=
 
Selection:
 
: never
 
: yyyy-MM-dd'T'HH:mm:ss
 
|default= none
 
|description= Date/time, when the message was played the last time.<br>
 
<tt>never</tt>:<br>
 
: The message was never played.
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 7
 
|xml= timeStart
 
|name= MESSAGE_DATE_TIME
 
|format= yyyy-MM-dd'T'HH:mm:ss
 
|range=
 
|default= none
 
|description= Date/time of the recording of the message
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 8
 
|xml= duration
 
|name= MESSAGE_DURATION
 
|format= Number
 
|range= >=0, in milliseconds
 
|default= none
 
|description= Duration of the message
 
|version= 5.2
 
}}
 
{{Xml_Table_Line
 
|link=
 
|line= 9
 
|xml= saved
 
|name= MESSAGE_SAVED
 
|format= String
 
|range=
 
Selection:
 
: true
 
: false
 
|default= none
 
|description= Indicates whether the message was marked by the user for a longer retention
 
|version= 5.2
 
}}
 
{{Table_End}}
 
  
  
  
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_SECTION_BEGIN]] ==
 +
 +
'''Description:''' <br>
 +
Marks the beginning of the page main section.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
<!-- {{PAGE_SECTION_BEGIN}} --------------------------------------------------------------><section begin=page />
 +
 +
</pre>
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<section begin=chapter1 />
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_SECTION_END]] ==
 +
 +
'''Description:'''<br>
 +
Marks the end of the page main section.
 +
 +
 +
'''Usage:'''<br>
 +
<pre>
 +
<!-- {{PAGE_SECTION_END}} ----------------------------------------------------------------><section end=page />
 +
</pre>
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<section end=chapter1 />
 +
</pre>
 +
 +
 +
 +
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_SECTION_TRANSCLUDE]] ==
 +
 +
'''Description:''' <br>
 +
Includes in the page main section of the defined source page.
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Usage:'''<br>
{{ToTop | OperationDamlExample}}
+
<pre>
= DAML-Document Examples {{Help_Status | | &nbsp; }} =
+
{{PAGE_SECTION_TRANSCLUDE | link=<NAMESPACE>:<PAGE_TITLE> }}
 +
</pre>
  
  
 +
'''Example:'''<br>
 +
<nowiki>
 +
{{PAGE_SECTION_TRANSCLUDE | link=admincenter_phone_anipphone }}
 +
</nowiki>
  
  
<!--------------------------------------------------------------------------------------------------------------->
+
'''Template-Code:'''<br>
{{ToTop | OperationDamlExampleCreateAccResidential}}
+
<pre>
== Create a "Residential Account" with 1 Public Number {{Help_Status | | &nbsp; }} ==
+
{{#lst:{{{link}}}|chapter1 }}
 +
</pre>
  
'''Requirement:'''<br>
 
:* Account for private customer with one telephone number
 
:* Customer public number 0987654321
 
:* Account TopStop with 50.00, warning at 70%, email to user@home.com
 
:* Block calls toward 09* numbers
 
:* VoiceMail Box active with email to user@home.com
 
:* CFF to telephone number 0123456789
 
  
  
See also: [[ #OperationDamlHowtoScriptResidential | "Download DAML Test Scripts for a Residential User" ]]
 
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_INTRO_BEGIN]] ==
 +
 +
'''Description:''' <br>
 +
Marks the beginning of the page introduction section.
  
{{ SW_Code | |
 
<daml command&#61;'''"write"'''><br>
 
:
 
<nowiki><!-- Define the Residential Account --></nowiki>
 
: <account>
 
:: <accountName>RESIDENTIAL_DAML</accountName>
 
:: <info>Residential Test Account</info>
 
:: <password>1gRP9vBe</password>
 
:: <username>5umWIuce</username>
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
 
:: <validUntil/>
 
:
 
:: <tenant>DAML_Tenant</tenant>
 
:: <routingTable>Routing_to_PSTN</routingTable>
 
:: <pricelist>Price_DAML_SUBSCRIBER</pricelist>
 
:: <emergencyLocation>Default_Location</emergencyLocation>
 
:
 
:: <sysAccountTopStop>
 
::: <type>SYS</type>
 
::: <monthlyReset>true</monthlyReset>
 
::: <valueMax>50.0</valueMax>
 
::: <alarmLevel>0.7</alarmLevel>
 
::: <alarmEmail>user@home.com</alarmEmail>
 
:: </sysAccountTopStop>
 
::
 
:: <ruleset>Subscriber</ruleset>
 
:: <ruleset>Block 09*</ruleset>
 
: </account>
 
 
<br>
 
<br>
<nowiki><!-- Define Residential Telephone Number --></nowiki>
+
&rarr; This template is not working as expected!!
: <address>
+
: It is in the pages replaced with:
:: <account>RESIDENTIAL_DAML</account>
+
 
:: <number>0987654321</number>
+
<pre>
:: <language>de</language>
+
<!-- Page Overview Start -----------------------------------------------------------------><section begin=intro />
:: <disabled>false</disabled>
+
</pre>
:: <validAfter>2016-01-01 00:00:00</validAfter>
+
 
:: <validUntil/>
 
:: <portoutNumber/>
 
::
 
:: <messageBox>
 
::: <language>de</language>
 
::: <email>user@home.com</email>
 
::: <signalNewMessage>true</signalNewMessage>
 
::: <skipMessageMenu>false</skipMessageMenu>
 
::: <autoAuthentication>false</autoAuthentication>
 
::: <subscribedMwiOnly>true</subscribedMwiOnly>
 
::: <faxOnly>false</faxOnly>
 
::: <faxAutoDetect>false</faxAutoDetect>
 
::: <formatMp3>false</formatMp3>
 
:: </messageBox>
 
::
 
:: <cff>0123456789</cff>
 
::
 
: </address>
 
</daml>
 
}}
 
  
 +
'''Usage:'''<br>
 +
<nowiki>
 +
{{PAGE_INTRO_BEGIN}}
 +
</nowiki>
  
  
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<section begin=intro />
 +
</pre>
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlExampleCreateAccSipTrunk}}
 
== Create a "SIP Trunk" Account with 100 Public Numbers for ISDN PBX behind SIP CPE {{Help_Status | | &nbsp; }} ==
 
  
'''Requirement:'''<br>
 
:* SIP Trunk Account for a customer with an ISDN PBX connected to SIP CPE
 
:* 100 public telephone number block 0555555550 – 99
 
:* The main telephone number is 0555555550, the other telephone numbers are registered via main number
 
:* Account TopStop with 2000.00, warning at 70%, email to info@customer.com
 
:* Block calls toward 09* numbers
 
:* CFF to mobile number 03333333
 
:* Signaling 3 digit 500 – 599 toward the SIP CPE/PBX
 
:* No VoiceMail Boxes
 
  
  
See also: [[ #OperationDamlHowtoScriptSipTrunk | "Download DAML Test Scripts for a SIP Trunk" ]]
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_INTRO_END]] ==
  
 +
'''Description:'''<br>
 +
Marks the end of the  page introduction section.
  
{{ SW_Code | |
 
<daml command&#61;'''"write"'''><br>
 
:
 
<nowiki><!-- Define the SIP Trunk Account --></nowiki>
 
: <account>
 
:: <accountName>SIP_TRUNK_DAML</accountName>
 
:: <info>SIP Trunk Test Account</info>
 
:: <password>1j3RRw3r</password>
 
:: <username>MQa0b3eM</username>
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
 
:: <validUntil/>
 
:
 
:: <tenant>DAML_Tenant</tenant>
 
:: <routingTable>Routing_to_PSTN</routingTable>
 
:: <pricelist>Price_DAML_SUBSCRIBER</pricelist>
 
:: <emergencyLocation>Default_Location</emergencyLocation>
 
:
 
:: <sysAccountTopStop>
 
::: <type>SYS</type>
 
::: <monthlyReset>true</monthlyReset>
 
::: <valueMax>2000.00</valueMax>
 
::: <alarmLevel>0.7</alarmLevel>
 
::: <alarmEmail>info@customer.com</alarmEmail>
 
:: </sysAccountTopStop>
 
:
 
:: <ruleset>Subscriber</ruleset>
 
:: <ruleset>Block 09*</ruleset>
 
:: <ruleset>Signaling: 3 Digit</ruleset>
 
:
 
: </account>
 
 
<br>
 
<br>
<nowiki><!-- Define CFF --></nowiki>
+
&rarr; This template is not working as expected!!
: <callForward>
+
: It is in the pages replaced with:
:: <name>CFF 03333333</name>
+
 
:: <type>CFF</type>
+
<pre>
:: <destReplace>03333333</destReplace>
+
<!-- Page Overview End  -------------------------------------------------------------------><section end=intro />
:: <priority>10</priority>
+
</pre>
: </callForward>
+
 
<br>
+
 
<nowiki><!-- Define SIP Trunk Main Telephone Number --></nowiki>
+
'''Usage:'''<br>
: <address>
+
<pre>
:: <account>SIP_TRUNK_DAML</account>
+
{{PAGE_INTRO_END}}
:: <number>0555555550</number>
+
</pre>
:: <language>de</language>
+
 
:: <disabled>false</disabled>
+
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
+
'''Template-Code:'''<br>
:: <validUntil/>
+
<pre>
:: <portoutNumber/>
+
<section end=intro />
:: <mainNumber>true</mainNumber>
+
</pre>
:: <registersViaMainNumber>false</registersViaMainNumber>
+
 
: </address>
+
 
<br>
+
 
<nowiki><!-- Define the other SIP Trunk Telephone Numbers --></nowiki>
+
 
: <address>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:: <account>SIP_TRUNK_DAML</account>
+
== [[Template:PAGE_INTRO_TRANSCLUDE]] ==
:: <number>0555555551</number>
+
 
:: <language>de</language>
+
'''Description:'''<br>
:: <disabled>false</disabled>
+
Includes in the page introduction section of the defined source page.
:: <validAfter>2016-01-01 00:00:00</validAfter>
+
 
:: <validUntil/>
+
 
:: <portoutNumber/>
+
'''Usage:'''<br>
:
+
<pre>
:: <mainNumber>false</mainNumber>
+
{{PAGE_INTRO_TRANSCLUDE | <PAGE_TITLE> }}
::<registersViaMainNumber>true</registersViaMainNumber>
+
</pre>
: </address>
+
 
:
+
 
: <address>
+
'''Example:'''<br>
:: <account>SIP_TRUNK_DAML</account>
+
<pre>
:: <number>0555555552</number>
+
{{PAGE_INTRO_TRANSCLUDE | {{NAMESPACE}}:user_stimulus_procedures }}
:: <language>de</language>
+
</pre>
:: <disabled>false</disabled>
+
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
+
 
:: <validUntil/>
+
'''Template-Code:'''<br>
:: <portoutNumber/>
+
<pre>
:
+
{{#lst:{{{1}}}|intro }}
:: <mainNumber>false</mainNumber>
+
</pre>
::<registersViaMainNumber>true</registersViaMainNumber>
+
 
: </address>
+
 
:
+
 
<br>
+
 
<nowiki><!-- . . . --></nowiki>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
<br>
+
== [[Template:STIMULUS_SERVICE_TRANSCLUDE]] ==
:
+
 
</daml>
+
'''Description:'''<br>
 +
Includes in the stumulus service section of source page "{{NAMESPACE}}:user_stimulus_procedures".
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{STIMULUS_SERVICE_TRANSCLUDE | <SERVICE> }}
 +
</pre>
 +
 
 +
 
 +
'''Example:'''<br>
 +
<pre>
 +
{{STIMULUS_SERVICE_TRANSCLUDE | Service21 }}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
{{#lst:{{NAMESPACE}}:user_stimulus_procedures | {{{1}}} }}
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Hash Tag & Navigation  =
 +
 
 +
Hash tag (diversions) offers to make links into a page.
 +
In a page divers standardized hash tag points can be defined.
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:ToTop]] ==
 +
 
 +
'''Description:''' <br>
 +
Jump to the page top
 +
 
 +
 
 +
'''Usage:'''<br><
 +
<pre>
 +
{{ToTop}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[#top|<small>&rarr; Top</small>]]
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_FEATURE]] ==
 +
 
 +
'''Description:'''<br>
 +
Hash tag the beginning of the feature description as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_FEATURE}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionFeature"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_CONFIGURATION]] ==
 +
 
 +
'''Description:'''<br>
 +
Hash tag the beginning of the feature configuration as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_CONFIGURATION}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionConfiguration"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_NAVIGATION]] ==
 +
 
 +
'''Description:'''<br>
 +
Hash tag the beginning of the feature navigation description as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_NAVIGATION}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionNavigation"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_ENTITY]] ==
 +
 
 +
'''Description:'''<br>
 +
Hash tag the beginning of the feature entity description as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_ENTITY}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionEntity"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_PARAMETER]] ==
 +
 
 +
'''Description:''' <br>
 +
Hash tag the beginning of the feature parameter description as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<nowiki>
 +
{{PAGE_DIVERSION_PARAMETER}}
 +
</nowiki>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionParameter"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_TROUBLE_SHOOTING]] ==
 +
 
 +
'''Description:'''<br>
 +
Hash tag the beginning of the feature trouble shooting description as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_TROUBLE_SHOOTING}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionTroubleShooting"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_COMMISSIONING]] ==
 +
 
 +
'''Description:'''<br>
 +
Hash tag the beginning of the feature commissioning description as internal page link.
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_COMMISSIONING}}
 +
</pre>
 +
 
 +
 
 +
'''Template-Code:'''<br>
 +
<pre>
 +
<div id="PageDiversionCommissioning"></div>
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
== [[Template:PAGE_DIVERSION_LINK]] ==
 +
 
 +
'''Description:'''<br>
 +
Inserts an interwiki link to a standard (see above) internal page hash tag (section title):
 +
:* Feature
 +
:* Configuration
 +
:* Navigation
 +
:* Entity
 +
:* Parameter
 +
:* Commissioning
 +
:* TroubleShooting
 +
 
 +
 
 +
'''Usage:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_LINK
 +
| link= {{NAMESPACE}}:<PAGE_TITLE>
 +
| div= Feature | Configuration | Navigation | Entity | Parameter | Commissioning | TroubleShooting
 +
| description=blabla
 +
}}
 +
</pre>
 +
 
 +
 
 +
'''Example:'''<br>
 +
<pre>
 +
{{PAGE_DIVERSION_LINK
 +
| link= {{NAMESPACE}}:admincenter_subsc_conference | div= Entity | description=eröffnet im Voraus den Konferenzraum
 
}}
 
}}
 +
</pre>
 +
 +
 +
'''Template-Code:'''<br>
 +
<pre>
 +
[[{{{link}}}#PageDiversion{{{div}}}{{!}}{{{description}}}]]
 +
</pre>
 +
 +
 +
 +
<!-- ========================================================================================================= -->
 +
<!-- ========================================================================================================= -->
 +
  
  
  
 +
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
 +
= Very Special Templates =
  
<!--------------------------------------------------------------------------------------------------------------->
 
{{ToTop | OperationDamlExampleCreateAccVpbx}}
 
== Create a vPBX Account with 5 Public Numbers {{Help_Status | | &nbsp; }} ==
 
  
'''Requirement:'''<br>
+
{{ToTop}} <!----------------------------------------------------------------------------------------------------->
:* Account for vPBX
 
:* 3 public telephone numbers 0123456787 – 89
 
:* vPBX requirement:
 
::* Access for vPBX administrator
 
::* Max. 8 channels
 
::* Max. 10 internal telephone numbers
 
::* Max. 5 App "an IP-Phone"
 
:* Account TopStop with 150.00, warning at 70%, email to info@customer.com
 
:* Block calls toward 09* numbers
 
  
 +
=== [[Template:!]] ===
  
See also: [[ #OperationDamlHowtoScriptvPBX | "Download DAML Test Scripts for a vPBX" ]]
+
'''Description:''' <br>
 +
Sometimes it is needed to replace the mediawiki pipe-ing directive “|” with <nowiki>{{!}}</nowiki> within templates.
  
  
{{ SW_Code | |
+
'''Template-Code:'''<br>
<daml command&#61;'''"write"'''><br>
+
<pre>
<br>
+
|
<nowiki><!-- Define the vPBX --> </nowiki>
+
</pre>
: <group>
+
 
:: <name>VPBX_DAML</name>
+
 
:: <parent>DAML_Tenant</parent>
+
'''Usage:'''<br>
:: <tenant>DAML_Tenant</tenant>
+
<nowiki>
:: <pbx>true</pbx>
+
{{!}}
: </group>
+
</nowiki>
<br>
+
 
<nowiki><!-- Define the vPBX Administrator --></nowiki>
 
: <admin>
 
:: <username>VPBX_DAML_admin</username>
 
:: <language>en</language>
 
:: <password>E4igy5f!</password>
 
:: <tenant>DAML_Tenant</tenant>
 
:: <role>PBX</role>
 
:: <pbx>VPBX_DAML</pbx>
 
: </admin>
 
<br>
 
<nowiki><!-- Define the vPBX Attributes --></nowiki>
 
: <groupAttribute>
 
:: <group>VPBX_DAML</group>
 
:: <name>maxPrivateAddr</name>
 
:: <value>10</value>
 
: </groupAttribute>
 
:
 
: <groupAttribute>
 
:: <group>VPBX_DAML</group>
 
:: <name>maxDevAnIpPhone</name>
 
:: <value>5</value>
 
: </groupAttribute>
 
:
 
: <groupAttribute>
 
:: <group>VPBX_DAML</group>
 
:: <name>channels</name>
 
:: <value>8</value>
 
: </groupAttribute>
 
<br>
 
<nowiki><!-- Define the vPBX Account --></nowiki>
 
: <account>
 
:: <accountName>VPBX_DAML</accountName>
 
:: <info>vPBX Test Account </info>
 
:: <password>a27fKuwer</password>
 
:: <username>4wku4sPE8r</username>
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
 
:: <validUntil/>
 
:
 
:: <tenant>DAML_Tenant</tenant>
 
:: <routingTable>Routing_to_PSTN</routingTable>
 
:: <pricelist>Price_DAML_Tenant</pricelist>
 
:: <emergencyLocation>Default_Location</emergencyLocation>
 
:
 
:: <sysAccountTopStop>
 
::: <type>SYS</type>
 
::: <monthlyReset>true</monthlyReset>
 
::: <valueMax>150.00</valueMax>
 
::: <alarmLevel>0.7</alarmLevel>
 
::: <alarmEmail>info@customer.com</alarmEmail>
 
:: </sysAccountTopStop>
 
:
 
:: <ruleset>Subscriber</ruleset>
 
:: <ruleset>Block 09*</ruleset>
 
: </account>
 
<br>
 
<nowiki><!-- Define the vPBX Public Telephone Numbers --></nowiki>
 
: <address>
 
:: <number>0123456787</number>
 
:: <account>VPBX_DAML</account>
 
:: <language>en</language>
 
:: <disabled>false</disabled>
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
 
:: <validUntil/>
 
:: <portoutNumber/>
 
:
 
:: <pbx>VPBX_DAML</pbx>
 
:: <presenceGroup>VPBX_DAML</presenceGroup>
 
:: <monitorGroup>VPBX_DAML</monitorGroup>
 
:: <messageGroup>VPBX_DAML</messageGroup>
 
:: <groupMember>VPBX_DAML</groupMember>
 
:: <groupMember>DAML_Tenant</groupMember>
 
: </address>
 
:
 
: <address>
 
:: <number>0123456788</number>
 
:: <account>VPBX_DAML</account>
 
:: <language>en</language>
 
:: <disabled>false</disabled>
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
 
:: <validUntil/>
 
:: <portoutNumber/>
 
:
 
:: <pbx>VPBX_DAML</pbx>
 
:: <presenceGroup>VPBX_DAML</presenceGroup>
 
:: <monitorGroup>VPBX_DAML</monitorGroup>
 
:: <messageGroup>VPBX_DAML</messageGroup>
 
:: <groupMember>VPBX_DAML</groupMember>
 
:: <groupMember>DAML_Tenant</groupMember>
 
: </address>
 
:
 
: <address>
 
:: <number>0123456789</number>
 
:: <account>VPBX_DAML</account>
 
:: <language>en</language>
 
:: <disabled>false</disabled>
 
:: <validAfter>2016-01-01 00:00:00</validAfter>
 
:: <validUntil/>
 
:: <portoutNumber/>
 
:
 
:: <pbx>VPBX_DAML</pbx>
 
:: <presenceGroup>VPBX_DAML</presenceGroup>
 
:: <monitorGroup>VPBX_DAML</monitorGroup>
 
:: <messageGroup>VPBX_DAML</messageGroup>
 
:: <groupMember>VPBX_DAML</groupMember>
 
:: <groupMember>DAML_Tenant</groupMember>
 
: </address>
 
:
 
</daml>
 
}}
 
  
  
<section end=page_section />
 
<!--------------------------------------------------------------------------------------------------------------->
 
 
{{ToTop}}
 
{{ToTop}}
<!-- {{PAGE_SECTION_END}} -->
+
<!-- {{PAGE_SECTION_END}} ----------------------------------------------------------------><section end=page />
 
{{PAGE_FOOTER}}
 
{{PAGE_FOOTER}}
 
{{Page_Version |version=3.0 |author=Aarenet |date=May 2017}}
 
{{Page_Version |version=3.0 |author=Aarenet |date=May 2017}}

Revision as of 16:22, 9 June 2017

Template:Page Help Links



Here the Aarenet personnel find all MediaWiki Markup templates for the Aarenet Online Help.

Productive pages:

Page URL: http://help.aarenet.com/wiki/Template:Template_list


Test page:

Page URL: http://test-help.aarenet.com/wiki/Template:Template_list

Marking of differences between the productive to the test version: TEMPLATE-DIFFERENCE


Contents



→ Top

Template Description ;-)


→ Top

Template:TEMPLATE_TEMPLATE

Description:
blabla


Usage:

{{TEMPLATE_TEMPLATE | <NUMBER> | <DESCRIPTION> }}


Example:

{{TEMPLATE_TEMPLATE | 1 | "Teilnehmer xx" }}


Result:

bla Register "Teilnehmer xx"


Template-Code:

{{#switch: {{{1}}}
| 1 = : bla {{{2}}}
| 2 = :: bla {{{2}}}
| #default = bla default
}}





→ Top

Aarenet Wiki


→ Top

Template:An_Wiki_Fqdn_Ip

Description:
Identifies the productive Aarenet Wiki FQDN or IP address:

FQDN: http://help.aarenet.com


Usage:

{{An_Wiki_Fqdn_Ip}}


Result:
help.aarenet.com


Template-Code:

help.aarenet.com




→ Top

Template:An_Wiki_Fqdn_Ip_Test

Description:
Identifies the productive Aarenet Wiki FQDN or IP address:

IP: test-help.aarenet.com


Usage:

{{An_Wiki_Fqdn_Ip_Test}}


Result:
test-help.aarenet.com


Template-Code:

test-help.aarenet.com




→ Top

Template:An_Wiki_Site

Description:
Identifies the productive or test AN Wiki site due to {{An_Wiki_Fqdn_Ip_Test}}:

"test-help.aarenet.com"

If yes the result will be:

  • test_wiki

else

  • productive_wiki


This site page has the follwoing URL:

http://help.aarenet.com/wiki/Operation_daml


Usage:

{{#ifeq: {{An_Wiki_Site}} | productive_wiki
| "then do this on productive wiki site"
| "else do that on test wiki site"
}}


Example:

{{An_Wiki_Site}}


Result:
productive_wiki
"then do this on productive wiki site"


Template-Code:

{{#if: {{#pos:{{fullurl:{{PAGENAMEE}}}}|{{An_Wiki_Fqdn_Ip_Test}}|0}} | test_wiki | productive_wiki }}




→ Top

Text Blocks


→ Top

Divers Text Components


→ Top

Template:Help_Status

Documentation status information.
Types of status:

  • comingsoon
  • inwork
  • draft
  • new
  • updated
  • deprecated


Usage:

{{Help_Status | Feature Descritpion | comingsoon }}


Example:

{{Help_Status | Feature Descritpion | comingsoon }}
{{Help_Status | Feature Descritpion | inwork}}
{{Help_Status | Feature Descritpion | draft }}
{{Help_Status | Feature Descritpion | new}}
{{Help_Status | Feature Descritpion | updated }}
{{Help_Status | Feature Descritpion | deprecated }}

For hide a status at a certain position:<br>
{{Help_Status | Feature Descritpion | & nbsp; }} ->   : 'space' used as place holder

Status in text:
This description will soon be ready {{Help_Status | inwork}}!

Status in title:
==== {{Help_Status | Feature Title with Status Variant 1 | Preliminary }} ====
or
==== Feature Title with Status Variant 2 {{Help_Status |   | Preliminary }} ====


Result:
 
 
 
 
 
 
 

 

or

Feature Title with Status Variant 2  



Template-Code:

{{#ifeq: {{An_Wiki_Site}} | productive_wiki
|  
| {{#switch: {{{2}}}
   | ComingSoon
   | comingsoon =  {{{1}}} '''''<small> <FONT COLOR=#9c9472>  → Coming Soon</FONT></small>'''''
   | InWork
   | inwork =      {{{1}}} '''''<small> <FONT COLOR=#9c9472>  → In Work</FONT></small>'''''
   | Preliminary
   | draft =       {{{1}}} '''''<small> <FONT COLOR=#0061a0>  → Draft</FONT></small>'''''
   | New
   | new =         {{{1}}} '''''<small> <FONT COLOR=#3a817d>  → New</FONT></small>'''''
   | Updated
   | updated =     {{{1}}} '''''<small> <FONT COLOR=#3a817d>  → Updated</FONT></small>'''''
   | deprecated =  {{{1}}} '''''<small> <FONT COLOR=#b8597c>  → Deprecated</FONT></small>'''''
   | #default =    {{{1}}}
  }}
}}




→ Top

Template:File_Download_Link

Description:
This allows to introduce a file download link with icon for the file type.
The following icons are available:

  • pdf
  • zip
  • xml
  • img
  • default


Note

Primarily the file has to be uploaded to the mediawiki!



Usage:

{{ File_Download_Link
| <FILE_NAME>
| <FILE_ICON (pdf | zip | xml | img | default )>
| <DESCRIPTION> }}


Example:

{{ File_Download_Link | manual_voip-switch_filial_subscriber_admincenter_d21.pdf | pdf | "Das web-basierte AdminCenter für den Teilnehmer" }}


Result:
"Das web-basierte AdminCenter für den Teilnehmer" PDF


Template-Code:

[[Media:{{{1}}} | {{{3}}} ]] {{#switch: {{{2}}}
| pdf = {{Picture_Pdf}}
| zip = {{Picture_Zip}}
| xml = {{Picture_Xml}}
| img = {{Picture_Img}}
| #default = {{Picture_File}}
}}





→ Top

Notes & Warning Text Box


→ Top

Template:Note

Description:
Highlighted text notes of diffrenet types.¨
Types of notes:

  • note (default)
  • warning
  • bestpractice
  • version


→ Possible but not recommended for notes: use "hangleft" for hang in from the left side


Usage:

{{Note| Place here the note text }}
{{Note| type=warning | Place here the note text }}
{{Note| type=bestpractice |
'''Checking "Support Log"'''<br>
Place here the best practice text
}}
{{Note| type=version | Place here the version text }}


Example:

{{Note| Dial on your telephone *99 or go to the AdminCenter ... }}
{{Note| type=warning | Place here the warning text }}
{{Note| type=warning | hangleft=50 | Place here the hanging warning text }}
{{Note| type=version | Place here the version text }}


Result:

Note Dial on your telephone *99 or go to the AdminCenter ...



Warning Place here the warning text



Best Practice

Checking "Support Log"
Place here the best practice text



With hang in from left:

  Warning Place here the hanging warning text



Version Note:

AdminCenter Version V5.7



Template-Code:

{{{!}} {{Table_Cell_General}}
{{!}}- valign="middle"

{{#if: {{{hangleft|}}} |
   {{!}} width={{{hangleft}}} {{!}}
}}

{{#switch: {{{type}}}
| warning =
{{!}} width=100 bgcolor={{MANGENTA_70}} {{!}}   {{#switch: {{NAMESPACE}}
                                                | De       = '''Warnung:'''
                                                | #default = '''Warning:'''
                                                }}
{{!}} width=500 bgcolor={{GREY_LIGHT}}  {{!}}   {{{1}}}

| bestpractice =
{{!}} width=100 bgcolor={{BLUE_40}}     {{!}}   {{#switch: {{NAMESPACE}}
                                                | De       = '''Beste Anwendung:'''
                                                | #default = '''Best Practice:'''
                                                }}
{{!}} width=500 bgcolor={{GREY_LIGHT}}  {{!}}   {{{1}}}

| version =
{{!}} bgcolor={{GREY_LIGHT}}            {{!}}   {{{1}}}

| #default =
{{!}} width=100 bgcolor={{BEIGE_70}}    {{!}}  {{#switch: {{NAMESPACE}}
                                               | De       = '''Hinweis:'''
                                               | #default = '''Note:'''
                                               }}
{{!}} width=500 bgcolor={{GREY_LIGHT}}  {{!}}  {{{1}}}
}}
{{!}}}
<br style="clear:both">





→ Top

Code & Shell Text Box


→ Top

Template:Shell_Command

Description:
Display shell command lines:

  • use "prompt" for displaying a line number and a specific shell prompt.
  • use "hangleft" for hang in from the left side
  • Text aligns on centered


Usage:

{{Shell_Command | prompt# | command 1 }}


Example:

{{Shell_Command | prompt# | command 1 }}
{{Shell_Command | prompt# | command 2 }}
{{Shell_Command | root#   | command 3 }}
{{Shell_Command | | command 4 }}
<br style="clear:both">

With hang in from left:
{{Shell_Command | hangleft=50 | root# | command 5 }}
<br style="clear:both">


Result:

prompt# command 1
prompt# command 2
root# command 3
command 4


With hang in from left:

  root# command 5



Template-Code:

{{{!}} {{Table_Cell_General}}

{{#if: {{{hangleft|}}} |
   {{!}} width={{{hangleft}}} {{!}}  
}}

{{!}} width=100  bgcolor={{GREEN_40}}   align="right" {{!}} {{#if: {{{1|}}} | <tt>{{{1}}}</tt> }}
{{!}} width=900  bgcolor={{GREY_LIGHT}}               {{!}} <tt>{{{2}}}</tt>
{{!}}}




→ Top

Template:SW_Code

Description:
Display SW code or script command lines:

  • use "ln" for displaying a line number.
  • use "hangleft" for hang in from the left side
  • Text aligns on top


Usage:

{{SW_Code | <LINE> | code line 1 }}


Example:
Variante 1:

{{ SW_Code | 01 | code line 1 }}
{{ SW_Code | 02 | code line 2 }}
{{ SW_Code | 03 | code line 3 }}
<br style="clear:both">

Variante 2:

{{ SW_Code |
| 04<br>05<br>06 |
code line 4<br>
code line 5<br>
code line 6
}}
<br style="clear:both">

Variante 3:

{{ SW_Code |
code line 7<br>
code line 8<br>
code line 9
}}
<br style="clear:both">

With hang in from left:

{{ SW_Code | hangleft=50 | 10 | code line 10 }}
<br style="clear:both">


Result:
Variante 1:

01 code line 1


02 code line 2


03 code line 3



Variante 2:

04
05
06

code line 4
code line 5
code line 6



Variante 3:

code line 7
code line 8
code line 9

{{{2}}}



With hang in from left:

  10 code line 10




Template-Code:

{{{!}} {{Table_Cell_General}}

{{#if: {{{hangleft|}}} |
   {{!}} width={{{hangleft}}} {{!}}  
}}

{{!}} width=100  bgcolor={{GREEN_40}}   align="right" {{!}} {{#if: {{{1|}}} | <tt>{{{1}}}</tt> }}
{{!}} width=900  bgcolor={{GREY_LIGHT}}               {{!}} <tt>{{{2}}}</tt>
{{!}}}




→ Top

Template:Star_Procedure

Description:
Table for *# Procedure description. The headers are set according the language.


Usage:

{{Star_Procedure
|link= Diversion for a internal page link reference
|service_nmb= Service number
|description= Kurzbeschreibung des Service
|line= Anzahl Zielen mit Aktivitäten
|activity1= Aktivität |code1= *#-Code  | remark1= Bemerkung
|activity2= Aktivität |code2= *#-Code  | remark2= Bemerkung
|activity3= Aktivität |code3= *#-Code  | remark3= Bemerkung
|activity4= Aktivität |code4= *#-Code  | remark4= Bemerkung
|version= Aarenet VoIP Switch V3.0
}}


Example:

{{Star_Procedure
|link= Service21
|service_nmb= 21 & 28
|description= Unbedingte Umleitung (CFU)
|lines= 4
|activity1= Aktivierung                         |code1= *21(*)<UMLEITUNG>(#) | remark1= <UMLEITUNG> ist die Telefonnummer, auf welche umgeleitet wird.
|activity2= Anrufumleitung zum Anrufbeantworter |code2= *28(#)               | remark2=
|activity3= Deaktivierung                       |code3= #28(#)               | remark3=
|activity4= Statusabfrage                       |code4= *#28(#)              | remark4=
|version= Aarenet VoIP Switch V3.0
}}


Result:

Service 21 & 28 Unbedingte Umleitung (CFU): *#-Code: Remark:
Aktivierung: *21(*)<UMLEITUNG>(#) <UMLEITUNG> ist die Telefonnummer, auf welche umgeleitet wird.
Anrufumleitung zum Anrufbeantworter: *28(#)
Deaktivierung: #28(#)
Statusabfrage: *#28(#)



Template-Code:

{{#if: {{{link|}}} | <div id="{{{link}}}"></div> }}
{{{!}} {{Table_Cell_General}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}
{{!}} width=325 {{!}}  {{#switch: {{NAMESPACE}}
                       | DE =       <font color=#ffffff>'''Service: {{{service_nmb}}}: {{{description}}}'''</font>
                       | #default = <font color=#ffffff>'''Service: {{{service_nmb}}}: {{{description}}}'''</font>
                       }}
{{!}} width=175 {{!}}  {{#switch: {{NAMESPACE}}
                       | DE =       <font color=#ffffff>'''<tt>*#</tt>-Code:'''</font>
                       | #default = <font color=#ffffff>'''<tt>*#</tt>-Code:'''</font>
                       }}
{{!}} width=500 {{!}}  {{#switch: {{NAMESPACE}}
                       | DE =       <font color=#ffffff>'''Bemerkung:'''</font>
                       | #default = <font color=#ffffff>'''Remark:'''</font>
                       }}

{{#switch: {{{lines}}}
| 1 =
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
{{!}} {{{activity1}}}:
{{!}} {{{code1}}}
{{!}} {{{remark1}}}

| 2 =
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
{{!}} {{{activity1}}}:
{{!}} {{{code1}}}
{{!}} {{{remark1}}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Darkened}}
{{!}} {{{activity2}}}:
{{!}} {{{code2}}}
{{!}} {{{remark2}}}

| 3 =
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
{{!}} {{{activity1}}}:
{{!}} {{{code1}}}
{{!}} {{{remark1}}}

{{!}}- valign="top" bgcolor{{Table_Cell_Bgcolor_Darkened}}
{{!}} {{{activity2}}}:
{{!}} {{{code2}}}
{{!}} {{{remark2}}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
{{!}} {{{activity3}}}:
{{!}} {{{code3}}}
{{!}} {{{remark3}}}

| #default =
{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
{{!}} {{{activity1}}}:
{{!}} {{{code1}}}
{{!}} {{{remark1}}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Darkened}}
{{!}} {{{activity2}}}:
{{!}} {{{code2}}}
{{!}} {{{remark2}}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Light}}
{{!}} {{{activity3}}}:
{{!}} {{{code3}}}
{{!}} {{{remark3}}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Darkened}}
{{!}} {{{activity4}}}:
{{!}} {{{code4}}}
{{!}} {{{remark4}}}
}}

{{!}}}
<br style="clear:both">




→ Top

Template:FAQ

Description:
Table for FAQ question/response. The headers are set according the language.


Usage:

{{FAQ
|question= Place here the question
|response= Place here the response
}}

Example:

{{FAQ
|question= How do I reject anonymous calls?
|response= Dial on your telephone *99 or go to the AdminCenter ...
}}


Result:

FAQ: How do I reject anonymous calls?

Response: Dial on your telephone *99 or go to the AdminCenter ...



Template-Code:

=== FAQ: {{{question}}} ===

{{{!}} {{Table_Cell_General}}

{{!}}- valign="top" bgcolor={{BLUE_15}}
{{!}} width=100 bgcolor={{BLUE_100}} {{!}}  {{#switch: {{NAMESPACE}}
                                            | DE =       <font color=#ffffff>'''Antwort:'''</font>
                                            | #default = <font color=#ffffff>'''Response:'''</font>
                                            }}
{{!}} width=900 {{!}} {{{response}}}

{{!}}}
<br style="clear:both">




→ Top

Feature Description in Web GUI

Here templates for feature descrition in the Web GUI (e.g. AdminCenter, ConfigCenter) are available.



→ Top

Template:Navigation_List

Description:
Is used for creating menu navigation descriptions


Usage:

{{Navigation_List | <LEVEL 1 | 2 | 3 | 4 | 5 | 6 | 7> | <DESCRIPTION> }}


Example:

{{Navigation_List | 1 | Register "Teilnehmer xx" }}
{{Navigation_List | 2 | Register "Umleitungen" }}
{{Navigation_List | 3 | Level 3 }}
{{Navigation_List | 4 | Level 4 }}
{{Navigation_List | 5 | Level 5 }}
{{Navigation_List | 6 | Level 6 }}
{{Navigation_List | 7 | Level 7 }}
{{Navigation_List | 8 | Not defined level 8 remains on level 7}}


Result:

nav Register "Teilnehmer xx"
nav Register "Umleitungen"
nav Level 3
nav Level 4
nav Level 5
nav Level 6
nav Level 7
nav Not defined level 8 remains on level 7


Template-Code:
{{#switch: {{{1}}}
| 1 = : [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
| 2 = :: [[File:admincenter_icon_navigation.gif|link=|14px|nav]]  {{{2}}}
| 3 = ::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
| 4 = :::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
| 5 = ::::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
| 6 = :::::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
| #default = ::::::: [[File:admincenter_icon_navigation.gif|link=|14px|nav]] {{{2}}}
}}




→ Top

Template:Parameter_Configuration

Description:
Table for parameter configuration description. The headers are set according the language.


Usage:

{{Parameter_Configuration
|link= Diversion for a internal page link reference
|name= Parameter name
|description= Description of the parameter
|range= Describes the possible settings
|default= Describes the default value
|version= Describes possible AS version dependencies, by default the first apperance of this parameter
}}


Example:

{{Parameter_Configuration
|link= VoiceMailNumber
|name= '''Example:''' Number of VoiceBox
|description=
Anzeige der Rufnummer, mit welcher der Anrufbeantworter innerhalb der vPBX direkt angerufen werden kann
|range= Selektion : Yes {{!}} No
|default= Yes
|version= Aarenet VoIP Switch V.57
}}


Result:


→ Top

Parameter: Example: Number of VoiceBox

Description: Anzeige der Rufnummer, mit welcher der Anrufbeantworter innerhalb der vPBX direkt angerufen werden kann
Configuration: No
Default: Yes
Version: Aarenet VoIP Switch V.57



Template-Code:

{{#if: {{{link|}}} | <div id="{{{link}}}"></div> }}
=== Parameter: "{{{name}}}" ===
{{{!}} {{Table_Cell_General}}

{{!}}- align="left" valign="top"
{{!}} width=100  bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
{{#switch: {{NAMESPACE}}
| De = '''Beschreibung:'''
| #default = '''Description:''' }} </font>
{{!}} width=900 bgcolor={{Table_Cell_Bgcolor_Darkened}} {{!}} {{{description}}}

{{!}}- align="left" valign="top"
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
{{#switch: {{NAMESPACE}}
| De = '''Konfiguration:'''
| #default = '''Configuration:''' }} </font>
{{!}} bgcolor={{Table_Cell_Bgcolor_Light}} {{!}} {{{range}}}

{{!}}- align="left" valign="top"
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
{{#switch: {{NAMESPACE}}
| De = '''Grundwert:'''
| #default = '''Default:''' }} </font>
{{!}} bgcolor={{Table_Cell_Bgcolor_Darkened}} {{!}} {{{default}}}

{{!}}- align="left" valign="top"
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>
{{#switch: {{NAMESPACE}}
| De = '''Version:'''
| #default = '''Version:''' }} </font>
{{!}} bgcolor={{Table_Cell_Bgcolor_Light}} {{!}} {{{version}}}

{{!}}}
<br style="clear:both">




→ Top

Web GUI Parameter Description


→ Top

Template:Dialog_Button

Description:
Is used for creating a "Dialog Button" within a parameter description.


Usage:

{{Dialog_Button | <DESCRIPTION_BUTTON>}}


Example:

Please press {{Dialog_Button | Create … }} for ...


Result:
Please press Button [ Create … ] for ...


Template-Code:

{{#switch: {{NAMESPACE}}
| De = Schaltfläche:
| #default = Button:
}}
<span style="background:#eaeaea">[ {{{1}}} ]</span>




→ Top

Template:Configuration_String

Description:
Is used for creating any type of "Configuration String" within the parameter description.


Usage:

{{Configuration_String | <DESCRIPTION_STRING> }}


Example:

{{Configuration_String      | Password String }}
{{Configuration_String_Item | minimun 8 character }}


Result:
Configuration String:

  • Password String
  • minimun 8 character


Template-Code:

{{#switch: {{NAMESPACE}}
| De = Konfigurationstext:
| #default = Configuration String:
}}
:* {{{1}}}




→ Top

Template: Configuration_String_Item

Description:
Is used for adding a new line to the "Configuration String"


Usage:

{{Configuration_String_Item | <DESCRIPTION_STRING> }}


Example:

{{Configuration_String      | Password String }}
{{Configuration_String_Item | minimun 8 character }}


Result:
Configuration String:

  • Password String
  • minimun 8 character


Template-Code:

:* {{{1}}}




→ Top

Template:Selection_Menu

Description:
Is used for creating drop down "Selection Menu" within the parameter description with the first selection item.


Usage:

{{Selection_Menu | <DESCRIPTION_MENU_ITEM> }}


Example:

{{Selection_Menu      | de : Deutsch }}
{{Selection_Menu_Item | en : English }}
<br>
{{Selection_Menu | List of all available languages }}


Result:
Selection Menu:

de : Deutsch
en : English


Template-Code:

{{#switch: {{NAMESPACE}}
| De = Selektionsmenu:
| #default = Selection Menu:
}}
:: <span style="background:#eaeaea">{{{1}}}</span>




→ Top

Template:Selection_Menu_Item

Description:
Is used for adding selection item to a "Selection Menu".


Usage:

{{Selection_Menu_Item | <DESCRIPTION_MENU_ITEM> }}


Example:

{{Selection_Menu      | de : Deutsch }}
{{Selection_Menu_Item | en : English }}


Result:
Selection Menu:

de : Deutsch
en : English


Template-Code:

:: <span style="background:#eaeaea">{{{1}}}</span>




→ Top

Template:Selection_Box

Description:
Is used for creating "Selection Box" within the parameter description.


Usage:

{{Selection_Box}}


Example:

{{Selection_Box}}


Result:
Selection Button: box on Activated - box off Not activated


Template-Code:

{{#switch: {{NAMESPACE}}
| De =
Selektionsknopf: [[File:admincenter_icon_selection_box_on.gif|link=|14px|box on]] Aktiviert; [[File:admincenter_icon_selection_box_off.gif|link=|14px|box off]] Nicht aktiviert

| #default =
Selection Button: [[File: admincenter_icon_selection_box_on.gif|link=|14px|box on]] Activated; [[File:admincenter_icon_selection_box_off.gif|link=|14px|box off]] Not activated
}}




→ Top

Template:IP_Address

Description:
Is used for creating an "IP Address" within a parameter description.


Usage:

{{IP_Address | type=<mask | <cidr> | <VALUE_IP> | <VALUE_SUBNET>}}


Example:

{{IP_Address | type=mask | 10.10.10.10 | 255.255.255.0}}
{{IP_Address | type=cidr | 10.10.10.10 | 24}}


Result:
IP address in dotted decimal notation with subnet mask:    10.10.10.10 Mask 255.255.255.0
IP address in dotted decimal notation in CIDR style:    10.10.10.10 / 24


Template-Code:

{{#switch: {{{type}}}
| cidr =
    {{#switch: {{NAMESPACE}}
    | De =
    IP Adresse durch Punkte getrenne Dezimaldarstellung im CDIR Stil:   {{{1}}}/{{{2}}}
    | #default =
    IP address in dotted decimal notation in CDIR style:   {{{1}}}/{{{2}}}
    }}

| #default =
    {{#switch: {{NAMESPACE}}
    | De =
    IP Adresse durch Punkte getrenne Dezimaldarstellung mit Subnetzmaske:   {{{1}}}   Subnetzmaske {{{2}}}
    | #default =
    IP address in dotted decimal notation with subnet mask:   {{{1}}}   Mask {{{2}}}
    }}
}}





→ Top

Tables

The table templates allow to create standard tables with a maximum of 5 columns.




→ Top

Table Definitions


→ Top

Template:Table_Start

Description:
Starts a table. There is the possibility to add a hash tag.


Usage:

{{Table_Start | link=<TABLE_HASHTAG>}}
{{Table_Start}}


Usage:

{{Table_Start | link=<TABLE_HASHTAG>}}


Template-Code:

{{#if: {{{link|}}} | <div id="{{{link}}}"></div> }}
{{{!}} {{Table_Cell_General}}




→ Top

Template:Table_End

Description:
Closes a standard table.


Usage:

{{Table_End}}


Template-Code:

{{!}}}
<br style="clear:both">




→ Top

Template:Table_Cell_General

Description:
Defines the basic table look.


Usage:

{{Table_Cell_General}}


Template-Code:

align="left" cellspacing="1" cellpadding="2" bgcolor={{WHITE}}




→ Top

Template:Table_Cell_Bgcolor_Header

Description:
Normalized background color table header cell.


Usage:

{{Table_Cell_Bgcolor_Header}}


Result:

Title 1



Template-Code:

{{BLUE_100}}




→ Top

Template:Table_Cell_Bgcolor_Darkened

Description:
Normalized background color table for a darkened cell.


Usage:

{{Table_Cell_Bgcolor_Darkened}}


Result:

Cell 1



Template-Code:

{{BLUE_40}}




→ Top

Template:Table_Cell_Bgcolor_Light

Description:
Normalized background color table for a light cell.


Usage:

{{Table_Cell_Bgcolor_Light}}


Result:

Cell 1



Template-Code:

{{BLUE_15}}




→ Top

Template:Table_Header

Description:
Standart Table Header line with max 5 columns

  • use "hangleft" for hang in from the left side


Usage:

{{Table_Start}}
{{Table_Header | columns=2
| width1=200 | width2=500
| header1= Title 1 | header2= Title 2
}}
{{Table_End}}
{{Table_Start | link=myTestTable}}
{{Table_Header | columns=5
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
}}
{{Table_End}}


Result:

Title 1 Title 2


Title 1 Title 2 Title 3 Title 4 Title 5


With hang in from left:

  Title 1 Title 2



Template-Code:


Variante 1: Doesn't work correctly

{{{!}} {{Table_Cell_General}}

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{#if: {{{header1|}}}  | {{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font> }}
{{#if: {{{header2|}}}  | {{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font> }}
{{#if: {{{header3|}}}  | {{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font> }}
{{#if: {{{header4|}}}  | {{!}} width={{{width4}}} {{!}} <font color=#ffffff>'''{{{header4}}}'''</font> }}
{{#if: {{{header5|}}}  | {{!}} width={{{width5}}} {{!}} <font color=#ffffff>'''{{{header5}}}'''</font> }}


Variante 2: Works


{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{#switch: {{{columns}}}

| 1 =
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>

| 2 =
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>

| 3 =
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
{{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>

| 4 =
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
{{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
{{!}} width={{{width4}}} {{!}} <font color=#ffffff>'''{{{header4}}}'''</font>

| #default =
{{!}} width={{{width1}}} {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
{{!}} width={{{width3}}} {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
{{!}} width={{{width4}}} {{!}} <font color=#ffffff>'''{{{header4}}}'''</font>
{{!}} width={{{width5}}} {{!}} <font color=#ffffff>'''{{{header5}}}'''</font>

}}





→ Top

Template:Table_Header_Col1

Description:
Table Header in the first coloumn with max 5 columns

  • use "hangleft" for hang in from the left side


Usage:

{{Table_Start}}
{{Table_Header_Col1 | columns=2 | line=1 | width1=200 | width2=500
| header1= Title 1 | col2= Cell 2
}}
{{Table_End}}
{{Table_Start}}
{{Table_Header_Col1 | columns=5 | line=2 | width1=200 | width2=200 | width3=150 | width4=150 | width5=150
| bgcell3={{GREEN_70}}
| header1= Title 1 | col2= Cell 2 | col3= Cell 3 | col4= Cell 4 | col5= Cell 5
}}
{{Table_End}}


Result:

Title 1 Cell 2



Title 1 Cell 2 Cell 3 Cell 4 Cell 5



Template-Code:

{{Table_Cell_General}}

{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{#switch: {{{columns}}}

| 1 =
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>


| 2 =
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}


| 3 =
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
{{!}} width={{{width3}}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} }} {{!}}                        {{{col3}}}


| 4 =
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
{{!}} width={{{width3}}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} }} {{!}}                        {{{col3}}}
{{!}} width={{{width4}}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} }} {{!}}                        {{{col4}}}


| #default =
{{!}} width={{{width1}}} bgcolor={{Table_Cell_Bgcolor_Header}}            {{!}}    <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width={{{width2}}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} }} {{!}}                        {{{col2}}}
{{!}} width={{{width3}}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} }} {{!}}                        {{{col3}}}
{{!}} width={{{width4}}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} }} {{!}}                        {{{col4}}}
{{!}} width={{{width5}}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} }} {{!}}                        {{{col5}}}

}}




→ Top

Template:Table_Line

Description:
Table line with max 5 columns with:

  • Even line number generates a darker background color where an uneven number generates a light color
  • use "hangleft" for hang in from the left side
  • "column1=header" generates an dark title cell on the left side


Usage:

Example 1:
{{Table_Start}}
{{Table_Header | columns=5
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
}}
}}
{{Table_Line | line=1
| col1= Cell 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
}}
{{Table_Line | line=2
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
}}
{{Table_End}}


Example 2: Column 1 is header
{{Table_Start}}
{{Table_Header | columns=5
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5
}}
}}
{{Table_Line | column1=header | line=1
| col1= Header 11 | col2= Cell 12 | col3= Cell 13 | col4= Cell 14 | col5= Cell 15
}}
{{Table_Line | column1=header | line=2
| col1= Header 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
}}
{{Table_End}}


Example 3: Cell with special background color
{{Table_Start}}
{{Table_Header | columns=5
| width1=200 | width2=200 | width3=150 | width4=150 | width5=150
| header1= Title 11 | header2= Title 12 | header3= Title 13 | header4= Title 14 | header5= Title 15
}}
}}
{{Table_Line |line=1 | bgcell3={{GREEN_70}}
| col1= Cell 1 | col2= Cell 2 | col3= Cell 3 | col4= Cell 4 | col5= Cell 5
}}
{{Table_Line | line=2 | bgcell4={{MANGENTA_40}}
| col1= Cell 21 | col2= Cell 22 | col3= Cell 23 | col4= Cell 24 | col5= Cell 25
}}
{{Table_End}}


With hang in from left:
{{Table_Start}}
{{Table_Header | hangleft=50
| width1=50 | width2=100 | columns=2
| header1= Title 1 | header2= Title 2
}}
{{Table_Line | line=1 | bgcell1={{GREEN_70}}
| col1= Cell 11 | col2= Cell 12
}}
{{Table_Line | line=2 | bgcell2={{MANGENTA_40}}
| col1= Cell 21 | col2= Cell 22
}}
{{Table_End}}



Result:

Example 1:

Title 1 Title 2 Title 3 Title 4 Title 5
Cell 11 Cell 12 Cell 13 Cell 14 Cell 15
Cell 21 Cell 22 Cell 23 Cell 24 Cell 25



Example 2: Column 1 is header

Title 1 Title 2 Title 3 Title 4 Title 5
Header 11 Cell 12 Cell 13 Cell 14 Cell 15
Header 21 Cell 22 Cell 23 Cell 24 Cell 25



Example 3: Cell with special background color

Title 1 Title 2 Title 3 Title 4 Title 5
Cell 11 Cell 12 Cell 13 Cell 14 Cell 15
Cell 21 Cell 22 Cell 23 Cell 24 Cell 25



Example 4:

Title 1 Title 2 Title 3
Cell 11 Cell 12 Cell 13
Cell 21 Cell 22 Cell 23



With hang in from left:

  Title 1 Title 2
  Cell 11 Cell 12
  Cell 21 Cell 22




Template-Code:


Variant 1: Doesn't work correctly

{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{#if: {{{col1|}}} |
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}
}}

{{#if: {{{col2|}}} |
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
}}

{{#if: {{{col3|}}} |
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
}}

{{#if: {{{col4|}}} |
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
}}

{{#if: {{{col5|}}} |
{{!}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} {{!}} }}                        {{{col5}}}
}}


Variant 2: Doesn't work correctly

{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{#switch: {{{columns}}}
| 1
| 2
| 3
| 4
| 5 =
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}
}}

{{#switch: {{{columns}}}
| 2
| 3
| 4
| 5 =
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
}}

{{#switch: {{{columns}}}
| 3
| 4
| 5 =
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
}}

{{#switch: {{{columns}}}
| 4
| 5 =
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
}}

{{#switch: {{{columns}}}
| 5 =
{{!}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} {{!}} }}                        {{{col5}}}
}}





Variant 3: works

{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{#switch: {{{columns}}}

| 1 =
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}


| 2 =
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}


| 3 =
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}


| 4 =
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}


| #default =
{{#switch: {{{column1}}}
| header  =
{{!}} bgcolor={{Table_Cell_Bgcolor_Header}}         {{!}}    <font color=#ffffff>'''{{{col1}}}'''</font>
| #default=
{{!}} {{#if: {{{bgcell1|}}} | bgcolor={{{bgcell1}}} {{!}} }}                        {{{col1}}}
}}
{{!}} {{#if: {{{bgcell2|}}} | bgcolor={{{bgcell2}}} {{!}} }}                        {{{col2}}}
{{!}} {{#if: {{{bgcell3|}}} | bgcolor={{{bgcell3}}} {{!}} }}                        {{{col3}}}
{{!}} {{#if: {{{bgcell4|}}} | bgcolor={{{bgcell4}}} {{!}} }}                        {{{col4}}}
{{!}} {{#if: {{{bgcell5|}}} | bgcolor={{{bgcell5}}} {{!}} }}                        {{{col5}}}

}}





→ Top

DAML XML Parameter Table

Example DAML Parameter Table:


  Variable: Format: Range: Default: Description: Version:
1
<accountName1>
     'ACC_NAME'
</accountName1>
String max. 32 characters empty Unambiguous name of the account

Mandatory configuration!

V5.2
2
<accountName2>
     'ACC_NAME'
</accountName2>
String max. 32 characters empty Unambiguous name of the account

Mandatory configuration!

V5.2



Example:

{{Table_Start}}
{{Xml_Table_Header
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}

{{Xml_Table_Line
|link= XmlAccountName1
|line= 1
|xml= accountName
|name= '''ACC_NAME'''
|format= String
|range= max. 32 characters
|default= empty
|description=
Unambiguous name of the account<br>
<font color=#b8597c>'''Mandatory configuration!'''</font>
|version= V5.2
}}

{{Xml_Table_Line
|link= XmlAccountName2
|line= 2
|xml= accountName
|name= '''ACC_NAME'''
|format= String
|range= max. 32 characters
|default= empty
|description=
Unambiguous name of the account<br>
<font color=#b8597c>'''Mandatory configuration!'''</font>
|version= V5.2
}}

{{Table_End}}




→ Top

Template:Xml_Table_Header

Description:
Header line for DAML XMP parameter descriptions

  • use "hangleft" for hang in from the left side


Usage:

{{Xml_Table_Header | hangleft= Number
| header1= Title 1 | header2= Title 2 | header3= Title 3 | header4= Title 4 | header5= Title 5 | header6= Title 6
}}


Example:

{{Xml_Table_Header
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}
{{Xml_Table_Header | hangleft=50
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: }}


Result:

  Variable: Format: Range: Default: Description: Version:



  Variable: Format: Range: Default: Description: Version:



Template-Code:

{{!}}- valign="top" bgcolor={{Table_Cell_Bgcolor_Header}}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{!}} width=25   align="right" valign="middle" bgcolor={{Table_Cell_Bgcolor_Header}}  {{!}}  
{{!}} width=350 {{!}} <font color=#ffffff>'''{{{header1}}}'''</font>
{{!}} width=100 {{!}} <font color=#ffffff>'''{{{header2}}}'''</font>
{{!}} width=100 {{!}} <font color=#ffffff>'''{{{header3}}}'''</font>
{{!}} width=100 {{!}} <font color=#ffffff>'''{{{header4}}}'''</font>
{{!}} width=275 {{!}} <font color=#ffffff>'''{{{header5}}}'''</font>
{{!}} width=50  {{!}} <font color=#ffffff>'''{{{header6}}}'''</font>




→ Top

Template:Xml_Table_Line

Description:
Parameter line for XMP parameter descriptions

  • use "hangleft" for hang in from the left side
  • different line coloring due to even or odd line number


Usage:

{{Xml_Table_Line | hangleft= Number
|link= Hash tag for a internal page link reference
|line= Line Number
|xml= XML Tag Name
|name= Parameter name
|range= Describes the possible settings
|default= Describes the default value
|description= Description of the parameter
|version= Describes possible AS version dependencies, by default the first apperance of this parameter
}}


Example:

{{Xml_Table_Line
|link= XmlAccountName1
|line= 1
|xml= accountName
|name= '''ACC_NAME'''
|format= String
|range= max. 32 characters
|default= empty
|description=
Unambiguous name of the account<br>
<font color=#b8597c>'''Mandatory configuration!'''</font>
|version= V5.2
}}
{{Xml_Table_Line
|link= XmlAccountName2
|line= 2
|xml= accountName
|name= '''ACC_NAME'''
|format= String
|range= max. 32 characters
|default= empty
|description=
Unambiguous name of the account<br>
<font color=#b8597c>'''Mandatory configuration!'''</font>
|version= V5.2
}}


Result:

  Variable: Format: Range: Default: Description: Version:
1
<accountName1>
     'ACC_NAME'
</accountName1>
String max. 32 characters empty Unambiguous name of the account

Mandatory configuration!

V5.2
2
<accountName2>
     'ACC_NAME'
</accountName2>
String max. 32 characters empty Unambiguous name of the account

Mandatory configuration!

V5.2



Template-Code:

{{!}}- valign="top" bgcolor={{#ifeq: {{#expr: {{{line}}}mod2}} | 0 | {{Table_Cell_Bgcolor_Darkened}} | {{Table_Cell_Bgcolor_Light}} }}

{{#if: {{{hangleft|}}} | {{!}} width={{{hangleft}}} bgcolor={{WHITE}} {{!}}   }}

{{!}} align="middle" bgcolor={{Table_Cell_Bgcolor_Header}} {{!}} <font color=#ffffff>'''{{{line}}}'''</font>

{{#if: {{{xml|}}} |
    {{!}} <{{{xml}}}><font color=#0061a0>'''{{{name}}}'''</font></{{{xml}}}> | {{!}} <font color=#0061a0>'''{{{name}}}'''</font>
}}

{{!}} {{{format}}}
{{!}} {{{range}}}
{{!}} {{{default}}}
{{!}} {{{description}}}
{{!}} {{{version}}}

{{#if: {{{link|}}} | {{!}} width=0  bgcolor={{WHITE}} {{!}} <div id="{{{link}}}"></div> |   }}




→ Top

Wiki Look Like (Theme)


→ Top

Pictures, Graphics, Icon


→ Top

Template:Picture_Help_Link

Description:
Shows a defined help link picture. The default size is 100pt.


Usage:

{{Picture_Help_Link | size=<PIXEL> }}


Example:

{{Picture_Help_Link }}
<br>

{{Picture_Help_Link | size=50}}


Result:
nav

nav


Template-Code:

[[File:help_link_arrow.gif|link=|{{#if: {{{size|}}}|{{{size}}}|100}}px |nav]]




→ Top

Template:Picture_Pdf

Description:
Shows a defined PDF file picture. The default size is 14pt.


Usage:

{{Picture_Pdf | size=<PIXEL> }}


Example:

{{Picture_Pdf}}
<br>

{{Picture_Pdf | size=25}}


Result:
PDF

PDF


Template-Code:

[[File:icon_file_pdf.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |PDF]]




→ Top

Template:Picture_Zip

Description:
Shows a defined ZIP file picture. The default size is 14pt.


Usage:

{{Picture_Zip | size=<PIXEL> }}


Example:

{{Picture_Zip}}
<br>

{{Picture_Zip | size=25}}


Result:
ZIP

ZIP


Template-Code:

[[File:icon_file_zip.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |ZIP]]




→ Top

Template:Picture_Xml

Description:
Shows a defined XML file picture. The default size is 14pt.


Usage:

{{Picture_XML | size=<PIXEL> }}


Example:

{{Picture_Xml}}
<br>

{{Picture_Xml | size=25}}


Result:
XML

XML


Template-Code:

[[File:icon_file_xml.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |XML]]




→ Top

Template:Picture_Img

Description:
Shows a defined image file picture. The default size is 14pt.


Usage:

{{Picture_Img | size=<PIXEL> }}


Example:

{{Picture_Img}}
<br>

{{Picture_Img | size=25}}


Result:
IMG

IMG


Template-Code:

[[File:icon_file_img.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |IMG]]




→ Top

Template:Picture_File

Description:
Shows a defined file picture. The default size is 14pt.


Usage:

{{Picture_File | size=<PIXEL> }}


Example:

{{Picture_File}}
<br>

{{Picture_File | size=25}}


Result:
File

File


Template-Code:

[[File:icon_file_unknown.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |File]]




→ Top

Template:Picture_PrintOut

Description:
Shows a defined "print out" picture. The default size is 14pt.


Usage:

{{Picture_PrintOut | size=<PIXEL> }}


Example:

{{Picture_PrintOut}}
<br>

{{Picture_PrintOut | size=25}}


Result:
Print Out

Print Out


Template-Code:

[[File:icon_print_out.gif|link=|{{#if: {{{size|}}}|{{{size}}}|14}}px |Print Out]]




→ Top

Color Scheme


→ Top

Template:BLUE_100

Description:
Color blue RGB 100%

R 0
G 97
B 160
#0061a0


Usage:

bgcolor={{BLUE_100}}


Result:

 


Template-Code:

"#0061a0"




→ Top

Template:BLUE_70

Description:
Color blue RGB 70%

R 76
G 144
B 189
#4c90bd


Usage:

bgcolor={{BLUE_70}}


Result:

 


Template-Code:

"#4c90bd"




→ Top

Template:BLUE_40

Description:
Color blue RGB 40%

R 153
G 192
B 217
#99c0d9


Usage:

bgcolor={{BLUE_40}}


Result:

 


Template-Code:

"#99c0d9"




→ Top

Template:BLUE_15

Description:
Color blue RGB 15%

R 217
G 231
B 241
#d9e7f1


Usage:

bgcolor={{BLUE_15}}


Result:

 


Template-Code:

"#d9e7f1"




→ Top

Template:BEIGE_100

Description:
Color beige RGB 100%

R 156
G 148
B 114
#9c9472


Usage:

bgcolor={{BEIGE_100}}


Result:

 


Template-Code:

"#9c9472"




→ Top

Template:BEIGE_70

Description:
Color beige RGB 70%

R 192
G 180
B 156
#c0b49c


Usage:

bgcolor={{BEIGE_70}}


Result:

 


Template-Code:

"#c0b49c"




→ Top

Template:BEIGE_40

Description:
Color beige RGB 40%

R 219
G 212
B 199
#dbd4c7


Usage:

bgcolor={{BEIGE_40}}


Result:

 


Template-Code:

"#dbd4c7"




→ Top

Template:BEIGE_15

Description:
Color beige RGB 15%

R 242
G 239
B 234
#f2efea


Usage:

bgcolor={{BEIGE_15}}


Result:

 


Template-Code:

"#f2efea"




→ Top

Template:GREEN_100

Description:
Color green RGB 100%

R 58
G 129
B 125
#3a817d


Usage:

bgcolor={{GREEN_100}}


Result:

 


Template-Code:

"#3a817d"




→ Top

Template:GREEN_70

Description:
Color green RGB 70%

R 117
G 167
B 164
#75a7a4


Usage:

bgcolor={{GREEN_70}}


Result:

 


Template-Code:

"#75a7a4"




→ Top

Template:GREEN_40

Description:
Color green RGB 40%

R 176
G 205
B 203
#b0cdcb


Usage:

bgcolor={{GREEN_40}}


Result:

 


Template-Code:

"#b0cdcb"




→ Top

Template:GREEN_15

Description:
Color green RGB 15%

R 226
G 236
B 236
#e2ecec


Usage:

bgcolor={{GREEN_1}}


Result:

 


Template-Code:

"#e2ecec"




→ Top

Template:LILA_100

Description:
Color lila/purple RGB 100%

R 146
G 111
B 164
#926fa4


Usage:

bgcolor={{LILA_100}}


Result:

 


Template-Code:

"#926fa4"




→ Top

Template:LILA_70

Description:
Color lila/purple RGB 70%

R 178
G 154
B 191
#b29abf


Usage:

bgcolor={{LILA_70}}


Result:

 


Template-Code:

"#b29abf"




→ Top

Template:LILA_40

Description:
Color lila/purple RGB 40%

R 211
G 197
B 219
#d3c5db


Usage:

bgcolor={{LILA_40}}


Result:

 


Template-Code:

"#d3c5db"




→ Top

Template:LILA_15

Description:
Color lila/purple RGB 15%

R 239
G 234
B 241
#efeaf1


Usage:

bgcolor={{LILA_15}}


Result:

 


Template-Code:

"#efeaf1"




→ Top

Template:MANGENTA_100

Description:
Color magenta RGB 100%

R 184
G 89
B 124
#b8597c


Usage:

bgcolor={{MANGENTA_100}}


Result:

 


Template-Code:

"#b8597c"




→ Top

Template:MANGENTA_70

Description:
Color magenta RGB 70%

R 205
G 138
B 163
#cd8aa3


Usage:

bgcolor={{MANGENTA_70}}


Result:

 


Template-Code:

"#cd8aa3"




→ Top

Template:MANGENTA_40

Description:
Color magenta RGB 40%

R 227
G 189
B 203
#e3bdcb


Usage:

bgcolor={{MANGENTA_40}}


Result:

 


Template-Code:

"#e3bdcb"




→ Top

Template:MANGENTA_15

Description:
Color magenta RGB 15%

R 244
G 230
B 235
#f4e6eb


Usage:

bgcolor={{MANGENTA_15}}


Result:

 


Template-Code:

"#f4e6eb"




→ Top

Template:BLACK

Description:
Color black RGB

R 00
G 00
B 00
#000000


Usage:

bgcolor={{BLACK_100}}

Text:
<span style=color:#000000>BLACK on BLUE_15</span>


Result:

BLACK on BLUE_15


Template-Code:

"#000000"




→ Top

Template:GREY_DARK

Description:
Color grey dark RGB

R 150
G 150
B 150
#969696


Usage:

bgcolor={{GREY_DARK}}

Text:
<span style=color:#969696>GREY_DARK on BLUE_15</span>


Result:

GREY_DARK on BLUE_15


Template-Code:

"#969696"




→ Top

Template:GREY_MEDIUM

Description:
Color grey medium RGB

R 192
G 192
B 192
#c0c0c0


Usage:

bgcolor={{GREY_MEDIUM}}

Text:
<span style=color:#c0c0c0>GREY_MEDIUM on BLUE_100</span>


Result:

GREY_MEDIUM on BLUE_100


Template-Code:

"#c0c0c0"




→ Top

Template:GREY_LIGHT

Description:
Color grey light RGB

R 234
G 234
B 234
#eaeaea


Usage:

bgcolor={{GREY_LIGHT}}

Text:
<span style=color:#eaeaea>GREY_LIGHT on BLUE_100</span>


Result:

GREY_LIGHT on BLUE_100


Template-Code:

"#eaeaea"




→ Top

Template:WHITE

Description:
Color white RGB 100%

R 255
G 255
B 255
#ffffff


Usage:

bgcolor={{WHITE}}

Text:
<span style=color:#ffffff>WHITE on BLUE_100</span>


Result:

WHITE on BLUE_100


Template-Code:

"#ffffff"




→ Top

Page Header and Footer


→ Top

Template:PAGE_HEADER

Description:
Customized Page Header for all help pages.


Usage:

{{PAGE_HEADER}}


Example:

{{PAGE_HEADER}}


Template-Code:






→ Top

Template:PAGE_FOOTER

Description:
Customized Page Footer for all online help pages.


Usage:
{{PAGE_FOOTER}}


Example:

{{PAGE_FOOTER}}


Result:
© Copyright Aarenet Inc., Switzerland. Copying of this document or parts of it is prohibited!


Template-Code:

<br style="clear:both">
----
<small>©   Copyright {{SITENAME}}. Copying of this document or parts of it is prohibited!</small>




→ Top

Template:Page_Pdf_Article

Description:
Provides the "command" link for downloading the article as PDF file


Usage:

{{Page_Pdf_Article}}


Result:
http://help.aarenet.com/mediawiki/index.php?title=Operation_daml&action=pdfbook&format=single


Template-Code:

{{fullurl:{{FULLPAGENAME}}|action=pdfbook&format=single}}




→ Top

Template:Page_Help_Links

Description:

  • Contains a search field
  • Offers the possibility to insert up to 5 navigation or other links:
  • nolink : cell is empty
  • pdfdarticle : The article will be downloaded as PDF file
  • any other string is interpreted as link


Usage:

Example 1:
{{Page_Help_Links
| width1=225 | link1=nolink
| width2=225 | link2=nolink
| width3=225 | link3=nolink
| width4=225 | link4=pdfarticle
| width5=100 | link5=nolink
}}


Example 2:
{{Page_Help_Links
| width1=225 | link1={{NAMESPACE}}:help_user                | descr1=Main Help for users and vPBX admins
| width2=225 | link2={{NAMESPACE}}:admincenter_feature_list | descr2=List of all features
| width3=225 | link3=nolink
| width4=225 | link4=pdfarticle
| width5=100 | link5={{Page_Language_Selection | lang=de }} | descr5=Deutsch
}}


Result:
Example 1: Template:Page Help Links


Example 2: Template:Page Help Links


Template-Code:

{{{!}} {{Table_Cell_General}} width=1000

{{!}} bgcolor={{WHITE}} {{!}}
{{#switch: {{NAMESPACE}}
| De =
<div style="float:right">
  <inputbox>
    type=search
    Namespaces=De
    width=30
    placeholder=Durchsuche die Online-Hilfe
    searchbuttonlabel=Suchen
    fulltextbutton=false
    break=no
  </inputbox>
| #default =
<div style="float:right">
  <inputbox>
    type=search
    Namespaces=Main
    width=30
    placeholder=Search the Online Help
    searchbuttonlabel=Search
    fulltextbutton=false
    break=no
  </inputbox>
</div>
}}
{{!}}}
<br style="clear:both">

{{{!}} {{Table_Cell_General}} width=1000
{{!}}- valign="top" bgcolor={{BLUE_15}}

{{!}} width={{{width1}}} {{!}}
{{#switch: {{{link1}}}
| nolink   =  

| pdfarticle =
  {{#switch: {{NAMESPACE}}
  | De =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
  | #default =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
  }}

| #default =
  {{#if: {{#pos:{{{link1|}}}|http}}
  | → [{{{link1}}} <small>{{{descr1}}}</small>]
  | → [[{{{link1}}} | <small>{{{descr1}}}</small>]]
  }}
}}

{{!}} width={{{width2}}} {{!}}
{{#switch: {{{link2}}}
| nolink   =  

| pdfarticle =
  {{#switch: {{NAMESPACE}}
  | De =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
  | #default =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
  }}

| #default =
  {{#if: {{#pos:{{{link2}}}|http}}
  | → [{{{link2}}} <small>{{{descr2}}}</small>]
  | → [[{{{link2}}} | <small>{{{descr2}}}</small>]]
  }}
}}

{{!}} width={{{width3}}} {{!}}
{{#switch: {{{link3}}}
| nolink   =  

| pdfarticle =
  {{#switch: {{NAMESPACE}}
  | De =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
  | #default =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
  }}

| #default =
  {{#if: {{#pos:{{{link3}}}|http}}
  | → [{{{link3}}} <small>{{{descr3}}}</small>]
  | → [[{{{link3}}} | <small>{{{descr3}}}</small>]]
  }}
}}

{{!}} width={{{width4}}} {{!}}
{{#switch: {{{link4}}}
| nolink   =  

| pdfarticle =
  {{#switch: {{NAMESPACE}}
  | De =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
  | #default =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
  }}

| #default =
  {{#if: {{#pos:{{{link4}}}|http}}
  | → [{{{link4}}} <small>{{{descr4}}}</small>]
  | → [[{{{link4}}} | <small>{{{descr4}}}</small>]]
  }}
}}

{{!}} width={{{width5}}} {{!}}
{{#switch: {{{link5}}}
| nolink   =  

| pdfarticle =
  {{#switch: {{NAMESPACE}}
  | De =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Diesen Artikel als PDF herunterladen</small>]
  | #default =
  [{{Page_Pdf_Article}} {{Picture_PrintOut}} <small>Download this article as a PDF</small>]
  }}

| #default =
  {{#if: {{#pos:{{{link5}}}|http}}
  | → [{{{link5}}} <small>{{{descr5}}}</small>]
  | → [[{{{link5}}} | <small>{{{descr5}}}</small>]]
  }}
}}

{{!}}}
<br style="clear:both">




→ Top

Template:Page_Version

Description:
Shows the page release version.
→ TEMPLATE-DIFFERENCE


Usage:

{{PAGE_VERSION |version=1.2 |author=Aarenet |date=October 2015}}


Template-Code:


<br style="clear:both"><br>
<small>Version: {{{version}}}</small><br>
<small>Author : {{{author}}}</small><br>
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
|  
| <small>Date   : {{REVISIONDAY}}.{{REVISIONMONTH}}.{{REVISIONYEAR}}</small><br>
}}

<!--Alternative date: {{{date}}} -->




→ Top

Template:Page_Language_Selection

Description:
Change the language of the page:

en  : English
de  : German


Usage:

{{Page_Language_Selection | lang=en }}


Template-Code:

{{#switch: {{{lang}}}
| de =       {{Page_Help_Url | lang=de }}:{{PAGENAMEE}}
| #default = {{Page_Help_Url | lang=en }}:{{PAGENAMEE}}
}}



Template:Page_Help_Url

Description:
Defines the Help page URL or IP address of a

lang=en : URL for English help pages, eg http://test-help.aarenet.com/wiki/
lang=de : URL for German help pages, eg http://test-help.aarenet.com/wiki/De

→ TEMPLATE-DIFFERENCE


Usage:
{{Page_Help_Url | lang=de }}


Template-Code:


{{#switch: {{{lang}}}
| de =
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
| http://{{An_Wiki_Fqdn_Ip}}/wiki/De
| http://{{An_Wiki_Fqdn_Ip_Test}}/wiki/De
}}

| #default =
{{#ifeq: {{An_Wiki_Site}} | productive_wiki
| http://{{An_Wiki_Fqdn_Ip}}/wiki/
| http://{{An_Wiki_Fqdn_Ip_Test}}/wiki/
}}

}}




→ Top

Page Text Sections

These templates offers to include defined text sections of a page to be included (Wikipedia: transclude) in another page.


Note

A page can have only one standardized section transclusion as offered with these templates.





→ Top

Template:PAGE_SECTION_BEGIN

Description:
Marks the beginning of the page main section.


Usage:

<!-- {{PAGE_SECTION_BEGIN}} --------------------------------------------------------------><section begin=page />


Template-Code:

<section begin=chapter1 />




→ Top

Template:PAGE_SECTION_END

Description:
Marks the end of the page main section.


Usage:

<!-- {{PAGE_SECTION_END}} ----------------------------------------------------------------><section end=page />


Template-Code:

<section end=chapter1 />




→ Top

Template:PAGE_SECTION_TRANSCLUDE

Description:
Includes in the page main section of the defined source page.


Usage:

{{PAGE_SECTION_TRANSCLUDE | link=<NAMESPACE>:<PAGE_TITLE> }}


Example:
{{PAGE_SECTION_TRANSCLUDE | link=admincenter_phone_anipphone }}


Template-Code:

{{#lst:{{{link}}}|chapter1 }}




→ Top

Template:PAGE_INTRO_BEGIN

Description:
Marks the beginning of the page introduction section.


→ This template is not working as expected!!

It is in the pages replaced with:
<!-- Page Overview Start -----------------------------------------------------------------><section begin=intro />


Usage:
{{PAGE_INTRO_BEGIN}}


Template-Code:

<section begin=intro />




→ Top

Template:PAGE_INTRO_END

Description:
Marks the end of the page introduction section.


→ This template is not working as expected!!

It is in the pages replaced with:
<!-- Page Overview End   -------------------------------------------------------------------><section end=intro />


Usage:

{{PAGE_INTRO_END}}


Template-Code:

<section end=intro />




→ Top

Template:PAGE_INTRO_TRANSCLUDE

Description:
Includes in the page introduction section of the defined source page.


Usage:

{{PAGE_INTRO_TRANSCLUDE | <PAGE_TITLE> }}


Example:

{{PAGE_INTRO_TRANSCLUDE | {{NAMESPACE}}:user_stimulus_procedures }}


Template-Code:

{{#lst:{{{1}}}|intro }}




→ Top

Template:STIMULUS_SERVICE_TRANSCLUDE

Description:
Includes in the stumulus service section of source page ":user_stimulus_procedures".


Usage:

{{STIMULUS_SERVICE_TRANSCLUDE | <SERVICE> }}


Example:

{{STIMULUS_SERVICE_TRANSCLUDE | Service21 }}


Template-Code:

{{#lst:{{NAMESPACE}}:user_stimulus_procedures | {{{1}}} }}




→ Top

Hash Tag & Navigation

Hash tag (diversions) offers to make links into a page. In a page divers standardized hash tag points can be defined.



→ Top

Template:ToTop

Description:
Jump to the page top


Usage:
<

{{ToTop}}


Template-Code:

[[#top|<small>→ Top</small>]]




→ Top

Template:PAGE_DIVERSION_FEATURE

Description:
Hash tag the beginning of the feature description as internal page link.


Usage:

{{PAGE_DIVERSION_FEATURE}}


Template-Code:

<div id="PageDiversionFeature"></div>




→ Top

Template:PAGE_DIVERSION_CONFIGURATION

Description:
Hash tag the beginning of the feature configuration as internal page link.


Usage:

{{PAGE_DIVERSION_CONFIGURATION}}


Template-Code:

<div id="PageDiversionConfiguration"></div>




→ Top

Template:PAGE_DIVERSION_NAVIGATION

Description:
Hash tag the beginning of the feature navigation description as internal page link.


Usage:

{{PAGE_DIVERSION_NAVIGATION}}


Template-Code:

<div id="PageDiversionNavigation"></div>




→ Top

Template:PAGE_DIVERSION_ENTITY

Description:
Hash tag the beginning of the feature entity description as internal page link.


Usage:

{{PAGE_DIVERSION_ENTITY}}


Template-Code:

<div id="PageDiversionEntity"></div>




→ Top

Template:PAGE_DIVERSION_PARAMETER

Description:
Hash tag the beginning of the feature parameter description as internal page link.


Usage:
{{PAGE_DIVERSION_PARAMETER}}


Template-Code:

<div id="PageDiversionParameter"></div>




→ Top

Template:PAGE_DIVERSION_TROUBLE_SHOOTING

Description:
Hash tag the beginning of the feature trouble shooting description as internal page link.


Usage:

{{PAGE_DIVERSION_TROUBLE_SHOOTING}}


Template-Code:

<div id="PageDiversionTroubleShooting"></div>




→ Top

Template:PAGE_DIVERSION_COMMISSIONING

Description:
Hash tag the beginning of the feature commissioning description as internal page link.


Usage:

{{PAGE_DIVERSION_COMMISSIONING}}


Template-Code:

<div id="PageDiversionCommissioning"></div>




→ Top

Template:PAGE_DIVERSION_LINK

Description:
Inserts an interwiki link to a standard (see above) internal page hash tag (section title):

  • Feature
  • Configuration
  • Navigation
  • Entity
  • Parameter
  • Commissioning
  • TroubleShooting


Usage:

{{PAGE_DIVERSION_LINK
| link= {{NAMESPACE}}:<PAGE_TITLE>
| div= Feature | Configuration | Navigation | Entity | Parameter | Commissioning | TroubleShooting
| description=blabla
}}


Example:

{{PAGE_DIVERSION_LINK
| link= {{NAMESPACE}}:admincenter_subsc_conference | div= Entity | description=eröffnet im Voraus den Konferenzraum
}}


Template-Code:

[[{{{link}}}#PageDiversion{{{div}}}{{!}}{{{description}}}]]





→ Top

Very Special Templates


→ Top

Template:!

Description:
Sometimes it is needed to replace the mediawiki pipe-ing directive “|” with {{!}} within templates.


Template-Code:

|


Usage:
{{!}}



→ Top



© Aarenet Inc 2018

Version: 3.0     Author:  Aarenet     Date: May 2017