Aveva Log Agent User Guide

AVEVA Licensing Log Agent Configuration Guide
AVEVA Licensing Log Agent Configuration

Guide
Contents Page
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Plan the Log Agent Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Log Agent Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Mandatory INI File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Web-service Transfer Mode Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Pre-Requisite: Installing Microsoft Web Service Enhancements (WSE) 3.0.. . . . . . . . . . . . 3:2
Web-Service Mode INI File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Email Transfer Mode Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Email Mode INI File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Manual Transfer Mode Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Manual Mode INI File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Running the Log Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Running the Log Agent from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Running the Log Agent from the Windows Scheduler . . . . . . . . . . . . . . . . . . . . 4:1
Log Agent INI File Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1
© Copyright 1974 to current year. i 4.0

AVEVA Solutions Limited and its subsidaries.
All rights reserved.
© Copyright 1974 to current year. ii 4.0

AVEVA Licensing Log Agent 4.0
Configuration Guide
AVEVA Solutions Limited
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any special,
indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be suffered by the user,
including any loss suffered by the user resulting from the inaccuracy or invalidity of any data created by the AVEVA
software, irrespective of whether such losses are suffered directly or indirectly, or arise in contract, tort (including
negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the performance
of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under which
the AVEVA software was purchased, the clauses in the software licence shall take precedence.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied with it)
belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document is
commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the prior
written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires that this copyright
notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or electronic form,
without the prior written permission of AVEVA Solutions Limited. The user may not reverse engineer, decompile, copy, or
adapt the software. Neither the whole, nor part of the software described in this publication may be incorporated into any
third-party software, product, machine, or system without the prior written permission of AVEVA Solutions Limited, save as
permitted by law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal
prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms and
conditions of the respective software licences, and in accordance with the relevant User Documentation. Unauthorised or
unlicensed use of the software is strictly prohibited.
© Copyright 2012 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall not be
liable for any breach or infringement of a third party's intellectual property rights where such breach results from a user's
modification of the AVEVA software or associated documentation.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademark
AVEVA™, AVEVA Everything3D™ and AVEVA E3D™ are registered trademarks of AVEVA Solutions Limited or its
subsidiaries. Unauthorised use of the AVEVA™, AVEVA Everything3D™ and AVEVA E3D™ trademarks is strictly
forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its subsidiaries,
registered in the UK, Europe and other countries (worldwide).
3rd Party Software

The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or logo
belongs to its respective owner.
The following 3rd party software is included in some of the AVEVA products contained in this Online Help:
• Based on Teigha® from the Open Design Alliance.
• Microsoft® Office Fluent™ user interface. Fluent is a trademark of Microsoft Corporation and the Fluent user
interface is licensed from Microsoft Corporation. The Microsoft Office User Interface is subject to protection under
U.S. and international intellectual property laws and is used by AVEVA Solutions Limited under license from
Microsoft.
• DevExpress® redistributables are used by AVEVA under license from Developer Express Inc. Copyright © 2000-
2014 Developer Express Inc.
• 3D input device development tools and related technology are provided under license from 3Dconnexion. ©
3Dconnexion 1992 - 2013. All rights reserved.
Revision Sheet
Date Version Comments / Remarks

January 2017 4.0 Initial issue
Introduction
1 Introduction
The AVEVA Log Agent utility is intended for use by customers using the AVEVA Licensing
System (ALS) and who are licensing their software under a pay-per-usage billing
agreement. The Log Agent transfers the license server logs to the AVEVA servers so that
they can be processed and billing reports subsequently generated.
The Log Agent supports three different transfer modes:
1. Web-service
The Log Agent connects to the AVEVA servers and transfers usage-logs. This mode
requires that the license server system has access to the Internet.
2. Email (SMTP)
Many license servers are located on a network without a direct Internet connection, but
do have access to internal email servers. This mode allows usage logs to be sent in
emails via an internal SMTP mail server.
3. Manual Transfer
Some license servers operate in an environment where it is not possible to use either
of the previous transfer modes. In these circumstances, the Manual Transfer mode can
be used. The Manual Transfer mode copies the usage-log files into a directory outside
of the license server environment where they can be collected by the customer and
transferred to AVEVA using any method agreed with the AVEVA License Administrators
(For example, USB stick in the post, manually emailed to AVEVA).
Note: The customer is responsible for maintaining the directory that the Log Agent
transfers the usage-logs into.
All transfer modes will effectively remove a usage log from the license server operating
environment so that duplicates will not be sent to AVEVA.
Note: The customer is responsible for ensuring that usage-logs are not removed or
tampered with before they are sent to AVEVA.
© Copyright 1974 to current year. 1:1 4.0

Introduction

Plan the Log Agent Configuration
2 Plan the Log Agent Configuration
Before configuring the Log Agent system it is recommended that you follow the steps below:
1. Choose a transfer mode.
This may involve conversations with your System/Network Administrators who can
advise you of company security policies and any restrictions that may be in place in
your license server operating environment.
2. Identify the appropriate operating parameters.
Depending on the transfer mode you have chosen, you will need to identify the
configuration parameters needed:
1. If you choose to use the web-service, you may need to configure your network
environment. For example, a firewall may need to be configured to allow the Log
Agent to connect to the AVEVA servers.
2. If you choose to use email, you will need to obtain the SMTP email server address
and port number as well as a username and password.
3. If you choose the manual transfer mode, you will need to liaise with your AVEVA
License Administrator to agree how you will send your usage-logs to AVEVA to be
processed.
3. Decide when you will transfer your usage-logs.
The Log Agent is not a GUI and has been designed to operate without user interaction
so that it can be run automatically by the Windows Schedule Manager if desired.

Plan the Log Agent Configuration

Log Agent Configuration
3 Log Agent Configuration
The Log Agent is configured by editing settings in the AvevaAgent.ini file that is located in
the LogAgent sub-directory in your AVEVA Licensing System installation directory. Once the
INI file has been set up, the Log Agent can be executed without the need to specify any
command line parameters or for any user-interaction.
Entries in the INI file are arranged in sections, each section is introduced by a line in the
following format:
[<section-name>]
Where <section-name> is the name of a section. For example, the Customer Information
section is introduced by the following line:
[Customer Information]
Each section contains one or more settings in the following format:
<parameter name>=<value>
Where <parameter name> is the name of a specific parameter that the Log Agent will
use, and <value> is the value of that parameter. For example, the following lines show how
the Customer Code value is defined within the Customer Information section:
[Customer Information]
CustomerCode=CC001234
Note: Appendix A contains details of all valid INI file settings. Refer to Log Agent INI File
Settings for further information.
3.1 Mandatory INI File Settings

The following settings need to be set regardless of your chosen transfer mode:
1. In the [Customer Information] section, the following settings need to be
configured:
CustomerCode
LocationCode
Your AVEVA License Administrator will be able to advise you of the values you need to
use.
2. In the [Backup] section, the following setting should to be configured:
Handler
Note: This is not a mandatory setting but AVEVA strongly recommends that you configure
this setting.
3. The data in your usage-log files is anonymised to protect the identities of your users
and their workstation names, the billing reports you receive from AVEVA will use these

anonymised names by default. If you want your reports to contain the real identities of
your users and workstations, set the following entry in the [Transmission] section to
true, otherwise set it to false:
AllowMapFileTransmission
3.2 Logging
By default the Log Agent will write progress messages to its standard output (the command
window display) when run from the command line. These messages can be redirected to a
file by setting the following entries in the [Debug] section:
DebugLogFile
DebugLogFileMaxSize
AVEVA recommends that these settings are configured to keep a record of log file transfers.
3.3 Web-service Transfer Mode Settings

The log agent supports the ability to transfer the usage logs using a web-service. The
example displays the system set up for a server configured to use the web-service transfer
mode.
The usage logs will be copied to the spool directory, and the optional backup directory, by
the Log Agent each time it runs. The Log Agent will then attempt to send the all spooled
usage logs in the spool directory to the AVEVA Log Receiver via the web-service. Usage log
files will be removed from the spool directory after they have been successfully transferred.
3.3.1 Pre-Requisite: Installing Microsoft Web Service Enhancements (WSE)

3.0.
In order to support the web-service transfer mode, the Log Agent requires that MS WSE 3.0
is installed. The installer, MicrosoftWSE3.0Runtime.msi, is provided with the ALS installation

and can be found in the LogAgent sub-directory in your ALS installation directory. To install
MS WSE 3.0, double-click MicrosoftWSE3.0Runtime.msi and follow the on-screen
instructions.
3.3.2 Web-Service Mode INI File Settings

The following settings need to be configured in order to support Web-service transfer mode:
1. In the [Transmission] section set the following entry:
UsageTransferMode=0
2. In the [Web] section set the following entry:
ServiceURL= https://urs.aveva.com/AVEVAUsageLogWebService/
AVEVAUsageLogWebService.asmx
3.4 Email Transfer Mode Settings

The log agent supports the ability to transfer the usage logs using a SMTP server. The
example displays the system set up for a server configured to use the Email transfer mode.
The usage logs will be copied to the spool directory, and the optional backup directory, by
the Log Agent each time it runs. The Log Agent will then attempt to send the all spooled
usage logs in the spool directory to the AVEVA Log Receiver via the SMTP server. Usage
log files will be removed from the spool directory after they have been successfully
transferred.
3.4.1 Email Mode INI File Settings

The following settings need to be configured in order to support Email Transfer Mode:
1. In the [Transmission] section set the following entry:
UsageTransferMode=1
2. In the [SMTP] section set the following entries appropriately:

MailTo=urs.logs@aveva.com SMTPServerHost
SMTPPort MailFrom MailCC MailUserName MailSSL
Your system administrator should be able to advise you which settings you need to use and
what the correct values should be.
3.5 Manual Transfer Mode Settings

This is used by customers who don't have internet connection on the license server or if
they have issues with SMTP or Web Service log transfer. The example displays the system
set up for a server configured to transfer the usage logs manually.
The usage logs will be copied to the spool directory, and optional backup directory, by the
Log Agent each time it runs. Customers should copy the files within the LogAgentSpool
directory to an external device (for example USB device) and email those log files to the
AVEVA License Administrator.
Important: The user must manually remove usage log files from the spool directory after
they have been successfully sent to AVEVA.
3.5.1 Manual Mode INI File Settings

The following setting needs to be configured in order to support Manual Transfer Mode:
In the [Transmission] section, set the following entry:
UsageTransferMode=2

Running the Log Agent
4 Running the Log Agent
Once the INI file has been set up, the Log Agent can be run without the need for user-
interaction which makes it suitable for being run automatically using a scheduler, such as
the Windows Scheduler. Alternatively, it can be run manually from a command window as it
will use the settings in the INI file and the user will not need to specify any command line
arguments or interact with the program when it runs.
4.1 Running the Log Agent from the Command Line

To run the Log Agent manually from the command line:
1. Open a command line window (if running on Windows 7/2008 ensure that it is run as an
Administrator).
2. Change directory to the LogAgent sub-directory in your AVEVA License System
installation (usually C:\AVEVA\AVEVA Licensing System).
3. Type AVEVALogAgent.exe.
The Log Agent will read the INI file and attempt to transfer any usage-log files. If the
DebugLogFile INI file setting has not been set, the Log Agent will display progress
messages on the screen as it processes your usage-log files, otherwise you will need to
view the log file configured in the INI file to see the results of the transfer.
4.2 Running the Log Agent from the Windows Scheduler

Configuring the Windows Scheduler is not a straightforward task as different versions of
Windows require different configuration steps. It is recommended that your system
administrator is consulted before using the Windows Scheduler to ensure that the time
chosen for the transfer does not clash or interfere with any other administrative tasks that
may be active at the time.
As a guide to setting up the Windows Scheduler, we recommend that you consult the official
Microsoft website for the latest information:
http://windows.microsoft.com/en-gb/windows7/schedule-a-task
Note: If the INI file is set to transfer the mapping XML, it will be transferred each time the
log agent is run.
Note: If there are no new entries in the active usagelog.log, it will not be spooled/
transferred when the log agent is run.
Note: The Log Agent will not transfer the active usage log (usagelog.log) if the license
server is stopped. However, the log agent will transfer the usagelog.xml file and any
rotated log files. For example, files of the format usagelog.log.nn.

Running the Log Agent
Note: If the Log Agent is run more than once within 15 minutes, it will not transfer the active
usage log (usagelog.log), the usagelog.xml file will be transferred

Log Agent INI File Settings
A Log Agent INI File Settings
Section: Customer Information
Setting Description
CustomerCode Your AVEVA Customer Code, as supplied by AVEVA. The
code can be up to 32 characters in length. For example, UK-
C1234
LocationCode The AVEVA Location Code of the server system which is
hosting the Log Agent. Valid values are from 1 - 9999.
Section: Backup
Setting Description
Handler Specifies a directory that usage logs are copied into after
they have been spooled for transmission. The user is
responsible for removing files from this directory.
Section: Transmission
Setting Description
UsageTransferMode Specifies the mode used to transfer usage-log files. Valid
values are:
0 – Web Service
1 – Email (SMTP)
2 – Manual transfer
AllowMapFileTransmission Specifies whether the file containing de-anonymisation
information is transferred to AVEVA. Valid values are:
True – send the de-anonymisation file.
False – do not send the de-anonymisation file.
© Copyright 1974 to current year. A:1 4.0

Section: Web
Setting Description
ServiceURL Specifies the web-service URL that the Log Agent will use to
transfer usage-log files in Web-Service Transfer Mode.
TimeOutInterval The time, in milliseconds, that the Log Agent will wait for a
response from the network before reporting a failure. It has a
valid range of 600,000 to 3,600,000 and a default value of
1,800,000.
Section: SMTP
Setting Description
SMTPServerHost The hostname or IP address of the SMTP email server that
the Log Agent uses when operating in Email Transfer Mode.
SMTPServerPort The port number that the Log Agent uses when
communicating with the SMPT server defined by the
SMTPServerHost setting.
MailFrom The email address that will appear in the “From” field of
emails received by AVEVA.
MailTo The email address to which usage-logs will be sent.
MailCC An optional email address to which copies of emails will be
sent.
MailUserName The SMTP server user name that the Log Agent will use to
identify itself.
MailPassword The SMTP server password that the Log Agent will use to
authenticate itself.
MailSSL A flag that indicates if SSL is required to be used when
communicating with the SMTP server: Valid values are:
True – use SSL.
False – do not use SSL
Section: Debug
Setting Description
DebugLogFile The name of a log file that will contain the messages
generated by the Log Agent when it runs. If left blank the Log
Agent will write messages to the console.
DebugLogFileMaxSize The maximum size in KB or MB after which the Debug log file
is rotated. Default value: 10MB.

Setting Description
DebugLogFileMaxCount Specifies the maximum number of rotated log files that will be
created by the Log Agent before it overwrites the original log
file.
Trace Set this to 1 to enable additional detail logging. This should
only be used when attempting to diagnose a problem.



Aveva Log Agent User Guide

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Aveva Log Agent User Guide

Încărcat de

Drepturi de autor:

Formate disponibile

AVEVA Licensing Log Agent Configuration Guide

AVEVA Licensing Log Agent Configuration

Running the Log Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Log Agent INI File Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1

© Copyright 1974 to current year. i 4.0

© Copyright 1974 to current year. ii 4.0

3rd Party Software

Date Version Comments / Remarks

© Copyright 1974 to current year. 1:1 4.0

© Copyright 1974 to current year. 1:2 4.0

2 Plan the Log Agent Configuration

© Copyright 1974 to current year. 2:1 4.0

© Copyright 1974 to current year. 2:2 4.0

3 Log Agent Configuration

3.1 Mandatory INI File Settings

© Copyright 1974 to current year. 3:1 4.0

3.3 Web-service Transfer Mode Settings

3.3.1 Pre-Requisite: Installing Microsoft Web Service Enhancements (WSE)

© Copyright 1974 to current year. 3:2 4.0

3.3.2 Web-Service Mode INI File Settings

3.4 Email Transfer Mode Settings

3.4.1 Email Mode INI File Settings

© Copyright 1974 to current year. 3:3 4.0

3.5 Manual Transfer Mode Settings

3.5.1 Manual Mode INI File Settings

© Copyright 1974 to current year. 3:4 4.0

4 Running the Log Agent

4.1 Running the Log Agent from the Command Line

4.2 Running the Log Agent from the Windows Scheduler

© Copyright 1974 to current year. 4:1 4.0

© Copyright 1974 to current year. 4:2 4.0

A Log Agent INI File Settings

Section: Customer Information

© Copyright 1974 to current year. A:1 4.0

© Copyright 1974 to current year. A:2 4.0

© Copyright 1974 to current year. A:3 4.0

© Copyright 1974 to current year. A:4 4.0

S-ar putea să vă placă și