Agility.config.xml

Agility.config.xml It is a main configuration file for Agility.

Databases configuration section

<configuration>
	<databases DefaultDatabase="fastNet" DefaultmaxResults="500" >
		<fastNet 
			ConnectionString="Initial Catalog=Agility7213FNLive;Data Source=SERVERNAME\SQLSERVER2008R2;user id=agilityuser;password=Ag1l1tyuser"
			DatabaseType="MSSQL"
			DatabaseSubType=""
			InitializationString="set transaction isolation level read uncommitted"
			ConnectionInitializationString = ""
			TopPhrase="true" 
			QuoteStartChar=""" 
			QuoteEndChar=""" 
			NationalCharSupport="true"
			ODBCGetSchemaSupport="False"
			controlVersionMode="Version"
			CommandTimeout="180"
			UpdateCommandTimeout="1800"
			/>
		<sxp 
			ConnectionString="Initial Catalog=Agility7213Live;Data Source=SERVERNAME\SQLSERVER2008R2;user id=agilityuser;password=Ag1l1tyuser"
			DatabaseType="MSSQL"
			DatabaseSubType=""
			InitializationString="set transaction isolation level read uncommitted"
			ConnectionInitializationString = "set transaction isolation level read uncommitted"
			TopPhrase="true"
			QuoteStartChar=""" 
			QuoteEndChar=""" 
			NationalCharSupport="true"
			ODBCGetSchemaSupport="False"
			controlVersionMode="Version"
			CommandTimeout="180"
			UpdateCommandTimeout="1800"
		/>
  </databases> 

The databases section details all the databases that are known to the system. They are known by their logical names which is how they are referenced within the Business Objects, against each logical database name are the parameters required in order to provide a connection to the physical database and also to reflect the “dialect” of MSSQL to be used.

PARAMETER NAME	VALUE	DESCRIPTION
DefaultDatabase	fastnet	The logical name of the database which contains all the forms etc used by the Fastnet system
DefaultMaxResults	“300”	The maximum number of records returned in any scan or help form. This default value may be overridden on any scan or help forms.

The format of the connections string will be different dependant upon the database type. However the parameters available are:-

Connection Parameters

PARAMETER NAME	VALUES	DESCRIPTION
ConnectionString	“”	The physical connection parameters needed to connect to the database. As the values here are all one parameter they should be enclosed within Double Quotation marks. See examples below.
DatabaseType	“MSSQL”, “ODBC”, or “OLEDB”	The database type which will be used to determine the driver to be used to access the data.
DatabaseSubType		Information to further identify the Database within the above broad categories.
InitialisationString	“” ||The string of characters set to the database immediately after connection. See examples below.
ConnectionInitializationString	“”	See examples below.
TopPhrase	“True” or “False”	If the SQL database understands the SELECT “TOP” syntax to restrict the size of a result set, set this parameter to “True”.
QuoteStartChar	"""	The Character to be used (if any) to prefix table/field names in a query. e.g. SELECT “PMCRAFT”.”CRAFTCODE”. Use of this option avoids “reserved words” used in “data names” Corrupting SQL strings. Not all Databases support this option.
QuoteEndChar	"&quot"	The Character to be used (if any) to suffix table/field names in a query. e.g. SELECT “PMCRAFT”.”CRAFTCODE”. Use of this option avoids “reserved words” used in “data names” corrupting SQL strings. Not all Databases support this option.
NationalCharSupport	“True” or “False”	If the database can understand double byte characters set this option to true. Typically if the database supports the NVARCHAR and NCHAR functions this option should be set.
ODBCGetSchemaSupport	“False”	Only relevant for ODBC databases. If the database supports the GetSchemaTable function call to provide a list of all fields within a table set this option to “true”. Otherwise the syTableColumns will need to be manually populated. controlVersionMode ||“Version” or “COMSEQ” etc. ||Either the name of the field within every Table of the database which will be used to determine if a record has been changed by another user. Or the following reserved words
CheckAllFields		– the system will check each field individually against the copy originally read and its reject the update if any field has changed.
NoCheckFields -		No check is made for changes to data before writing back to the database. (Only valid for single user Installations).
LockingControlFieldType		The type of the Database field above may be either integer in which case it is incremented with each write or datetime in which case it is date/time stamped with every update.
CommandTimeout		Gets or sets the wait time before terminating the attempt to execute a command and generating an error. A value of 0 indicates no limit. This property supported by all database types.
TransactionIsolationLevel	“chaos”, “readcommitted”, “readuncommitted”, “repetableread”, “serializable”, “snapshot”, “unspecified”	Specifies the transaction isolation level that will be used by data access layer for any transactional data processing. See specific database documentation for details about specific isolation level. ReadCommitted isolation level is used as default if nothing specified.

MSSQL Databases

PARAMETER NAME	VALUE	DESCRIPTION
ConnectionString	=”InitialCatalog=PhysicalName; Data Source=SQLHostName; User id=UserLogin; Password=UserPassword”	The physical connection parameters needed to connect to the database. As the values here are all one parameter they should be enclosed within Double Quotation marks.
DatabaseType	“MSSQL”	The database type which will be used to determine the driver to be used to access the data.
InitialisationString		"set transaction isolation level read uncommitted"
ConnectionInitializationString	“”
TopPhrase	“True”
QuoteStartChar	"""
QuoteEndChar	"&quot"
NationalCharSupport	“True”
ODBCGetSchemaSupport	“False”
LockingControlField		For the Fastnet and Agility Databases this will be “VERSION”
LockingControlType		For the Fastnet and Agility Database this will be “Integer”

Progress Databases

PARAMETER NAME	VALUE	DESCRIPTION
ConnectionString	"DRIVER={MERANT 3.60 32-BIT Progress SQL92 v9.1D}; DB=PhysicalName; PORT=PortNumber; HOST=ProgressHost; UID=UserLogin; PWD=UserPassword;"
DatabaseType	“ODBC”
InitialisationString	"set schema ‘pub’"
ConnectionInitializationString	“”
TopPhrase	“False”
QuoteStartChar	"""
QuoteEndChar	"&quot"
NationalCharSupport	“True”
ODBCGetSchemaSupport	“True”
controlVersionMode		For the IMPACTxp database this will be “COMSEQ”
LockingControlType		For the IMPACTxp Database this will be “Integer”

Access Databases via ODBC

PARAMETER NAME	VALUE	DESCRIPTION
ConnectionString	"DRIVER={Driver do Microsoft Access (*.mdb)}; DBQ=C:\database\access\Northwind.mdb; UID=username; PWD=Password”;
DatabaseType	“ODBC”
InitialisationString	""
ConnectionInitializationString	“”
TopPhrase	“”
QuoteStartChar	"""
QuoteEndChar	"&quot"
NationalCharSupport	“True”
ODBCGetSchemaSupport	“True”
controlVersionMode
LockingControlType

SQL Anywhere 9.0 Databases via ODBC

PARAMETER NAME	VALUE	DESCRIPTION
ConnectionString	"DRIVER={Adaptive Server Anywhere 9.0}; DBF=C:\database\sybase\miquest.db; DefaultDir=c:\temp;Uid=dba;Pwd=password;DSN=dacSybase”
DatabaseType	“ODBC”
InitialisationString	""
ConnectionInitializationString	“”
TopPhrase	“True”
QuoteStartChar	"""
QuoteEndChar	"""
NationalCharSupport	“False”
ODBCGetSchemaSupport	“True”
controlVersionMode
LockingControlType

FoxBase/FoxPro via ODBC

PARAMETER NAME	VALUE	DESCRIPTION
ConnectionString	"DSN=FOXPRO”
DatabaseType	“ODBC”
InitialisationString	""
ConnectionInitializationString	“”
TopPhrase	“False”
QuoteStartChar	""
QuoteEndChar	""
NationalCharSupport	“False”
ODBCGetSchemaSupport	“True”
controlVersionMode
LockingControlType

The Reporting Services connection parameters are defined in the Reporting Services section later in this document Security Issues using DSN’s Whenever the .NET framework needs to access the settings for a “DSN” it is necessary for it to access the Systems Registry to do so. The systems registry supports permission in a similar way to the file system. Make sure that the following entries have at least read access permission for the process running the .NET framework.

If they are not correctly setup you will get DSN not found errors during connection.

The critical entries for this are:-

HKEY_LOCAL_MACHINE\SOFTWARE\ODBC and its subkeys and HKEY_CURRENT_USER\Software\ODBC and its subkeys

Sections below currently not used

  <!-- Example connection methods -->
	<!--<NOT_USED> 
    <Rapid
			ConnectionString="DRIVER={MERANT 3.60 32-BIT Progress SQL92 v9.1D};UID=sysprogress;DB=rapdpoc;PORT=27000;HOST=bigone;PWD=password;"
			DatabaseType="ODBC"
			ConnectionInitializationString = "set schema 'pub'"
			InitialisationString = ""
			TopPhrase="false"
			QuoteStartChar='"'
			QuoteEndChar='"'
			NationalCharSupport="false"
			ODBCGetSchemaSupport="true"/>
    <fastNet
			ConnectionString="Initial Catalog=DC020305;Data Source=bigone;user id=sa;password=sa"
			DatabaseType="MSSQL"/>
    <impactxp
			ConnectionString="DRIVER={MERANT 3.60 32-BIT Progress SQL92 v9.1D};UID=sysprogress;DB=imp2000;PORT=25010;HOST=bigone;PWD=sysprogress;"
			DatabaseType="ODBC"/>
    <impactxp
			ConnectionString="DRIVER={MERANT 3.60 32-BIT Progress SQL92 v9.1D};UID=sysprogress;DB=imp2000;PORT=20000;HOST=localhost;PWD=sysprogress;"
			DatabaseType="ODBC"
			ConnectionInitializationString = "set schema 'pub'"
			InitialisationString = ""
			TopPhrase="false"
			QuoteStartChar='"'
			QuoteEndChar='"'
			NationalCharSupport="false"
			ODBCGetSchemaSupport="true"/>
    <xpint
			XPIntConnectionString="DRIVER={DataDirect 4.2 32-Bit OpenEdge SQL v10.0A};UID=sysprogress;DB=xpint;PORT=16002;HOST=devserver;PWD=sysprogress;"
			DatabaseType="ODBC"/>
  </NOT_USED> -->       
	<application 
		DebugLevel="0"
		DebugMode="0"
		BLOBbuferSize="50000"
		BusinessObjectNameClass=""
		checkmessages=""
		NewMessageText="New Messages"
		WindowTitle="Agility 7.2"
		DefaultFormState="Enquire"
		ObjectsTimeoutMinutes="50"
		TemporaryLoginOn="true"
		AutoLoginUsingWindowsLogin="false"
		LDAPPath="LDAP://LDAPSERVERNAME/DC=softsol,DC=com"
		ADProfileRule="SUBSTRING(USERINFO('emailaddr'),INDEXOF(USERINFO('emailaddr'),'@')+1,STRLEN(USERINFO('emailaddr'))-(INDEXOF(USERINFO('emailaddr'),'@')+1))"
		ADUserName=""
		ADEncryptedPassword=""
		ADPassword=""
		DefaultThemePath = "AgilityFresh"	
		IsEditableAdminMenu="0"
		GoogleClientID=""
		GoogleApiKey=""
		AllowOnlyUniqueRelations="false"
		ChartDataCachingEnabled="false"
		ChartDataTimeoutMinutes="0"
		DeleteRequestLogOlderThanDays="10"
		ShowRequestLicense="false"
		RequestLoggingEnabled="true"
        FormDefaultsCalculationOrder="RowNum,ColNum,ElementID"
        MobileFormsAutodetection="false"
	>
	<!-- Active Directory Settings -->

The application section details the additional parameters needed by the framework.

PARAMETER NAME	VALUE	DESCRIPTION
DebugLevel	“0”	Obsolete setting, no longer used within the Agility application. IT can be safely removed from the config file
DebugMode	0 or 1	0 – debug mode off 1 – debug mode on. When DebugMode is on, Agility application will log all requests made in the file APP_INSTALL_PATH\Styles\Request.txt. Each requests contains following values: 1. Date and Time of the request 2. Host name of the request originator 3. Time of the request processing – in miliseconds 4. Rquest URL Warning!!! – needs to be used with extreme caution as the log file size is not maintained by the application and it can easily grow to a huge size – it is only provided for temporary diagnostic actions. On Normal production environment it should always be set to 0.
BLOBBufferSize	50000
BusinessObjectNameClass	“”	Specialisation Class Name for
checkMessages	“”	set to "1" means that the system will check messages during open session and automatically display notification
NewMessageText	“New Messages”
WindowTitle	“FASTNet Development System”	Title of main application window
DefaultFormState	“Enquire” or “Change”	Defines the value of the “system” state used in change forms. Any form which has its initial state set to “system” will be opened in this mode if user permissions allow. If this parameter is not defined “Enquire” mode will be assumed. ObjectsTimeoutMinutes As required Any instance of a Business object, will be deleted if it has been inactive for this period of time. This should be set to a reasonably high value to avoid unwanted side effects(e.g. 60 minutes).
BaseSystemUrl	“http://FastNet/DemoSystem/”	When an email is sent from the system with a hyperlink back to the system this is the URL prefix which will be used. If this field is omitted then the Servers real IP will be used. However if the server is behind a firewall it may not be accessible by external users. This field should contain the “URL” by which ALL user can access the server. BaseSystemUrl is additionally used by Backgound and Generic Interfaces if it not exists or is empty then url is taken from: "background/EventProcess/AgilityURL"
TemporaryLoginOn	“false” or “true”	If set to true, system will allow users with password generated by the maintenance program to logon with Design privileges even if the license does not include design module. This has been provided as a way of doing remote customization by support team.
AutoLoginUsingWindowsLogin	“false” or “true”	If this option is set to “true” and authentication mode in web.config file is set to “Windows”, the user can automatically log into the system as windows domain or active directory user.
LDAPPath	Syntax: “LDAP://CN=<group name>, CN = <users>, DC = <Domain Component>, ….” Example: “LDAP://192.168.1.96/CN=wisdom, CN=jac”	A LDAP path of the machine which controls active directory within the domain.
ChartDataCachingEnabled	“false” or “true”	Allows the mechanism of caching data used to produce KPI charts to be enabled or disabled. Default is “false”
RequestLoggingEnabled	“false” or “true”	Allows the mechanism of logging usage statistics to be enabled or disabled. Default is “true”, meaning the request statistics logging is enabled.
GoogleApiKey	String key value	This key is used only when GoogleClientID is not defined (or empty) To create your API key, visit the APIs Console at https://code.google.com/apis/console and log in with your Google Account.
GoogleClientID	String Client ID	To access the special features of Google Maps API for Business, you must provide a client ID when accessing any of the API libraries or services. When registering for Google Maps API for Business, you will receive this client ID from Google Enterprise Support. All client IDs begin with a gme- prefix. To register particular domain check google documentation: https://developers.google.com/ maps/documentation/business/guide

If using AD, you can specify server parameters here

 
 <!--  
    <ADIntegration
	LDAPPathFormat = "LDAP://{0}"
	WithFormsAuthentication = "0"
	AuthenticationType = "Secure"
        UseADForGeneralInterface="false" >
    </ADIntegration>	

 -->

Sample config:

            <ADIntegration
			LDAPPathFormat = "LDAP://SOFTSOLDEV/DC=softsoldev,DC=local"   
			WithFormsAuthentication = "1"
			AuthenticationType = "Secure"
                        UseADForGeneralInterface="true">
	   </ADIntegration>

Exchange integration section

	<!-- Possible values of version Microsoft Exchange Server:
       	Exchange2013
       	Exchange2010_SP2
	Exchange2010_SP1
	Exchange2010
	Exchange2007_SP1 -->
  <msexchange
    enabled="false"
    server=""
    username=""
    password=""
    domain=""
    version="">
  </msexchange>

Sample config:

     <msexchange
       enabled="true"
       server="https://192.168.1.1/EWS/Exchange.asmx"    'Exchange webservice adress
       username="agilityuser"
       password="agilityuserpass"
       domain="softsoldev.local"
       version="Exchange2013">
     </msexchange>

Default language / Culture / Phrases collect section

	<language
	  TranslateEnabled = "false"
	  CollectNewPhrases = "false"		
	  DefaultLanguageCode="English"
	  DefaultCultureName="en-gb"
	  SetLanguageFromRequest="true"
	  SetCultureInfo="true"
	  SetNumberFormatInfo="false">
	</language>

Language SubSection The language sub section contains the additional information required by the FastNET ASP framework.

PARAMETER NAME	VALUE	DESCRIPTION
TranslateEnabled	“true” or “false”	Strings will be translated as they are used. Setting to “false” turns off all translation.
CollectNewPhrases	“true” or “false”	As strings are being used within the application they will be created in the “translation database” if they don’t already exist.
DefaultLanguageCode	“English” code one of languages defined in FastNET.	This is the language which will be used prior to a user logging into the system. Once a user has logged in, the Users preferred language will be used.
DefaultCultureName	"en-GB"	The culture names follow the RFC 1766 standard in the format "<languagecode2>-<country/regioncode2>", where <languagecode2> is a lowercase two-letter code derived from ISO 639-1 and <country/regioncode2> is an uppercase two-letter code derived from ISO 3166. If no Culture has been defined for the user and Culture is not set with request (SetLanguageFromRequest = "false") then DefaultCultureName will be used.
SetLanguageFromRequest	“true”	If no language has been defined for the user. The system will interrogate the Browser to find out the language in which it is operating and use this value in preference to the default specified above.
SetCultureInfo	“true”	If this option is set to true then the standard country settings matching the language selected above are used to control date formats, day names, month names etc. If it is false then the server Culture Information based on its default settings are used.
SetNumberFormatInfo	“false”	If this option is set to true then the standard country settings matching the language selected above are used to control number formatting and currency displays etc. If it is false then the server Culture Information based on its default settings are used.
TranslationTimeout		Optional parameter available in version v8 and above. Translate critical section blocking timeout (in milliseconds). If during translate thread is blocked for time longer than timeout then such translation is skipped. Tuning this parameter will not affect performance it is available only for internal tuning and to solve potential unexpected issues in unusual environments.

Language selection flowchart
The flowchart below shows the decision tree that Agility is doing based on language parameters settings to determine the language to assign for the active user session

Culture selection flowchart
The flowchart below shows the decision tree that Agility is doing based on language parameters and user profile settings to determine the Culture Information to assign for the active user session

External Business Assemblies section

	<externalbusinessassemblies>
	  <agility name="Agility"/>

	</externalbusinessassemblies>		
	<ObjectNameMappings>
	 <!--
         <RAAMP nameClass = "RAAMP" originalName = "DataBO.ProcessMngt.JobBO" specializedName="Bespoke.RAAMP.JobBO"/>
         -->
	</ObjectNameMappings>

Help section

  <help
	HelpBaseURL="http://MARCINZ/Agility7213Help" 
	DefaultFormHelp="default.htm" 
	MainMenuHelp="default.htm" 
	LoginHelp="_d2h_ctxt_help.htm?contextID=3002&mode=1">
  </help>

The help section contains the additional information required by the FastNET ASP framework to decide the location of the help files.

PARAMETER NAME	VALUE	DESCRIPTION
HelpBaseUrl	As required	URL address prefix for all help within the system.
DefaultFormHelp	As required	As required. This help will be used where no help has been specifically added to a form
MainMenuHelp	As required	As required. If this link is present a “Help” Icon will be displayed at the bottom of each users menu.
LoginHelp	As required	As required. If this link is present a “Help” Icon will be displayed on the system login page .

Reporting Services config section

	<!-- reporting settings, for server based reporting set mode="server" and remove "local" -->
	<reports 
	 mode="local"
	 username="rsUSR"
	 pass="rsusr"	
	 domain=""
	 BaseWebServiceURL="http://MARCINZ/ReportServer$SQLSERVER2008R2/reportservice.asmx" 		
	 AuthenticationMethod="windows"
	 ReportDataAccess=""
	 DebugRDLfullname=""
	 EventLogSwitch="ON"
	 TopLevelDirectory="Agility"
	 MainTableView="MainTableView">
	</reports>
	<datasources>
	  <Reports_SXP ConnectionString="Initial Catalog=Agility51Live;Data Source=MARCINZ\SQLSERVER2008R2;user=agilityuser;password=ag1l1tyuser"/>	
	</datasources>

Empty row

	<emptyRowDef
	 text="( NULL )"
	 scantext="(empty)"
	 value="">
	</emptyRowDef>

Empty Row Display Sub Section This parameter emptyRowDef controls the way that empty or null rows are displayed on the screen.

PARAMETER NAME	VALUE	DESCRIPTION
text	“(NULL)”	The string which will be used to represent a Null value.
scantext	“(empty)”	The string which will be used to identify a blank time.
value	“”

Event Logging Section

	<eventlog 
	 enabled="1"	
	 machineName="." 
	 logName="FastNet" 
	 sourceName="Agility7213Live" 
	 LogFile="">
	 <information	enabled="0"	withstack="Deny"/>
	 <warning	enabled="0"	withstack="Always"/>
	 <error		enabled="1"	withstack="Always"/>		
	</eventlog>

This parameter eventlog controls the writing of error / logging or debug messages into the system event log.

PARAMETER NAME	VALUE	DESCRIPTION
enabled	“1”	Logging enabled = “1” disabled = “0”.
machineName	“AsRequired”	The name of the machine where the event log will be written.
logName	“AsRequired”	The name of the event log which will be used. If not present it will be created.
sourceName	“AsRequired”	The name which will be used as the “source” for the event log entries.
LogFile	“”

Within the eventlog section it is possible to specify the event logging required at the different error levels – information, warming and errors.

PARAMETER NAME	VALUE	DESCRIPTION
tag	“error” or “information” or “warning”	Logging level
enabled	“1”	Logging enabled = “1” disabled = “0”.
withstack	“Deny” or “Allow” or “Always”	Controls the inclusion of the detailed “Stack” information with the Error in the Log File. “Deny” = Never included “Always” = Always add for every error. “Allow” = Inclusion of the “stack” information is controlled by the program producing the error.

License File Location SubSection

	<!--			
		<license 
                  LicenseFilePath=".\license.signed.xml">
		</license>
	-->
	</application>

The license section contains details of the location of the System’s license file. If this location is invalid or the contents of the license file are invalid the system will not start up until the error is corrected. See section on licensing.

PARAMETER NAME	VALUE	DESCRIPTION
LicenseFilePath	“AsRequired”	The location of the license file. This must be readable by the ASPNET framework.

Interface Sections

This sections defines parameters of system interfaces.

	<interface>		<!-- Customer specific settings -->
	<!--<procurment
			IsEnabled="False"
			SiteCode="SITECODE"
			WSUrl="http:\\Webservice\goeshere\generalinterface.asmx"
			WSUser=""
			WSPassword=""
			CProUser=""
			CProPassword="admin"
 		/>-->
  <!--<xpint
			XpintImportEnabled="1"
			CPY="train">
   	  </xpint>-->
	<!--<AgilityService
			AgilityWS="http://MARCINZ/AgilityService.asmx"
			LocalAgilityWSUserName="admin"
			LocalAgilityWSUserPass="admin">
		  </AgilityService>-->
    <!--<homehotline
			HomeHotlineWS="http://bigone/HHWS/HHWS.asmx"
			LocalWebServiceClientIP=""
			LocalWebServiceUserName="ACA0101"
			LocalWebServiceUserPass="ACA0101"
			BusinessUserName="hhl"
			BusinessUserPass="">
    </homehotline> -->

GeneralImport Interface Sections

General import defines parameters used by general import subsystem.

	<GeneralWebService
			enabled="true"
			RemoveLogAfterDays="1"
			RemoveAllLogAfterDays="5"
			receiver="false"
			sender="false"
			CompatibleWithVersion="current"
			userName=""
			userPass=""
	/>
	<GeneralImport
			ImportWebServiceEnabled="true"
			DefaultUser=""
			DefaultUserPass=""
			WebServiceLocation="http://MARCINZ/Services/GeneralImport.ashx"
		  	DataChangedByAnotherUserRetryCount="5"
			ADIntegration="false"
	/>

PARAMETER NAME	VALUE	DESCRIPTION
ImportWebServiceEnabled	“true”	Enables General Import
DefaultUser		Default user used for process import. Used if other login not used.
DefaultUserPass		Default user password
WebServiceLocation		URL of system used during generation WSDL definition as a service location.
DataChangedByAnotherUserRetryCount	“5”	Defines number of retries when trying to import the record.

GeneralExport Interface Sections

  <!-- General Export Configuration -->
	<!--
        GeneralExport:
          QueueProcessEnabled=[true, false]
          HandleExportEvents=[true, false]
          AcceptAllCertifications=[true, false]
          SecurityProtocol=[Auto, Ssl3, Tls]
          Warnig! AcceptAllCertifications & SecurityProtocol are static properties for whole application. 
          They will affect any request created in agility.
        
    -->		
	<GeneralExport
		QueueProcessEnabled="true"
		HandleExportEvents="true"
        AcceptAllCertifications="false"
        SecurityProtocol="Auto"
	/>

General import defines parameters used by general import subsystem.

PARAMETER NAME	VALUE	DESCRIPTION
QueueProcessEnabled	“true”	Enables General Export queue processing.
HandleExportEvents	“true”	Enables creation of export queue items
NumberOfThreads	“5”	Number of concurrent threads processing single queue.

Sharepoint integration section

    <sharepoint
      enabled="false"
      server=""
      username=""
      password=""
      domain=""
      version="">
    </sharepoint>

  </interface>

Sharepoint sample config:

    <sharepoint
      enabled="true"
      server="http://dev-sh2k13:8001"
      username="agilityuser"
      password="agilityuserpass"
      domain="softsoldev"
      version="2010">
    </sharepoint>

Background Process Section

The background section details the additional parameters needed by the background process to the events queued in the execution stack within the Framework database.

  <background>
    <EventProcess
	EventsEnabled="true"
	EventsPoolTime="10000"
        EventRetryMinutes="60"
        StatusFlowEnabled="true"
        StatusFlowPoolTime="10000"
	userName="system"
	userPass="system"
        DataChangedByAnotherUserRetryCount="5"
        DisableMainRecordLockOnSave="false"
      >
    </EventProcess>

EventProcess

PARAMETER NAME	VALUE	DESCRIPTION
EventsEnable	“true”	If this parameter is set to “true” the process for background events from syEvent table will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
EventsPoolTime	“10000”	Poll interval in milliseconds for the syEvent processing. It specifies how long the process will sleep after processing all events before checking for new events again.
EventRetryMinutes	"60"	When some event has not been completed successfully background process will retry processing the event after EventRetryMinutes time.
StatusFlowEnabled		If this parameter is set to “true” the process for status flow events will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
StatusFlowPoolTime	“10000”	Poll interval in milliseconds for the status escalation processing. It specifies how long the process will sleep after processing all events before checking for new events again.
username	“AsRequired”	The framework user name which will be used to establish the Security to be applied to the Business Object being run by the background Process
userPass	“AsRequired”	Password for the above user.
DataChangedByAnotherUserRetryCount	“5”	Status flow engine can retry operation in case the data is changed by another user. This parameter defines maximum retry count.
NumberOfThreads	“10”	Status flow engine can process multiple records from single flow in parallel. This parameter defines how many concurrent threads are used for each flow.
AgilityURL	“http://server.com/Agility”	Used by background (for generation urls to system). It is used only when application/BaseSystemUrl parameter is not defined.

     <exportimport
        LogMaxSize="3000"
      >
    </exportimport>

HistoryMaintenance

    <HistoryMaintenance Enabled="True" Interval = "30">
		<StatusFlowLog
		 Enabled = "true"
		 LogMaxSizePerObject = "100"
		 DeleteTopXPerBatch = "1000"
		 DeleteTopXPerLoop = "250"
                 DelayLength = "00:00:00"/>
	
  	        <RequestLog
		 Enabled = "true"
		 OlderThanDays = "1"
		 DeleteTopXPerBatch = "1000"
		 DeleteTopXPerLoop = "250"
                 DelayLength = "00:00:00"/>
				
			<GeneralInterfaceQueue
				Enabled = "true"
				RemoveLogAfterDays = "1"
				RemoveAllLogAfterDays = "5"
				DeleteTopXPerBatch = "1000"
				DeleteTopXPerLoop = "250"
                                DelayLength = "00:00:00"/>
				
			<ImportExportQueue
				Enabled = "true"
				RemoveLogAfterDays = "1"
				RemoveAllLogAfterDays = "5"
				DeleteTopXPerBatch = "1000"
				DeleteTopXPerLoop = "250"
                                DelayLength = "00:00:00"/>

			<ImportExportLog
				Enabled = "true"
				RemoveLogAfterDays = "1"
				RemoveAllLogAfterDays = "5"
				DeleteTopXPerBatch = "1000"
				DeleteTopXPerLoop = "250"
			        DelayLength = "00:00:00"/>

				
			<AuditLog
				Enabled = "false"
				OlderThanDays = "7"
				DeleteTopXPerBatch = "1000"
				DeleteTopXPerLoop = "250"
                                DelayLength = "00:00:00"/>
		</HistoryMaintenance>
  </background>

The element defines globally settings of History Maintenance. The all child elements are dependent on its setting.

PARAMETER NAME	VALUE	DESCRIPTION
Enabled	“true”	If this parameter is set to “true” the history maintenance process for background will run whenever the service running it is started. Setting this parameter to “false” will mean that the process and its child processes will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
Interval	"30"	Number of seconds represents a time interval (duration of time or elapsed time) between deletion process is executed.

GeneralInterfaceQueue The child element of HistoryMaintenance main node. It controls deleting process of obsolete syGeneralInterfaceQueue records.

PARAMETER NAME	VALUE	DESCRIPTION
Enabled	“true”	If this parameter is set to “true” and the history maintenance process for background is enabled will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
RemoveLogAfterDays	"1"	It determines the number of days which have to be left after the processed records will be deleted. The records in status 'Queued', 'Busy', and "Error' will be omitted. Default value of this parameter is set on 1 day.	RemoveAllLogAfterDays	“5”	It determines the number of days which have to be left after the all records will be deleted. The queue status will not be taken into account. Default value of this parameter is set on 5 days.
DeleteTopXPerBatch	“1000”	It controls total number of records which are taken into account during deletion process per one background process call. Default its value is set on 1000.
DeleteTopXPerLoop	“250”	It controls the total number of records which are processed per batch loop. Default value of this parameter is set on 250. It means, if DeleteTopXPerBatch is set to 1000 and DeleteTopXPerLoop is set to 250, you will get in total 1000 deleted records, 250 per each batch loop.
DelayLength	“00:00:00”	Is the specified period of time that must pass, up to a maximum of 24 hours, before execution of a next delete loop. It is the period of time to wait. Default value is set on 00:00:00. It means that there is no delay.

StatusFlowLog

The child element of HistoryMaintenance main node. It controls deleting process of archival records from syStatusFlowLog data table.

PARAMETER NAME	VALUE	DESCRIPTION
Enabled	“true”	If this parameter is set to “true” and the history maintenance process for background is enabled will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
LogMaxSizePerObject	"60"	It controls how many records per status flow object needs to be preserved from deletion. Default, value of this parameter is set on 100. It means, that the 100 of the newest records per Status Flow Object is preserved from deletion.
DeleteTopXPerBatch	“1000”	It controls total number of records which are taken into account during deletion process per one background process call. Default its value is set on 1000.
DeleteTopXPerLoop	“250”	It controls the total number of records which are processed per batch loop. Default value of this parameter is set on 250. It means, if DeleteTopXPerBatch is set to 1000 and DeleteTopXPerLoop is set to 250, you will get in total 1000 deleted records, 250 per each batch loop.
DelayLength	“00:00:00”	Is the specified period of time that must pass, up to a maximum of 24 hours, before execution of a next delete loop. It is the period of time to wait. Default value is set on 00:00:00. It means that there is no delay.

RequestLog

The child element of HistoryMaintenance main node. It controls deleting process of archival records from syRequest, syRequestLog and sySession data tables.

PARAMETER NAME	VALUE	DESCRIPTION
Enabled	“true”	If this parameter is set to “true” and the history maintenance process for background is enabled will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
OlderThanDays	"7"	It controls how many days need to be left before records will be deleted. Default, value of this parameter is set to 7. It means, that the all records which are older than 7 days will be deleted.
DeleteTopXPerBatch	“1000”	It controls total number of records which are taken into account during deletion process per one background process call. Default its value is set on 1000.
DeleteTopXPerLoop	“250”	It controls the total number of records which are processed per batch loop. Default value of this parameter is set on 250. It means, if DeleteTopXPerBatch is set to 1000 and DeleteTopXPerLoop is set to 250, you will get in total 1000 deleted records, 250 per each batch loop.
DelayLength	“00:00:00”	Is the specified period of time that must pass, up to a maximum of 24 hours, before execution of a next delete loop. It is the period of time to wait. Default value is set on 00:00:00. It means that there is no delay.

ImportExportLog

The child element of HistoryMaintenance main node. It controls deleting process of obsolete syImpExpLog records.

PARAMETER NAME	VALUE	DESCRIPTION
Enabled	“true”	If this parameter is set to “true” and the history maintenance process for background is enabled will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
RemoveLogAfterDays	"1"	It determines the number of days which have to be left after the processed records will be deleted. The records in Completed state will be taken into account. Default value of this parameter is set on 1 day.
RemoveAllLogAfterDays	“5”	It determines the number of days which have to be left after the all records will be deleted. The Completed state will not be taken into account. Default value of this parameter is set on 5 days.
DeleteTopXPerBatch	“1000”	It controls total number of records which are taken into account during deletion process per one background process call. Default its value is set on 1000.
DeleteTopXPerLoop	“250”	It controls the total number of records which are processed per batch loop. Default value of this parameter is set on 250. It means, if DeleteTopXPerBatch is set to 1000 and DeleteTopXPerLoop is set to 250, you will get in total 1000 deleted records, 250 per each batch loop.
DelayLength	“00:00:00”	Is the specified period of time that must pass, up to a maximum of 24 hours, before execution of a next delete loop. It is the period of time to wait. Default value is set on 00:00:00. It means that there is no delay.

AuditLog

The child element of HistoryMaintenance main node. It controls deleting process of obsolete syAudit and syAuditLine records of sxp database.

PARAMETER NAME	VALUE	DESCRIPTION
Enabled	“false”	If this parameter is set to “true” and the history maintenance process for background is enabled will run whenever the service running it is started. Setting this parameter to “false” will mean that the process will never run when the service is started. If it is required to suspend the process once it has been started then the service itself should be stopped.
OlderThanDays	"7"	It controls how many days need to be left before records will be deleted. Default, value of this parameter is set to 7. It means, that the all records which are older than 7 days will be deleted.
DeleteTopXPerBatch	“1000”	It controls total number of records which are taken into account during deletion process per one background process call. Default its value is set on 1000.
DeleteTopXPerLoop	“250”	It controls the total number of records which are processed per batch loop. Default value of this parameter is set on 250. It means, if DeleteTopXPerBatch is set to 1000 and DeleteTopXPerLoop is set to 250, you will get in total 1000 deleted records, 250 per each batch loop.
DelayLength	“00:00:00”	Is the specified period of time that must pass, up to a maximum of 24 hours, before execution of a next delete loop. It is the period of time to wait. Default value is set on 00:00:00. It means that there is no delay.

Mail Server Section / email notifications

The mail section details the additional parameters needed by the system to communicate with a SMTP server within the enterprise. The SMTP server included with WINDOWS 2003 server or the version shipped with XP may be used for this purpose.

  <mail
	smtpServer="" 
        smtpServerPort="587" 
        smtpUserName=""
        smtpUserPassword="" 
        smtpUseSSL="FALSE" 
        sender="EMAILSENDER"
        alternativeMail="true"
	smtpTimeoutSeconds="30">
  </mail>

Incab section - currently not used

  <!--
	Incab 
	   Mode: [Disabled | Client | Provider ] 
	   
	   Parameters: 
		  Labour,WSUrl,WSUser,WSPassword,GIFastNetUser,GIFastNetPassword
		  are required only in 'Client' mode.
  -->

  <Incab
 	Mode = "Disabled"
 	Labour="Emp0001"
	 WSUrl="http://localhost:1298/Web/Services/GeneralInterface.asmx"
	 WSUser=""
	 WSPassword=""
	 GIFastNetUser="admin"
	 GIFastNetPassword="admin"
  />

GPS Section

The GPS section details the additional parameters needed to get data from GPS device and to use converter which can calculate coordinates between six different systems of coordinates.

  <GPS
       Enabled="true"
       Simulator="true"
       PositionChangedMargin="0.005"
       PositionChangedSecondsInterval="2"
       MovementStoppedMargin="0.1"
       ComunicationPort="COM13"
       ComunicationBaudRate="4800"
       Area="Great Britain"
       SystemCoordinateType="cartesian"
       GPSReadType="geodetic"
       DataPath="C:\artura\vs2005proj\FastNET2Artur\Common\Utilities\"
       UTMZone=""
       VertDatum="">
  </GPS>

PARAMETER NAME	VALUE	DESCRIPTION
smtpServer		The name or URL or IP address of the SMTP server which is to be used for outgoing mail.
smtpPort	587	The port which the SMTP server is using. Normally this will be 587. If you want use SSL you should change port to 465
smtpUserName		Only required if the SMTP server requires “user” authentification before sending mail
smtpPassword		Only required if the SMTP server requires “user” authentification before sending mail
smtpUseSSL	“false”	Set to true if the Mail Server communications must be performed using the SSL layer.
sender		“Framework &lt SenderID@Sitename.com >” The “sender” information displayed in the “from” box on most email systems. &lt and &gt are < and >
alternativeMail	“true”	Set to true if the Mail Server communications should use alternative library to send mails.
smtpTimeoutSeconds	“30”	Set to 30 if smtp sender will wait before stop sending email to receiver.

PARAMETER NAME	VALUE	DESCRIPTION
ComunicationPort	“COM11”	Name of serial port which will be used to connect to GPS device.
Area	“Great Britain”	The area for which coordinates should be converted. The converter supports three areas: Great Britain, Northern Ireland and Republic of Ireland.
SystemCoordinateType	“geodetic”	The system of coordinates which is used on system( Agility, Incab). The six values can be set: UTM, OSGB36, Irish Grid, Irish Transverse Mercator, Geodetic, Cartesian.
GPSReadType	“OSGB36”	The system of coordinates which can be used to set type of input coordinates for converter. The same values can be set as for SystemCoordinateType.
DataPath	“C:\GPSData”	The relative or absolute path to folder where stored is file GIQ60.dat used by converter.
UTMZone	“30”	The UTM system of coordinates needs Zone number to calculate position. This parameter can store system UTMZone.
VertDatum		The Irish systems of coordinates needs additional information to make calculation. Accepted values: Newlyn, ScillyIsles, IsleMan, OuterHebrides, StKilda, Shetland,Orkney, FairIsle, Flannans, NorthRona, SuleSkerry, Foula, MalinHead, Belfast.

FileConvert Section

The FileConvert section details the additional parameters needed by the system to add conversion different types of attachment documents to pdf. Each sub section of FileConvert describes separate converter and its abilities.

	-->
 	<FileConvert WaitForExit="10000">
		<MigraDocConv>
		<pdf 
				ConvertFrom="txt; bmp; emf; exif; gif; ico; jpeg; jpg; png; tif; wmf" 
				FontEmbedding="false"
				FontSize="10pt"
				FontName="Lucida Console"
				PageFormat="A4"
				Orientation="Portrait"
			/>
		</MigraDocConv>
    <!--
		<CmdLinePdfConv Path="D:\Agility\Agility2.9.5\LiveSystem\bin\Others\TxtToPDF" BaseCmdLine="{in} {out}">
			<pdf ConvertFrom="txt"/>
		</CmdLinePdfConv>

		<Convert_Doc Path="C:\Program Files\Softinterface, Inc\Convert Doc\ConvertDoc.exe">
			<pdf ConvertFrom="doc; html; rtf; txt" />
		</Convert_Doc>

		<Convert_ITP Path="c:\Program Files\Softinterface, Inc\Convert Image To PDF\ConvertITP.exe">
			<pdf ConvertFrom="bmp; ico; jpeg; gif; koa; lbm; pcd; pcx; png; ras; tga; tif; psd" />
		</Convert_ITP>
    
		<Total_Excel_Converter Path="C:\Program Files\TotalExcelConverter\ExcelConverter.exe">
			<pdf ConvertFrom="xls" />
		</Total_Excel_Converter>
    
		<Document2PDF Path="C:\Program Files\Two Pilots\Document2PDF Pilot 2.2 TRIAL\Document2PDF_Pilot.exe">
			<pdf ConvertFrom="doc; xls"  />
		</Document2PDF>
    -->
	</FileConvert>

PARAMETER NAME	VALUE	DESCRIPTION
WaitForExit	10000	If file converter is external application then this is maximal time in [ms] allowed for conversion. If conversion consumes more time then converter process is terminated.

MigraDocConv, FileConvert Sub Section

Internal pdf converter embedded with FastNet. It allows conversion plain text file and several graphic file formats to pdf.

PARAMETER NAME	VALUE	DESCRIPTION
ConvertFrom	"txt; bmp; emf; exif; gif; ico; jpeg; png; tif; wmf"	Semicolon separated file types supported by converter.
FontEmbedding	“False” or “True”	If “True” then font will be Embedded to pdf document.
FontSize	“10pt” or as required	Font size by default 10pt.
FontName	“Lucida Console"	or one of System Installed Fonts.
PageFormat	"A4" or A0…A5, B5, Ledger, Legal, Letter.
Orientation	"Portrait" or “Landscape”

CmdLinePdfConv, FileConvert Sub Section

Allows to define command line parameters for external conversion tool.

PARAMETER NAME	VALUE	DESCRIPTION
ConvertFrom	“doc” or files supported by tool.	Semicolon separated file types supported by converter.
BaseCmdLine	“[path to converter]\[converter.exe] {in} {out}”	During conversion {in} will be replaced with source file, {out} will be replaced with destination (output) file

Timezone section

	<!--
	<timezone
		LocalTimeInDatabase="True"
		TimeZoneName="Central European"
		DaylightTimeZoneName="Central European Daylight"
		UTCOffset="120"
		DaylightStart="01/01/2003"
		DaylightEnd="01/06/2003"
		DaylightOffset="60">
	</timezone>
	-->
 	<!-- Licensing Options -->
 	<!--
	<AgilitySupport>
			<Licensing 
				SignLicenseFile="" 
				LicensingWebService="" 
				LicensingWWW="" 
				LicensingMail=""
			/>




	</AgilitySupport>
	-->
</configuration>