License Report in an SaaS Environment

In an SaaS environment the license report is automatically executed once a month via CRM.server.

The task and interval are configured via CRM.server's settings.xml file, see Scheduling CRM.server Jobs.
CRM.server
[...]
<Jobs>
<Job schedule="* * * * * "
type="update.Crm.Server.Jobs.GenerateLicenseReportJob,update.Crm.Server">
<ExportPath>..\LicenseReport</ExportPath>
<EncodeUserNames>false</EncodeUserNames>
</Job>
[...]
</Jobs>
</Server>

The value of <ExportPath> determines the target directory for the license report files (mmsystemlog_<service_name>_YYYYMMDD_HHMM.xml). You can specify a relative or absolute path. The path may contain an environment variable. If the directory does not exist, it is created.

If <ExportPath> is undefined, a .. \LicenseReport directory is created on the same level as the .. \runtime directory, >> See the article HOW TO Configure the u8.server to process To Do jobs on the Aurea support portal https://support.aurea.com.

If <EncodeUserNames> is set to true, the user names are anonymized, i.e. instead of outputting user name+ID, USER0, USER1 etc. is output. The names of technical users (WWW, SU, COM etc.) are not anonymized.

The automated license report can be executed by another user than the SU. It has to be executed on the main office station.

The license report is created for the current month (monitored timespan: 1st day of current month plus one month).

In the SaaS context all users active in the monitored interval are counted as "active" (irrespective of whether a user has actually logged on to a Aurea CRM module during that time). The Billable (ID:6000), Billable from (ID:6002) and Billable to (ID:6003) fields are taken into account.

Example:

A license report is created on August, 18th, i.e. the monitored timespan is August 1st to 31st.

  • USER1: Both 6002 and 6003 are empty; the user is counted as active.
  • USER2: Field 6002 is set to "20130905"; the user is no counted as he is not active in August.
  • USER3: Field 6003 is set to "20130910"; the user is counted as active.

Users with Inactive = true are not counted.

The used modules are counted based on the user's module access rights.