Reactivate GeoClaw Cases
Summary
Reactivate GeoClaw Cases restarts failed GeoClaw case tasks in your Microsoft Azure® Batch account landspill-azure-job job that exited with any error type other than a GeoClaw error.
To learn more about the Liquids HCA Tool in general, please see Liquids HCA Tool Frequently Asked Questions.
To learn more about the structure of the Liquids HCA Tool project geodatabase, please see Liquids HCA Tool Data Dictionary.
Usage
Although the GeoClaw analysis process on Azure is robust, several things may cause an individual Azure task to fail. Commonly, a task may fail due to inability to communicate with the United States Geological Service (USGS) or Esri data servers providing topography and hydrography data. Occasionally, a task may fail due to an internal Azure problem. Unless GeoClaw itself fails, you can restart failed tasks using Reactivate GeoClaw Cases. When GeoClaw itself fails, you’ll need to generate new cases for those release points with updated GeoClaw parameters using the Create GeoClaw Cases tool. (You’ll need to run them, too, using the Run Cases on Azure tool.)
Reactivate GeoClaw Cases updates the OSANALYSIS column in your release point feature class with the status of that release point’s corresponding GeoClaw case task status on Azure. (The tool does this in the same way as the Update GeoClaw Case Status tool; see that tool’s help topic for a full listing of GeoClaw case status values.) Reactivate GeoClaw Cases then restarts Azure tasks with any of the following case status values:
- Blob Upload Error – The task failed due to an inability to transfer results to the Azure Storage account storage container.
- NHD Error – The task failed due to an inability to communicate with the USGS NHDPlus High Resolution hydrography data server.
- Esri Error – The task failed due to an inability to communicate with the Esri topography data server.
- 3DEP Error – The task failed due to an inability to communicate with the USGS 3DEP topography data server.
- Azure Error – The task failed due to an Azure resource error.
- Other Error – The task failed with an otherwise unspecified error.
Reactivate GeoClaw Cases uses the following tool parameters:
- Input Release Point Features – This should be the same feature layer that you used in the Create GeoClaw Cases and Run Cases on Azure tools. However, if you wish to reactivate only a subset of your GeoClaw cases, you may do so either by applying either a definition query or a feature selection to your release point feature layer.
- Release Point Identifier Field – The field that uniquely identifies your input release point features. This should be the same as the field name specified in the Create GeoClaw Cases and Run Cases on Azure tools. The default value is the POINT_ID field.
- Azure Credential Method – You can either use the encrypted, passcode-protected Azure credential file that you created using the Create Encrypted Azure Credential File tool or you can manually input your Azure Batch and associated Storage account credentials. When you select “Encrypted file” for this parameter, the following required dependent parameters are exposed:
- Encrypted Credential File – This parameter is the path to your encrypted, passcode-protected credential file. By default, the tool looks for a credential file named azure_cred.bin in the scratch folder for the active ArcGIS Pro project.
- Encrypted Credential File Passcode – This parameter requires you to specify the passcode that you supplied when creating your encrypted Azure credential file. The encrypted Azure credential file can only be unencrypted for use when you supply this passcode. You should apply the same security measures for safeguarding this passcode that you apply to your Windows password.
- The following required dependent parameters are exposed when you select “Manual input” for the Azure Credential Method parameter:
- Azure Batch Account Name – Your Azure Batch account name.
- Azure Batch Account Key – The primary or secondary access key for your Azure Batch account.
- Azure Batch Account URL – The URL for your Azure Batch account.
- Azure Storage Account Name – The name of the Azure Storage account associated with your Azure Batch account.
- Azure Storage Account Key – Key1 or Key2 for the Azure Storage account associated with your Azure Batch account.
In a typical liquids HCA analysis workflow, you will run Reactivate GeoClaw Cases after executing Run Cases on Azure. You may execute Reactivate GeoClaw Cases while tasks are still running on Azure.
For visual reference on Liquids HCA Tool execution order, see Liquids HCA Tool Process Flow Diagrams.
Syntax
ReactivateGeoClawCases(rupture_point, case_name_field, cred_type, cred_file, {passcode}, {azure_batch_name}, {azure_batch_key}, {azure_batch_URL}, {azure_storage_name}, {azure_storage_key})
Parameter | Explanation | Data Type |
rupture_point |
Dialog Reference Specify the release point features associated with your GeoClaw cases. There is no Python reference for this parameter. |
Feature Layer |
case_name_field |
Dialog Reference Select the field storing your release point unique identifier values. There is no Python reference for this parameter. |
Field |
cred_type |
Dialog Reference Select the Azure authentication method. There is no Python reference for this parameter. |
String |
cred_file |
Dialog Reference Select your encrypted, passcode-protected Azure credential file. There is no Python reference for this parameter. |
File |
passcode (Optional) |
Dialog Reference Specify the passcode for your encrypted, passcode-protected Azure credential file. There is no Python reference for this parameter. |
String Hidden |
azure_batch_name (Optional) |
Dialog Reference Specify the name of your Azure Batch account. There is no Python reference for this parameter. |
String Hidden |
azure_batch_key (Optional) |
Dialog Reference Specify your Azure Batch account key. There is no Python reference for this parameter. |
String Hidden |
azure_batch_URL (Optional) |
Dialog Reference Specify your Azure Batch account URL. There is no Python reference for this parameter. |
String Hidden |
azure_storage_name (Optional) |
Dialog Reference Specify your Azure Storage account name. There is no Python reference for this parameter. |
String Hidden |
azure_storage_key (Optional) |
Dialog Reference Specify your Azure Storage account key. There is no Python reference for this parameter. |
String Hidden |
Code sample
The following script demonstrates how to use Reactivate GeoClaw Cases with file geodatabase data:
import arcpy
arcpy.ImportToolbox(r”C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3\Lib\site-packages\liquidshca\esri\toolboxes\ReactivateGeoClawCases.pyt”
arcpy.env.workspace = r”C:\data\test.gdb”
release_points = “OSPointM”
point_id_field = “POINT_ID”
cred_type = “Encrypted file”
file_path = r”C:\data\azure_cred.bin”
passcode = “XXXXXXX”
batch_name = None
batch_key = None
batch_url = None
storage_name = None
storage_key = None
ReactivateGeoClawCases(rupture_point, case_name_field, cred_type, cred_file, {passcode}, {azure_batch_name}, {azure_batch_key}, {azure_batch_URL}, {azure_storage_name}, {azure_storage_key})
Environments
This tool uses no geoprocessing environment settings.
Licensing information
This tool requires a valid Liquids HCA Tool user license or subscription. Please see the Request License and Register License tool help topics for details on obtaining and registering a Gas HCA Tool software license.
Related topics
- Introduction to the Liquids HCA Tool
- Liquids HCA Tool Frequently Asked Questions
- Liquids HCA Tool Data Dictionary
- Create GeoClaw Cases
- Run Cases on Azure
- Update GeoClaw Case Status
Tags
Liquids HCA, Release Point, GeoClaw, Microsoft Azure, Batch account, Storage account.
Credits
Copyright © 2003-2020 by G2 Integrated Solutions, LLC. All Rights Reserved.
Use limitations
There are no access and use limitations for this item.