Posting Subnetwork Export Acknowledgement Messages

There are two event messages that are particularly helpful to customize the subnetwork export process from the ArcFM Utility Network model (ArcFM UN):

ExportSubnetworkAcknowledged
SubnetworkGroupSwitched

In particular, these are helpful when writing custom Workflows for exporting subnetworks.

TIP: There is a sample Workflow called Feeder Services Export & Upload Subnetwork (with a Workflow Ancestral ID of a9928bda-de10-4c02-b8f1-e64591897bd7) where these messages are included.

Both messages are provided out of the box without an option of disable them. The messages are available for MV and LV Group export processes.

ExportSubnetworkAcknowledged

ExportSubnetworkAcknowledged refers to the creation or update of a Geodatabase Region Resource (GRR) or GRR Group for the subnetwork that is currently updating.

Here is an example of an ExportSubnetworkAcknowledged message:

{
   "subnetworkStatus":"Succeeded",
   "storageId":"0abc19f6-5560-4d05-ace4-38f9ks782jnd",
   "subnetworkName":"8888",
   "subnetworkGroupName":null,
   "tierName":"MV Radial",
   "error":null,
   "bulkExportId":"84wt19f6-5560-4k05-ace4-38poid87an12",
   "workflowSessionId":"Subnetwork/8888"
}

Here is an explanation of the fields within the message:

subnetworkStatus: This indicates if the update of the subnetwork with provided “subnetworkName” succeeded or not. The available statuses are Succeeded, Failed, and Unknown.
storageId: This is the GUID of the GRR or GRR Group found within the Designer XI Storage Service. Grouping depends if the exported subnetwork is part of a tier configured for grouping or not.
subnetworkName: This is the name of the subnetwork. If the exported subnetwork is part of an LV Group, this field points to the name of the Group.
tierName: This is the tier the subnetwork belongs to.
error: This field is populated only when “subnetworkStatus” is set to Failed.
bulkExportId: This represents the unique identifier of the Dynamic Workflow instance through which the export process is being orchestrated.
workflowSessionId: This represents the ID of the Workflow Session.

SubnetworkGroupSwitched

For the subnetwork that is currently within the process of the creation or update of a GRR or GRR Group, the SubnetworkGroupSwitched refers to the state of the GRR Group to which the subnetwork previously belonged.

Here is an example of a SubnetworkGroupSwitched message:

{
   "groupSwitchStatus":"NotExecuted",
   "subnetworkName":"7777", 
   "previousSubnetworkGroupStorageId":"00000000-0000-0000-0000-000000000000",
   "subnetworkGroupName":null, 
   "previousSubnetworkGroupName":null,
   "error":null,
   "bulkExportId":"84wt19f6-5560-4k05-ace4-38903f786288",
   "workflowSessionId":"Subnetwork/7777"
}

Here is an explanation of the fields within the message:

groupSwitchStatus: This indicates if the subnetwork switched GRR Groups or not. The available statuses are Succeeded, Failed, and NotExecuted.
subnetworkName: This is the name of the subnetwork.
previousSubnetworkGroupStorageId: This is the GUID of the GRR Group that previously contained the subnetwork.
subnetworkGroupName: This is the name of the GRR Group that presently contains the subnetwork.
previousSubnetworkGroupName: This is the name of the GRR Group that previously contained the subnetwork.
error: This field is populated only when “groupSwitchStatus” is set to Failed.
bulkExportId: This represents the unique identifier of the Dynamic Workflow instance through which the export process is being orchestrated.
workflowSessionId: This represents the ID of the Workflow Session.