Properties include the following:
-
Sync In Enabled
Default is false. Set to true if the proxied NiagaraStation “sends” users to current station. Otherwise leave at false.
-
Sync Out Enabled
Default is false. Set to true if the proxied NiagaraStation “receives” users from current station. Otherwise leave at false.
You cannot set both sync properties to true, or else a fault will occur. Also, note that if setting one of these to true,
the “reciprocal” property must also be set to “true” in the remote (proxied) station, in the Users extension of the NiagaraStation that represents the current station. See Example Sync In and Out values.
-
Status
Either (ok} or {fault} as status of Users device extension.
-
Fault Cause
If Users extension is in fault, provides the reason. Note you can see a fault when first enabling a Sync In or Sync Out property, until you enable the reciprocal Sync In or Sync Out property in the remote station.
-
Sync Strategy
As one of the following:
-
-
Prototype Required - (Default) A network user is not added or modified on this proxied station unless that remote station has a matching (identically-named) User Prototype, as referenced in the source User's “Prototype Name” property.
-
Use Default Prototype - A network user always added or modified. If the remote station has a User Prototype named the same as the User's “Prototype Name”, that user prototype is used, otherwise the “Default Prototype” in the receiving station is used.
-
-
Sync Required
A read-only boolean that indicates if pending user changes require a sync to become effective. Ordinarily false unless user changes have occurred, and the sync delay time has not expired.
-
Sync Delay
Default is 30 seconds. Applies within a “sending user” station only. Specifies a configurable delay time that counts down following a change to a network User. Resets to full delay time upon each successive change. Following the last user change, if the delay time is met, network user changes (sent to the proxied station) are synchronized. This can be set uniquely among proxied stations if needed.
-
Sync Retry
Default is 5 minutes. Applies within a “sending user” station only. Specifies a configurable repeat time for previously unsuccessful user synchronization attempts (sent to the proxied station). Periodically, user synchronization will be attempted at this frequency until a successful sync is recorded.
-
Last Sync Attempt
Read-only timestamp of when user synchronization to/from this station was last attempted.
-
Last Sync Success
Read-only timestamp of when user synchronization to/from this station was evaluated as successful.