ihuSetArchiverProperty
Use the ihuSetArchiveProperty
function to change the value of specific Historian server options.
Prototype
ihuSetArchiverProperty
(long serverhandle,
MSO Char *ArchiveProperty,
MSO Char *PropertyValue)
The following properties are supported:
Property | Read/Write Access | Values | Description |
---|---|---|---|
ARCHIVER_PROP_CREATEOFFLINEARCHIVES | Read/Write | 1 , 0 | When set to 0 . (false) writes before the start time of the earliest archive are not enabled. Set to 1 only when you are migrating legacy data, and set the value back to 0 after migration is complete. Leaving this value set to 1 can cause excessive archive creation, especially when data is sent to the archiver out of order. |
ARCHIVER_PROP_CONFIGSERIALNUMBER | Read-Only | A large value that changes when the tag configuration changes. Typically used to cache configuration properties such as a set of tags. You can determine when your cache is out of date by comparing your saved serial number with the current serial number. | |
ARCHIVER_PROP_ACTIVEHOURS | Read/Write | 1-232800 hours (30 years) | The number of hours before the present time that the archive data became read-only. When migrating legacy data, you might need to set a large value. |
SECURITY_PROP_STRICTCLIENTAUTHENTICATION | Read/Write | 1 . 0 | Enables or disables strict client authentication. Set to 1 (true) by default for new Historian installations. When set to 1 , only version 4.7 or later clients can access the Historian server. |
SECURITY_PROP_STRICTCOLLECTORAUTHENTICATION | Read/Write | 1 . 0 | Enables or disables strict collector authentication. Set to 1 (true) by default for new Historian installations. When set to 1 , only version 4.7 or later collectors can access the Historian server. |
Returns
The ihuSetArchiverProperty
returns the following values:
ihuSTATUS_INVALID_PARAMETER
ihuSTATUS_OK
ihuSTATUS_ACCESS_DENIED
To change this property... | You must be a member of this group... |
---|---|
ARCHIVER_PROP_CREATEOFFLINEARCHIVES | ihArchive Admins or ihSecurity Admins |
ARCHIVER_PROP_ACTIVEHOURS | ihArchive Admins |
SECURITY_PROP_STRICTCLIENTAUTHENTICATION | ihArchive Admins |
SECURITY_PROP_STRICTCOLLECTORAUTHENTICATION | ihArchive Admins |