Scroll

Kodim installation parameters : URLs and IP addresses

Kodim installation parameters : URLs and IP addresses

Follow
Summary This article describes the URLs and IP addresses used by askiakodim.
Applies to askiakodim
Written for Fieldwork manager
Keywords URL; IP; address; coding; kodim; askiakodim

 

askiakodim Installation

Components

There are two components in the coding solution:

  • Post-Coding Client A Silverlight browser-based application
  • Post-Coding Service A WCF (Windows Communication Service) web-service

Users perform coding via a website which contains the Post-Coding Client application. The client application communicates with the service, which in turn communicates with an installation of Askia Field.

The components are installed separately and each has its own installer. They do not need to be installed on the same server, nor do they need to be installed on the server as the Field installation they will connect to, as long as all servers that are used can communicate with each other.

The installers create IIS applications for their respective components and use settings obtained from the installation wizards. After installation it is simple to change the settings for the components to handle changes or installation mistakes.

Configuration

The web-service is configured using the file web.config located in the application directory. The following settings are of note:

  • FieldIPAddress The IP address or server name of the server running the Field solution that the coding service will connect to.
  • FieldPort The port on the server running the Field solution that is listening for connections via the AskiaFieldApi.
  • baseAddress The URL of the service application.

The client installer creates an example webpage CodingClientTestPage.aspx that shows how the Silverlight client application can be hosted. Users can of course create their own pages to host the coding client, but they should examine the example page and ensure that their own pages use the same Javascript as it performs the important agent logout function. The example page has the following settings of note:

IP addresses

If the coding service needs to be externally accessible (i.e. via the internet) then the various IP addresses and URLs must be resolvable; in particular, local server names cannot be resolved externally and should be replaced with public IP addresses or DSN names that will resolve.

x64 Servers

All of the Kodim installers prior to 5.3.1.3 and 5.3.2.0 install an x86 application, which means that the default installation will not work correctly on x64-based servers. However, these earlier installers can be used with a couple of minor additional steps.

For the Coding Service application pool:

  • Change the “Managed pipeline mode” setting to “Integrated” (located in “Basic Settings”)
  • Change the “Enable 32-Bit Applications” setting to “True” (located in “Advanced Settings”)

For the Coding Client application pool:

  • Change the “Managed pipeline mode” setting to “Integrated” (located in “Basic Settings”)

Installing IIS6 compatibility components

These instructions apply to users attempting to install the askia coding solution on a server running IIS 7. The coding solution is compatible with IIS 6 and therefore the coding solution installers require IIS 7 to be configured so that it can run IIS 6 applications. Installation on a server running IIS 6 does not require applying these instructions.

Install the IIS 6.0 Management Compatibility Components in Windows Server 2008 R2 or in Windows Server by using the Server Manager tool

  1. Click Start, click Administrative Tools, and then click Server Manager.
  2. In the navigation pane, expand Roles, right-click Web Server (IIS), and then click Add Role Services.
  3. In the Select Role Services pane, scroll down to IIS 6 Management Compatibility.
  4. Click to select the IIS 6 Metabase Compatibility and IIS 6 Management Console check boxes.
  5. In the Select Role Services pane, click Next, and then click Install at the Confirm Installations Selections pane.
  6. Click Close to exit the Add Role Services wizard.

Install the IIS 6.0 Management Compatibility Components in Windows 7 or in Windows Vista from Control Panel

  1. Click Start, click Control Panel, click Programs and Features, and then click Turn Windows features on or off.
  2. Open Internet Information Services.
  3. Open Web Management Tools.
  4. Open IIS 6.0 Management Compatibility.
  5. Select the check boxes for IIS 6 Metabase and IIS 6 configuration compatibility and IIS 6 Management Console.
  6. Click OK

Settings

Client settings:

By default, the client is hosted in an .aspx page named “CodingClientTestPage.aspx” in the application directory of the client. This page sets the parameters that configure the client; user-specific settings are not stored here and are not discussed below.

The page contains a number of parameters, but only one parameter - initParams - should be changed, and only then if required. The value of the parameter is a comma-delimited string that defines 4 different settings.

  • ServiceURI - the URI of the Coding Service that the client will connect to. This is of the form “http:///”, e.g. “http://123.1.1.99/MyPostCodingService”.
  • ServiceNamespace - the namespace of the Coding Service that the client will connect to. The default value is “askia.com/webservices/”. Do not change this.
  • InterviewChunkCnt - the number of interviews the client requests at a time. The higher this value, the higher the strain on the CCA each time a request is made. A modest value keeps the CCA responsive. The default value is “50” but this can be tuned higher or lower as appropriate for your CCA installation.
  • SaveBiteSize - the number of items that are saved by the client at a time. The higher this value, the higher the strain on the CCA each time a save is made. A modest value keeps the CCA responsive. The default value is “50” but this can be tuned higher or lower as appropriate for your CCA installation.
  • ServiceTimeOut - the maximum period of time (in seconds) that a web-service operation can take to complete before the client considers the operation timed-out. A higher value allows the client to wait longer for the CCA to respond and can be useful for operations that may take a long time (for example, retrieving interviews from a slow database). The default value is “180” but can be tuned higher or lower as appropriate for your CCA installation. 5.2.4.4 and later, only.

Service settings:

Settings are located in the file “web.config” in the application directory of the service and can be modified by a text-editor. Recycle the application pool in which the service is running to apply any changes.

  • FieldIPAddress - the IP address or resolveable server name of the CCA that the service will connect to. If the CCA is running on the same machine as the service, the value should be “127.0.0.1”.
  • FieldPort - the port on which the CCA communicates with the coding service - the “Port Number” in the “API” section of the CCA settings - which is usually “980”.
  • TimeOutFactor - the maximum length of time that the service will wait for the CCA to respond to requests. The value is in milliseconds and the default is “120000” (i.e. 120 seconds).

 

 


The Kodim installers use the name of the server that the applications are being installed on as part of the URL that specifies the location of the coding service that the coding client will connect to. This works perfectly when the client is running on the local network as the server name can be resolved to a local IP address by the local DNS. However, when using the client via the internet, a server name has no meaning; what is needed is either an IP address or a domain name that can be resolved.

Ideally, the host-header for the web-server should be configured so that a resolvable domain name is specified. See here for a guide.

The server name is used the initParams setting of the .aspx file (by default, "CodingClientTestPage.aspx") that hosts the coding client plugin. It specifies the server hosting the coding service that the coding client will connect to.

An example of such a modification would be:

from this:

<param name="initParams" value="ServiceURI=http://TestServer01/PostCodingService_v5_3_1_2/PostCodingService.svc,ServiceNamespace=askia.com/webservices/,InterviewChunkCnt=50,SaveBiteSize=50,ServiceTimeOut=180" />

to this:

<param name="initParams" value="ServiceURI=http://coding.mycompany.com/PostCodingService_v5_3_1_2/PostCodingService.svc,ServiceNamespace=askia.com/webservices/,InterviewChunkCnt=50,SaveBiteSize=50,ServiceTimeOut=180" />
Have more questions? Submit a request

Comments