FRENDS

FRENDS Iron Configuration tool documentation

Contents

Introduction

Configuration tool will setup the needed Windows services, databases and setting files. The tool is available after FRENDS Iron installation. To get more information about FRENDS Iron installation, see the FRENDS Iron Documentation or Readme.

With the Configuration tool, you are allowed to define the following settings:

The Configuration tool also allows you to change or unconfigure the service's settings without reinstalling the whole service.


Configuration/Reconfiguration

The Configuration tool is available after FRENDS Iron service installation. You can launch the Configuration tool by checking the Launch Configuration Wizard checkbox at the end of the FRENDS Iron installation or manually selecting the FRENDS Iron Configuration shortcut from FRENDS start menu.

Reconfiguration is possible by using the Configuration tool. If you need to change some FRENDS Iron service settings, just launch the Configuration tool manually and give new settings.

Administrative rights required

Because the FRENDS Iron service and user interface are installed and configured by the Configuration tool, it requires Administrator rights on the local machine. As described in the readme, the user running the Configuration tool should also have sysadmin rights (or the individual required rights) on the database server in order to set up the database, and belong to the BizTalk Server Administrators and SSO Server Administrators groups to register the BizTalk adapters.

Basic UI Sequence

When launching the Configuration tool, it first tries to look for existing settings from existing configuration files. This allows you to reuse the current settings and do only the needed changes e.g. when upgrading from a previous version.

If the Configuration tool does not find existing configuration files, you need to give all the settings manually. This is needed e.g. when you have just done a clean installation or have previously unconfigured FRENDS Iron . In this case, you can also use an import a previously exported settings file, as described in the next section.

Basic settings

For the basic configuration settings you need to give the following: the license file, the name of the database server, the service's user account and password.

Basic configuration settings

  1. Give the license file
  2. Give the user account and password for running the service

You can also import the configuration from a file by clicking on the Import Configuration link and browsing to the file. You can also choose to remove the configuration by selecting the Unconfigure FRENDS Iron option; for more on this see: Unconfiguration.

After you have given the basic settings, just click Next.

Control service settings

For the FRENDS Iron control service settings you need to give the service endpoint base address and the local path. You can also decide if you want to register BizTalk adapter for FRENDS Iron and start FRENDS Iron service after configuration or not.

Configuration - Control service settings

  1. Check the web service endpoint addresses are correct.
  2. Select Deploy latest FRENDS Cobalt and FRENDS Radon task assemblies, if you want the latest assemblies copied to the FRENDS Iron installation directory, where FRENDS Iron will use them.
    NOTE: If you replace any existing FRENDS Radon/Cobalt assemblies with different ones than those in FRENDS Iron installation folder, existing routines and tasks may become non-executable especially if there have been changes in task workflows. In such case you may need to manually reconfigure tasks and routines in FRENDS Iron.
  3. Select Import FRENDS Cobalt and FRENDS Radon tasks, sample routines and connection points, if you want the latest versions of the FRENDS elements to be imported. This is usually not needed if the Cobalt and Radon versions have not changed.
  4. Select Register BizTalk adapter for FRENDS if you want to register the adapter.
  5. Select Start FRENDS service after configuration if you want to start the FRENDS Iron service immediately after configuration.
  6. If there are no existing encryption keys defined in the configuration, you can generate a new key pair here.

After you have given the valid control service settings, just click Next.

Database settings

Configuration - Database settings

On the database settings form, the Configuration tool searches for existing FRENDS Iron databases on the local server and sets the settings accordingly:

  1. Create new databases - this option will be the default if no FRENDS Iron databases are found
  2. Use existing databases - this option will be the default (and also enabled only) when existing FRENDS Iron databases are found

If the database server list drop-downs do not contain the database you would like to use, clicking the "Refresh Server list" button will try to locate all database servers in the domain and fetch the database details from them.

NOTE: Since version 2.4 Frends uses fixed database names "FRENDS" and "WorkflowStore". If you upgrade from earlier version to 2.4 and have not used these database names, you need to rename your databases to default names before upgrading in order to use existing databases.

The Configuration tool never creates, upgrades, or repairs BizTalk Database; its information is just shown.

Backup location is required for FRENDS Iron database backups. This is the folder where the FRENDS Iron database jobs save the database backups. By default all backups are saved in the same folder. If you need to, the database backup folder can be changed also by editing the database jobs manually in SQL Server Management Studio. For more information on FRENDS Iron database jobs see Readme: Enabling database jobs. Backups taken during configuration process are also saved into this directory.

If database jobs already exist on server, but they are not enabled, configuration tool will enable the jobs by default but leaves backup locations intact.

NOTE: If FRENDS Iron is already configured and FRENDS database backup jobs have been manually completely removed from the database server and then configuration tool is run again, you may see a note text that database jobs will be added. However, in this kind of special situation the jobs will not be added by the configuration tool.

Configuration tool backs up FRENDS Iron databases during configuration process. Since backing up databases can be quite time consuming operation, you can choose not to back up databases by unchecking the "Back up FRENDS Iron databases..." checkbox. Note that if you do not back up databases, database rollback won't occur either in case of configuration failure. If you choose not to take backups during configuration, make sure you have some other method of backing up databases in use and backups have been taken prior to configuration process.

After you have given valid database settings, just click Next.

Automatic error reporting

If you want to send email for all errors automatically, you can enable the automatic error reporting functionality on the next page.

Configuration - Automatic reporting settings

Just check the Enable automatic reporting checkbox and give the necessary SMTP details to the fields. After this, FRENDS Iron will send email for all ERROR-level log messages.

After this, just click Next.

Web user interface configuration

You can configure a web site to be hosted on the local IIS server to provide web user interface access to FRENDS Iron.

Configuration -Web user interface settings

Once you've provided web user interface configuration information, just click Next.

Log service and service bus configuration

FRENDS Log Service can be configured to log FRENDS Cobalt file transfers. If FRENDS Log Service is not selected to be used and configured Service Bus based logging infrastructure will be unavailable for use and transfer view and transfer list will also be unusable in FRENDS Iron's web user interface.
NOTE: To be able to use Service Bus logging features you need an active Windows Azure subscription and Azure Service Bus set up or Service Bus for Windows Server installed. For more information on Service Bus and logging infrastructure requirements, see Readme.

Configuration -Log service and service bus settings

Following information is needed to configure the FRENDS Log Service.

When configuration information required is entered, or use of FRENDS Log Service is unselected, just click Next.

Logging add-in configuration configuration

If FRENDS Log Service has been selected to be used and configured on the previous configuration page, add-ins for FRENDS Log Service must be configured as well if they are installed.

Configuration -Logging add-ins settings

When you've provided configuration information, just click Next.

Configuration process

After you have given all the settings, you are ready to start the configuration process.

Summary

The Configuration tool reviews your selections on the summary page. You can accept the settings and start the configuration process by clicking Apply.

After a successful configuration the Configuration tool shows the summary of the process. The configured settings are marked with the green icon.

Configuration - Configuration summary

If an error occurs during the configuration process, the process rollbacks; the old settings and databases are restored (for more details, see the chapter: Troubleshooting errors). The Configuration tool shows the summary of the process and the failed settings are marked with the red icon.

Export configuration

You can export the configuration settings to a file on the summary page.

  1. Click the Export Configuration button and select the file path and file name; the Configuration tool creates an XML-document that contains your settings.
  2. You can import this configuration setting file when you start the Configuration tool next time on the Configuration tool front page.

Logging

The whole configuration process is logged. Therefore you can open the log file by clicking the View log button or manually from the ...\Frends Technology\FRENDS Iron\Logs\FRENDSAccConfiguration.log .


Exporting connection point encryption keys

Exporting Connection point Encryption keys is needed when multiple FRENDS Iron installations share the same database, when changing the FRENDS Iron service user account or when a backup of the keys is needed.

Cryptoutil

Exporting keys is done with the Frends.Acc.CryptoUtil.exe program found in the FRENDS Iron installation directory. Usage:

  1. Open a command prompt as the FRENDS Iron Service user:
    Run-> runas /profile /user:<domain>\<FRENDS Service user> cmd
    Example: runas /profile /user:OURDOMAIN\FrendsUser cmd
  2. Change the directory to the FRENDS Iron installation directory (default: C:\Program Files\Frends Technology\FRENDS Iron)
    Example: cd "\Program Files\Frends Technology\FRENDS Iron"
  3. Export the keys to a file: Frends.Acc.CryptoUtil.exe export <location where to export> <password to protect the contents with>
    Example: Frends.Acc.CryptoUtil.exe export C:\keys.txt mysecretpassword
  4. The exported file can now be used for importing the keys.

Unconfiguration

The Configuration tool allows you to remove all settings and delete databases, just launch the Configuration tool and select the option Unconfigure FRENDS.

Unconfiguration settings

When unconfiguring, the Configuration tool allows you to choose what you want to be unconfigured.

Configuration - Unconfiguration summary

You can select the settings to be unconfigured and start the unconfiguration process by clicking "Apply".

After the unconfiguration process, the Configuration tool shows the unconfigured settings. Unconfigured settings are marked with the green icon and failed settings with the red icon.

NOTE: Unconfiguring FRENDS Iron will delete FRENDS database and Workflow database from your database server without making backups.

Also note that unconfiguration will not remove any configured web user interface, neither physically nor from IIS configurations. Therefore any configured web user interface web site removals must be done manually.


Troubleshooting errors

This section gives some guidelines on what to do in case of errors while configuration, reconfiguration or unconfiguration process.

Finding the reason for the error: viewing logs

The first step in fixing the error is to find out what caused it. Errors during the configuration, reconfiguration or unconfiguration are logged in the FRENDSAccConfiguration.log file. The log file is in the ...\Frends Technology\FRENDS Iron\Logs\ -folder.

Common errors and fixes

Error when installing UI: "Unable to get installer types..."

The configuration tool may fail when installing the user interface, with the following kind of error message:

Error when applying changes: Unable to get installer types in the <installation directory>\Frends.Acc.SnapIn.dll assembly.

This error is usually caused by the fact that the configuration tool could not load the required Microsoft Management Console 3.0 types. First thing to check is that the MMC 3.0 libraries are installed. On Windows XP and Windows Server 2003 you need to install them separately. See Microsoft Knowledge base article KB907265 for details and downloads. On Windows Server 2003 R2, Windows Vista, and Windows Server 2008, the necessary libraries should already be present.

If MMC 3.0 is installed, the configuration tool should be able to locate and use the necessary files. In some cases this automatic procedure may not work, and you have to do it manually:

Cannot uninstall BizTalk submit adapter because it is currently in use

This error is caused by the fact that some BizTalk applications are using the BizTalk Submit adapter. If you want to uninstall the adapter, you need to stop the BizTalk applications and remove them first. After that you can uninstall the BizTalk submit adapter.

Cannot drop database because it is currently in use

This error occurs if some of the FRENDS Iron databases are used during the configuration, reconfiguration or unconfiguration process.

To fix this error make sure that FRENDS Iron databases are not in use by stopping the FRENDS Iron service.

Error when applying changes - write on backup failed

This error might occur during configuration or reconfiguration process. There is one possible reason: you are running with low hard disk capacity.

To fix this error, make sure that you have enough space on your hard disk for the backups.

Error when applying changes - cannot open database

This error might occur during configuration or reconfiguration process. The most common reason is a database connection break.

To fix this, make sure that the database connection is available and SQL server is running.

Error when applying changes - cannot create encrypted private key

An error dialog comes up with the error detail: "(Logon failure: the user has not been granted the requested logon type at this computer)"

This is most likely caused by the service user not having the privilege to log on locally, set in the security policy setting "Deny log on locally". In order to encrypt the private encryption key, the configuration tool starts a new process using the service user account. If the user does not have the right to log on, you may encounter this error.

You need to allow the user to log on locally, at least during the configuration. If you want to deny the service user rights to log on later, you can enable this setting later on.

Timeout error when backing up databases / creating Full-Text index

If your WorkflowStore or FRENDS database is large (e.g. you have heavy load on the server, so many instances are stored in the execution history tables) backing up the databases or creating a full-text index may take longer than the default SQL command timeout of 30 minutes.

If you encounter this error, you can increase the command timeout by setting the SqlCommandTimeoutSeconds setting in the configuration file. To do this, open the Frends.Acc.Configuration.Form.exe.config file, and look for the following settings:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
	<configSections>
	    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
	    <!-- if this config sectionGroup is not present, add it -->
	    <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
	        <section name="Frends.Acc.Configuration.Utils.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
	    </sectionGroup>
	</configSections>
	...
	<applicationSettings>
	    <Frends.Acc.Configuration.Utils.Settings>
	        <setting name="SqlCommandTimeoutSeconds" serializeAs="String">
	            <value>1800</value>
	        </setting>
	    </Frends.Acc.Configuration.Utils.Settings>
	</applicationSettings>
</configuration>

Error when applying changes - could not obtain information about user

An error dialog comes up with the error detail: "Error when applying changes: Exception when executing command 'select IS_ROLEMEMBER (@p0, @p1): Could not obtain information about Windows NT group/user.."

This error might happen while upgrading or installing Iron to use an existing database. The problem could be caused by configuration error in Active Directory access rights.

You can fix the error by removing the user mapping of the FRENDS Iron Service user account to FRENDS and WorkflowStore databases and then running Configuration tool again. This will recreate the mapping.

IIS management tools not found. Cannot install web user interface.

Web user interface configuration form may be disabled and an error message: "IIS management tools not found. Cannot install web user interface" is shown. Such error can occur if:

  1. IIS is not installed
  2. Microsoft.Web.Administration.dll (which should be installed with IIS) is not found in server's Global Assembly Cache (GAC).