HighBond Command Language (HCL)
HighBond Command Language (HCL) is our custom Python library for domain-focused data analysis and Diligent One automation. Development of HCL is ongoing and our intention is that over time HCL will replicate many of the commands and functions available in ACLScript.
You can intermix HCL, Python, and Python libraries such as Pandas and Requests (for API calls) in the same Diligent One script in Robots. You cannot mix ACLScript and Python/HCL in the same script.
Basic Python skills are a prerequisite for working effectively with HCL. The advice for those looking to make the transition from ACLScript to Python/HCL is to take a good introductory Python course.
HCL methods
| Category | Usage |
|---|---|
| Data analysis methods |
Perform operations on an existing HCL dataframe. |
| Dataframe and file methods |
Manage dataframes and files in Python/HCL scripts. |
| HCL variables methods |
Use different types of HCL variables in Python/HCL scripts. |
| HighBond API methods |
Send a request to the HighBond API. |
Data analysis methods
Perform operations on an existing HCL dataframe.
| HCL method | Description |
|---|---|
| append() method |
Combines rows from two or more dateframes into a single dataframe by appending one dateframe to the bottom of another dataframe. |
| benford() method |
Counts the number of times each leading digit (1–9), or leading digit combination, occurs in a numeric column, and compares the actual count to the expected count. The expected count is calculated using the Benford formula. |
| count() method |
Counts the number of rows in a dataframe. |
| duplicates() method |
Detects whether duplicate values or entire duplicate rows exist in a dataframe. |
| extract() method |
Extracts columns from a dataframe to a new dataframe. |
| head() method |
Returns a specified number of rows from the top of a dataframe. |
| join() method |
Based on a common key, combines columns from two dataframes into a single dataframe. |
| outliers() method |
Identifies statistical outliers in a numeric column. Outliers can be identified for the column as a whole, or for separate groups based on identical values in one or more key columns. |
| rename() method |
Renames one or more columns in a dataframe. |
| select() method |
Selects the specified columns in a dataframe for inclusion in a new dataframe. |
| sort() method |
Sorts rows in a dataframe into an ascending or descending sequential order, based on a specified key column or columns. |
| summarize() method |
Groups rows in a dataframe based on identical values in one or more columns. Counts the number of rows in each group, and also subtotals specified numeric columns for each group. |
Dataframe and file methods
Manage dataframes and files in Python/HCL scripts.
| HCL method | Description |
|---|---|
| read_csv() method |
Reads a comma separated values file (*.csv) or a text file (*.txt) to an HCL dataframe. |
| from_pandas() method |
Converts a Pandas dataframe or a Pandas series to an HCL dataframe. |
| to_pandas() method |
Converts an HCL dataframe to a Pandas dataframe. |
| save_result_file() method |
Saves a result file output by a Python/HCL script during a task run. |
| save_working_file() method |
Saves a file produced by a Python/HCL script to the Working data area where it is stored for future use, or for historical purposes. |
| load_working_file() method |
Loads a working file from the Working data area to make the file available for Python/HCL scripting. The loaded file is a copy, not the original. |
| from_hb_results() method |
Imports a Results table to an HCL dataframe. |
| to_hb_results() method |
Saves an HCL dataframe to a Results table. |
| publish() method |
Saves a Pandas or HCL dataframe to an Activity Center dataset. |
HCL variables methods
Use different types of HCL variables in Python/HCL scripts.
| HCL method | Description |
|---|---|
| secret[] method |
Returns the value of an HCL password variable. |
| system_variable[] method |
Returns the value of an HCL system variable. |
| variable[] method |
Returns the value of an HCL character variable. |
HighBond API methods
Send a request to the HighBond API.
| HCL method | Description |
|---|---|
| api_delete() method |
Sends a DELETE request to the HighBond API. |
| api_get() method |
Sends a GET request to the HighBond API. |
| api_patch() method |
Sends a PATCH request to the HighBond API. |
| api_post() method |
Sends a POST request to the HighBond API. |
| api_put() method |
Sends a PUT request to the HighBond API. |
