This section contains general settings required for IEE configuration. You will configure user interface settings, select your default locale for localization, security settings, define your data directories, and more.
- Audit Log
Audit Logging Mode
Determines whether IEE logs all actions, no actions, or all actions other than changes made through an XML file or through a web service call.
Number of Audit Entries to Display Without a Warning
Defines the maximum number of audit entries to display in the Edit Log user interface without returning a warning. Enter a whole number. When using a broad query that does not include a specific service point and service point channel, IEE can return a large number of results. Use this value to limit the number.
- Data DirectoriesDuring installation, IEE creates a Base Data directory, an Import directory, and an Export directory. These directories hold data files for imports and exports, as well as backup files and error logs. IEE also creates macros that point to these file paths, which you can use wherever you need to indicate the file paths. If the directories change, you only have to update them once; the macros always point to the paths you indicate in system settings. Specify the paths for the following data directories:
Important! It is possible to install IEE into a directory other than C:\Program Files. The installer creates the Data directory within the Itron\Enterprise Edition file path, and the Import and Export directories within the Data directory where IEE is installed.
Base Data Directory ($ItronData)Defines the parent location for all export and import directories. You must enter a full path. IEE assigns the ($ItronData) to this path. Other paths and fields can use ($ItronData) when referencing this path.
Custom Report Definition Directory
Defines the location that stores Crystal Report (.RPT) files, which define the custom report layouts. Reference as ($CustomReportDefinitionDirectory) when configuring a task.
Event Directory
Defines the location where device events are written after they are received by the AMI process. This directory should match the directory where the Event Import adapter is waiting to process event data.
Event Resubmit Directory
Defines the location where to store device event records when they are imported through the AMI process and have no corresponding configuration. Events are written in IEE Event XML format.
Export Directory
Defines the directory where IEE places the file containing exported data. Accept the IEE default file path or click Search to browse to a directory. This parameter supports the standard IEE macros. Reference as ($ExportDirectory) when configuring a task. Exported data is generated by an export task template or an export API.
Import Directory
Defines the folder that IEE monitors for incoming files. IEE automatically schedules files that arrive in this directory for import. You define the paths to default import directories in the IEE System Administration workbench. When configuring the import directory parameter in an import task template, enter the file path to the directory that IEE monitors for import files specific to this task. This parameter supports standard IEE macros. Reference as ($ImportDirectory) when configuring a task.
Service Mode Shared Directory
Defines the ServiceMode shared network directory.
You can use the following macros for file paths:
Table 52 Macros for file paths($DefaultTaskSystemUserID) | User ID to use when running imports |
($itrondata) | Value of System Setting |
($importdirectory) | ($ItronData)\Import |
($exportdirectory) | ($ItronData)\Export |
($datetime) | Current time as: yyyyMMdd-HHmmss-fff |
($timestamp) | Current time as: yyyyMMdd-HHmmss-fff |
($datetimeedi) | Current time as: yyyyMMddhhmmss |
($taskid) | ID of the current task |
- Database
Command Timeout
Defines the number of seconds to allow database commands issued by IEE to run before they time out and generate an error. Command Timeout is a global setting and not specific to AMI Readings Import. Enter the number of seconds in whole numbers.
- General User Interface
Default Queue User
Defines the default user name for queues.
Help File Name
Defines the path and name of the file containing the IEE Rich Client online help. Typically this is the compiled help that ships with the product. By default, the file name is Itron_Enterprise_Edition.chm.
If you have a custom help file, use this setting to specify the path and name to your help file.
Maximum User Inactive Time
Defines the number of minutes that a user can remain idle before the user is automatically logged off. Enter zero (0) to set no timeout period. Enter the value in whole numbers.
Number of Query Results
Defines the number of rows a query returns when submitted through the search dialog of the IEE Rich Client user interface. Enter a whole number.
Show Title Bar Text
Determines what text displays on the Itron EE product title bar, if any. Type the text that you want to display on the product title bar. The default value is to leave this setting blank; and no text will display on the title bar.
Changes to this setting will not take effect until after the next user login.
Show Title Bar User ID
Determines if the ID of the logged in user displays on the Itron EE product title bar. Set this value to True to display the user ID on the product title bar. Set this value to False to hide the user ID. The default value is False.
Changes to this setting will not take effect until after the next user login.
- Import Data Manager
Banked Data Automatic Resubmit Frequency
Defines the number minutes between the IDM automatic resubmit process for banked data. Set this value to a positive integer.
To deactivate the banked data resubmit process, set this value to 0.
Setting the frequency value too low could have a performance impact on other processes. For more information, see the
Disable Resubmit Process Window for Banked Data system setting.
Banked Data Retention Period in Days
Defines the number of days that banked data is retained. Once this threshold is met, the data files are deleted and the associated database references are purged. Enter a positive integer. The default value is 30.
Note: Setting this threshold too high can result in performance issues with the Banked Data Queue.
Disable Resubmit Process Window for Banked Data
Defines the window of time when the banked data resubmit process will not run in order to save system resources for other critical processes. For example, consider disabling the resubmit process during your data collection window (DCW).
Set this value in the following format 00:00:00-00:00:00 indicating the start and end time for the window.
Disk Space in MB Allocated for Discarded Data
Defines the amount of disk space that is allocated for discarded data. Enter the threshold in megabytes. To store discarded data, enter a positive integer. Enter 0 to not store discarded data. If the discarded files exceed this threshold, the oldest discarded files are permanently deleted. Zero (0) is the default value.
IDM Discard Unmapped UOMs
Determines whether unmapped UOMs should be discarded. Set to True for discard.
IDM Immediate Export Output Time Zone
Determines the time zone that the IDM service will use for the IDM Immediate Export. This is applicable for Data Routing and Monitoring Data Channels. The default value is (GMT) Greenwich Mean Time, no DST.
IDM Maximum File Size
The maximum file size (in megabytes) that the IDM service can manage. Files larger than the maximum file size will be split into separate files using the Template parameter.
IDM Operational Logging Enabled
Determines whether the IDM operational logging is enabled. Select True to enable IEE to log channels into the IDMOperationalLog table that have been routed, exported, discarded, or banked. Select False to disable this parameter.
IDM Reading Data Export Folder
Defines the directory path for reading data that is ready for export. The reading data includes both revenue data that will be imported into IEE after export and monitoring data that is only exported.
Number of Import Data Manager Threads
Defines the number of threads that the Import Data Manager Service uses.
You must define at least one thread. Set this value to achieve optimal system performance. The number of threads is dependent on the size of the files being processed. Setting this value too low can cause bottlenecks while setting this value too high can cause the system to run out of memory or overtax your database. For more information, see AMI reading import (ARI) performance considerations.
The default value is 3. The maximum value is 25.
Processed Import File Retention Period in Days
Defines the number of days that processed import files are retained. Once this threshold is met, the processed import files are deleted and the associated database references are purged. Enter a positive integer. The default value is 10.
Setting this value too high can affect system performance and requires a large amount of disk space to retain the imported files.
- Import Dispatcher
File Open Attempt Timeout
Defines the number of milliseconds that the Import Dispatcher waits for a file-open attempt to succeed.
Minutes Between Task Template Updates
Defines the number of seconds that the Import Dispatcher waits before checking the database for task template updates.
- Itron Enterprise Edition
System Name
Defines a unique identifier for a deployed copy of Itron Enterprise Edition (IEE).
Use this setting to identify the IEE system. It is exported in some of the XML export formats. This helps downstream systems identify the originating system for the data that it receives from IEE.
- Localization
Default Locale
Defines the default cultural and language locale for your IEE system. For example, enter en-US for English United States of America.
Language
Defines the application language. You can select available languages from the dropdown. Only the installed and supported languages, defined in the system, display in the dropdown. For example, for United States English, select en-US.
Supported Locales
Determines the options available for My Settings > Preferences > Regional Settings in the IEE Web Client. Enter a comma-separated list formatted as nn-NN,nn-NN,nn-NN, and so forth. The name of a locale consists of its ISO 639 language code and an ISO 3166 country/region code formatted as nn-NN, where nn is the language code and NN is the country/region code. For example, enter the following:
en-US,en-CA,en-GB
to define the following supported locales:
- Logging
Log Channel URL
Enter the URL where the logging service receives messages. Include the port. For example, tcp://<servername>:<port>/theEndPoint.
Log Events to Queue
Determines whether IEE logs events to queue. Select True to log the events to queue. Select False to disable logging.
Log Service Batch Size
Defines the number of log messages saved in each database transaction.
Log Service Check Frequency in Milliseconds
Defines the number of milliseconds the logging service waits before checking for new messages.
- Rate Engine
Maximum Rate Engine Analysis Period in Days
Defines the maximum number of dates permitted for a rate engine analysis period. Analysis periods exceeding this setting cause an error and are not processed. Enter the value in days.
- Reading Data Access
Boundary Read Tolerance
Defines the maximum number of minutes that IEE searches before the start and after the end of the reading period to find a valid boundary read. Reads that are within the defined tolerance are considered exact reads for boundary read purposes. If the defined tolerance is greater than the interval length, then IEE searches up to the minutes defined in this setting. If the defined tolerance is less than the interval length, then IEE looks forward or back for a read that is within one interval length of the start or end of the reading period. To allow only exact register reads with no tolerance, enter 0 (zero).
Configure this setting to define a window in minutes for IEE to look for an available register read, both forward and backwards from the time stamp.
Example scenario
For example, if the Boundary Read Tolerance is 20 minutes and the interval length is 15 minutes, IEE looks for a boundary read within 15 minutes of the start or end time stamp of the reading period. If more than one read is found within the defined tolerance, then IEE selects the closest read looking forward. In the scenario where you need a start read or end read at 2:00 p.m. and the interval length is 15 minutes, the following example demonstrates how this logic works:
IEE finds reads at the following times:
1:57 p.m.
2:03 p.m.
2:06 p.m.
The read at 2:03 p.m. is selected because it is the closest read to 2:00 p.m. looking forward.
Calculated Read Look Back
Defines the number of days that IEE looks forward or back for a valid register read to use when calculating register reads. This setting is used in the case where IEE cannot find an exact read, the nearest read is not within the Boundary Read Tolerance, and IEE components need to calculate a register read. The calculated read is based on a real register read in the system. To find this register read, IEE searches forward and back in time to the defined number of days. This setting is used to ensure that the system does not incur performance issues by looking backwards and forward an indefinite number of days. Limiting the number of days helps reduce performance issues and also avoids using register reads that may not be as viable as more recent data.
- Reference Data Cache
Enable Reference Data Cache
Determines whether to enable reference data caching mechanism. The reference data cache architecture introduces a uniform mechanism to load and update some types of data into IEE processes. Set this value to True unless otherwise advised by Itron. In the case where this feature introduces issues in a critical system, this setting provides a way to disable the reference data cache while investigating the issue.
- Register Timestamps
Export Register Timestamp Seconds
Determines whether to include the seconds portion of standalone register reads. Select True to enable or False to disable. The default value is False. The Import Register Timestamp Seconds parameter must be True to import seconds.
This setting supports readings in seconds. It is used by customers that keep track of seconds for stand-alone register reads for auditing purposes.
Import Register Timestamp Seconds
Determines whether to retain the seconds of standalone register reads. Select True to retain the seconds of the reading. Select False (default) to discard the reading.
This parameter supports readings in seconds. This is used by customers who track the seconds of stand-alone register reads for auditing purposes.
Caution: Import Register Timestamp Seconds should not be modified except by a system administrator during system installation.
- Reporting
Show Version Confirmation Controls in Reports and Exports
Determine whether uses can filter and sort data by significance (such as billing or load research) and by confirmation (the version of data confirmed as billed by the external billing system). Select True to enable significance and confirmation controls in editing and estimation, interactive graphing, reading group selection, and task templates. Select False to disable this feature.
- Security
Allow Authentication Type Change
Determines whether to allow IEE to override the default authentication type when adding new users or updating existing users. Select True to enable. Select False to disable.
Allow Custom Reports to Use Default DB Credentials
Determines whether the Custom Report template uses the default IEE database credentials when the credentials are not specified on the template.
When set to True, anytime the User Name and Password fields on the Custom Report task parameters are not populated, the custom report template uses the default IEE database credentials. The default database credentials are the credentials that the IEE Rich Client and the application servers use to connect to the IEE database. If you select False, then the credentials must be specified on the custom report template.
There is a security implication in setting this value to True because IEE automatically uses the default DB credentials. You can control access to the system settings by granting access only to administrators, who should only change this setting when warranted by your business process. Similarly, when setting the value to False, the user has to enter the DB credentials on the report template. This may introduce security implications by requiring users to possess knowledge of the DB user/password. On SQL Server deployments this setting is only relevant when not using Windows integrated database authentication.
Allow Only Database Procedures in Custom SQL Adapter
Determines whether the Custom SQL Adapter allows you to specify only database procedures in the command text. Select True to instruct the adapter to analyze the command text when a task runs. If the text contains anything other than a database procedure call, the task fails. Select False to allow any text, including potentially damaging commands. Commands to modify data, such as update, delete, truncate, and insert, pose a security risk.
The Custom SQL adapter is a powerful tool for extending IEE. This setting controls whether anyone configuring the task can execute data modifying commands.
For maximum security set this value to True. Any proposed SQL command can be reviewed by your DBA, approved, and converted into a database procedure.
Background Re-Authentication lnterval
Defines the number of minutes to wait before IEE polls either the IEE database or the Active Directory for re-authenticating users. Use this setting to check whether users were removed, disabled, or unauthenticated while they are still using the application. The value you enter determines the frequency of re-authentication.
Data Level Security Enabled
Determines whether to enable Configuration Data Level Security. Select True to enable. Select False to disable.
Default Authentication Type
Defines the authentication type to use for authenticating a user (ItronIdentity) when they log on. Select Itron or Windows (active directory). Verify that the user is assigned accordingly.
Enable Advanced Security
Determines whether to enable administrative users, using the , to associate user roles with groups. To associate roles with user groups, from the Manage Users window click Save & Next. A second Manager Users window displays where you can associate each role with one or more user groups.
The Advanced Security setting provides a way to create role-group associations and to control the access to different entities (associated with groups) in different functions (associated with roles).
Exceptions to the rule need to be managed by creating a new role that is not associated with groups, by default.
Important! Changing the value from False to True proceeds without warnings. However, changing the value from True to False generates a warning if you have links set up. IEE does not allow you to save the change until you remove these links.
- Web Service
HTTP Port
Defines the HTTP port for internal services. This is the default port to use for TCP endpoints in IEE Web services. Enter a valid port number.
HTTPS Port
Defines the HTTPS port for internal services. This is the default port to use for TCP endpoints in IEE Web services. Enter a valid port number.
TCP Port
Defines the TCP port for internal services. This is the default port to use for TCP endpoints in IEE Web services. Enter a valid port number.