> For the complete documentation index, see [llms.txt](https://docs.keyfax.biz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/keyfax-configuration/example-settings.md). # Example Settings Configuration settings are published for information purposes only. Unless express consent has been granted, changes to configuration settings must only be made by Omfax Systems/Touch-Base Ltd technicians or their representatives. ### Example 1 (put current user code in startup.xml) ``` ``` This example does following: 1. Get the value contained in the `UserID` property of the `CGateway` object. 2. Use this value in the WHERE clause of the SQL statement replacing the \[value] bookmark. 3. Execute the SQL statement against the SQL ActiveH SQL Server database. 4. Put the returned value in the `` element of the Keyfax start-up XML. ### Example 2 (get SOR code from export.xml and assign the ScheduleID property of a CRQTask object) ``` ``` This example does following: 1. Get the value contained in the `` element of the export XML. 2. Use this value in the WHERE clause of the SQL statement replacing the \[value] bookmark. 3. Execute the SQL statement against the SQL ActiveH SQL Server database. 4. Put the returned value in the `ScheduleID` property of a new `CRQTask` object in the MIS-AMS Repairs Request object. ### Example 3 (get the description from the export.xml ActionCodeDesc and FaultText and use as a Repair Request Inspection description) ``` ``` This example does following: 1. Get the value contained in the `` element of the export XML. 2. Put the returned value in the Description property of a `CRQInspection` object in the MIS-AMS Repairs Request object. 3. Get the value contained in the `` element of the export XML. 4. Append the returned value to the Description property of a CRQInspection object in the MIS-AMS Repairs Request object. ### Example 4 (write a constant value to a CRM Desktop Task object) ``` ``` This example does following: 1. As with all CRM tasks, there may be multiple Task objects to create, therefore `` elements need to be nested. 2. A new `CTSTask` object is created with the `` element (by using without a target property) for each created Keyfax "Enquiry.Action". 3. All first generation `` child elements instruct Keyfax to write to the current CTSTask object. 4. The SystemTask property of the current CTSTask object is set to a constant value (defined by the `KFsourceType="VALUE"`) which is supplied in the KFsource parameter (`KFsource="1"`). ### Example 5 (write to the SetGatewayValue method of a CRM Desktop Task object) ``` ``` This example does following: 1. As with all CRM tasks, there may be multiple Task objects to create therefore MISTask elements need to be nested. 2. A new CTSTask object is created with the `` element (by using without a target property) for each created Keyfax "Enquiry.Action". 3. All "first generation" `` child elements instruct Keyfax to write to the current CTSTask object. 4. The SetGatewayValue method of the current CTSTask object requires two parameters these are defined in additional `` child elements. 5. The "second generation" `` child elements instruct Keyfax to write to the current CTSTask SetGatewayValue method parameters. 6. The first "second generation" `` child element gets the value contained in the `` element of the export XML, then writes it to the SetGatewayValue.FieldName parameter. 7. The second "second generation" `` child element gets the value contained in the `` element of the export XML, then writes it to the SetGatewayValue.Value parameter. ### Example 6 (write to the SetGatewayValueEx method of a CRM Repair Request Task) ``` ... ... ... ... ``` This example does following: 1. The `SetGatewayValue` method of the current `CRQTask` object requires two parameters these are defined in additional `` child elements. In reality, just for the Repairs Request object this calls a method `SetGatewayValueEx` (this does not need to be considered when setting up the exchange parameters above!). 2. In the example above, `HealthAndSafety` is the name of the **target** (despite being held in the `KFsource` attribute) within the Gateway 3. **`Nominal_Code`** happens to be a re-use of an export element; the contents of this (one or zero) will be stored in the `HeathAndSafety` field.