UpdateSubnetworks

This handler updates subnetworks for specified tiers. Once you’ve created this handler, the Tier and Domain Network Name parameters display, allowing additional definition in Handler Properties.

UpdateSubnetworks handler and properties

Property

Description

Abort On Error

This property defaults to false. This property guides GDBM whether to stop when an error occurs. The default behavior is that the reconcile or post of versions continues even when the Update Subnetwork command fails. When true, the Post Loop stops and exits the current loop in execution. If the Update Subnetwork handler was placed on Program Begin (not recommended) or Program Completion, the entire loop is stopped, and no additional handlers are run. If the Update Subnetwork handler was placed on any other location (likely Before Post), then the loop for the current version is stopped, meaning no other handlers or processing occurs on the version, but processing continues on the next version in the post queue. If no additional versions are in the post queue, processing continues on to Program Completion (run against SDE.Default) and completes the execution cycle. This property controls the reconcile/post process when the Update Subnetwork handler encounters Esri errors.

Domain Network Name

This is the name of the domain in which the subnetworks exist.

Tier

This is the tier level for the subnetworks you want to update.

Continue On Failure

This property defaults to false. This property is a flag passed to ArcGIS Server to guide the API whether to continue the update when an error occurs. The default behavior is that Update Subnetwork stops processing all subnetworks in this tier once an Esri error occurs on one of the subnetworks. A true value allows Update Subnetwork to continue on with other subnetworks when Esri errors occur on one subnetwork. This property controls the behavior of the Update Subnetwork handler when it encounters Esri errors.

Reopen On Error

This property defaults to false. If this value is set to true, Abort on Error must also be true. The default behavior is such that when an error occurs on a version, the status of the associated session remains unchanged, and the session is not able to be reopened.

If set to true, when the Update Subnetwork handler is running on a particular version and an error occurs, the status of the session associated with that version is changed to Reopened, and sent back to Session Manager. That session is able to be opened again in Session Manager and participate in the next run of the GDBM processor. Within Session Manager, the session returns to the Approval assignment, and the person responsible for approving the session sees the session return in their My Work tab. Within Session History, an Audit Note says, “A conflict or error occurred during GDBM processing.” The session also appears in the Editor plugin on the Session Manager tab with a date of reopening, reason for reopening, and shows the assignment as the user who previously approved the session.

The configuration of this handler is only considered when placed in a stage within the GDBM program that works on sessions/versions. If the handler is placed in the GDBM loop stage, it is ignored because the program loop works only on the default version.

IMPORTANT: By default, this property is only supported when used with the out-of-the-box Session Manager workflow. To utilize this property with custom Session Manager workflows, your custom workflow must be updated.

This handler times out after two minutes by default. You can customize the Times Out After setting to a time that best suits your needs.

QR Code is a registered trademark of DENSO WAVE INCORPORATED in Japan and other countries.

Was this helpful?