Enumerables and Constants
This page lists the enumeration values used by the ProcessPlan API - the numeric codes you will see (and can send) in API request and response properties.
automated_action_action_types_enum = {
email_send: 1,
pp_instance_cancel: 2,
pp_instance_set_primary_dt_published: 3,
pp_instance_field_append_value: 4,
pp_instance_field_decrease_value: 5,
pp_instance_field_increase_value: 6,
pp_instance_field_replace_value: 7,
pp_instance_field_clear_value: 9,
pp_instance_message_create: 10,
pp_instance_task_complete: 11,
pp_instance_task_complete_with_random_response: 12,
pp_instance_task_due_date_update: 13,
pp_instance_task_reassign_to_least_utilized: 14,
pp_instance_task_reassign_to_specific_user: 15,
pp_instance_task_reassign_to_text_value: 16,
pp_instance_task_start: 17,
pp_instance_task_start_date_update: 18,
pp_user_create: 19,
pp_user_custom_field_update: 20,
sms_send: 21,
webhook_execute_post: 22,
zapier_execute_post: 23,
pp_instance_task_cancel: 24,
db_query: 25,
pp_instance_field_remove_value: 26,
proxy_rpa_job: 27,
pp_instance_start: 28,
slack_post_message: 29,
pp_instance_update_all_fields: 30,
pp_evaluate_formula: 31,
pp_instance_find_similar: 32,
pp_instance_task_complete_by_mimicking_another_instance: 33,
pp_ocr_read_document_table: 34,
pp_ocr_move_focus_to_next_document_table: 35,
pp_execute_until_first_successful_automated_action: 36,
pp_execute_all_selected_automated_actions: 37,
pp_evaluate_process_table_records: 38,
}
automated_action_integration_types_enum = {
processplan: 1,
email: 2,
sms: 3,
webhook: 4,
zapier: 5,
db_query: 6,
proxy_rpa_job: 7,
slack: 8,
}
automated_action_trigger_types_enum = {
process_instance_task_completed: 1,
process_instance_task_assigned: 2,
process_instance_task_completed_for_minutes: 3,
process_instance_task_past_due: 4,
process_instance_task_pending_for_minutes: 5,
process_instance_task_due_date_changed: 6,
process_instance_task_start_date_changed: 7,
process_instance_task_assignment_changed: 8,
process_instance_task_notes_updated: 9,
process_instance_task_canceled: 10,
process_instance_field_updated: 11,
process_instance_started: 12,
process_instance_canceled: 13,
process_instance_message_posted: 14,
process_instance_pending_for_minutes: 15,
process_instance_field_date_proximity: 16,
process_instance_task_start_date_proximity: 17,
process_instance_task_due_date_proximity: 18,
process_instance_completed: 19,
process_template_public_form_submitted: 20,
linked_process_instance_task_completed: 21,
process_instance_task_milestone_completed: 22,
process_instance_task_manually_started: 23,
process_instance_field_revised: 24,
process_instance_reply_email_receive: 25,
process_instance_field_time_proximity: 26,
automated_action_succeeded: 27,
automated_action_failed: 28,
all_pending_file_analysis_complete: 30,
scheduled: 31,
merge_document_submitted: 32,
called_by_another_action: 33,
}
automated_action_conditions_satisfied_enum = {
all: 1,
any: 2,
}
automated_action_condition_types_enum = {
process_instance_field_contains: 1,
process_instance_field_does_not_contain: 2,
process_instance_field_equals: 3,
process_instance_field_not_equals: 4,
process_instance_field_empty: 7,
process_instance_field_not_empty: 8,
process_instance_field_greater_than_or_equal_to: 9,
process_instance_field_less_than_or_equal_to: 10,
process_instance_field_user_in_ug_id: 11,
process_instance_field_user_not_in_ug_id: 12,
process_instance_task_pending: 13,
process_instance_task_not_pending: 14,
process_instance_task_pending_for_minutes: 15,
process_instance_task_not_pending_for_minutes: 16,
process_instance_task_completed: 17,
process_instance_task_not_completed: 18,
process_instance_header_initiated_by_usr_id: 19,
process_instance_header_not_initiated_by_usr_id: 20,
current_user_equals_usr_id: 21,
current_user_not_equals_usr_id: 22,
current_user_position_contains: 23,
current_user_department_contains: 24,
current_user_company_contains: 25,
current_user_timezone_id_equals: 26,
current_user_supervisor_equals_usr_id: 27,
current_user_in_ug_id: 28,
current_user_not_in_ug_id: 29,
current_weekday_number_equals: 30,
current_month_number_equals: 31,
current_month_day_number_equals: 32,
current_hour_number_equals: 33,
process_instance_task_response_contains: 34,
process_instance_task_response_does_not_contain: 35,
process_instance_task_response_equals_ir_id: 36,
process_instance_task_response_does_not_equal_ir_id: 37,
process_instance_task_completed_by_usr_id: 38,
process_instance_task_was_not_completed_by_usr_id: 39,
process_instance_task_assigned_to_usr_id: 40,
process_instance_task_is_not_assigned_to_usr_id: 41,
process_instance_task_assigned_to_ug_id: 42,
process_instance_task_is_not_assigned_to_ug_id: 43,
instance_age_greater_than_or_equal_to_minutes: 44,
instance_age_less_than_or_equal_to_minutes: 45,
process_instance_task_previous_response_contains: 46,
process_instance_task_previous_response_does_not_contain: 47,
current_user_custom_field_contains: 48,
current_user_custom_field_does_not_contain: 49,
current_user_custom_field_equals: 50,
current_user_custom_field_not_equals: 51,
current_user_custom_field_empty: 52,
current_user_custom_field_not_empty: 53,
current_user_custom_field_greater_than_or_equal_to: 54,
current_user_custom_field_less_than_or_equal_to: 55,
current_user_custom_field_user_in_ug_id: 56,
current_user_custom_field_user_not_in_ug_id: 57,
initiator_user_custom_field_contains: 58,
initiator_user_custom_field_does_not_contain: 59,
initiator_user_custom_field_equals: 60,
initiator_user_custom_field_not_equals: 61,
initiator_user_custom_field_empty: 62,
initiator_user_custom_field_not_empty: 63,
initiator_user_custom_field_greater_than_or_equal_to: 64,
initiator_user_custom_field_less_than_or_equal_to: 65,
initiator_user_custom_field_user_in_ug_id: 66,
initiator_user_custom_field_user_not_in_ug_id: 67,
process_instance_task_response_count_less_than: 68,
process_instance_task_response_count_not_less_than: 69,
evaluate_a_formula: 70,
process_instance_task_specific_checklist_contains: 71,
process_instance_task_specific_checklist_does_not_contain: 72,
current_weekday_number_greater_than: 73,
current_weekday_number_less_than: 74,
random_sample: 75,
process_instance_field_sentiment: 76,
}
automated_action_property_types_enum = {
email_to_address: 1,
email_cc_address: 2,
email_bcc_address: 3,
email_reply_type: 4,
email_reply_to_other_address: 5,
email_from_type: 6,
email_from_other_name: 7,
email_subject: 8,
email_body: 9,
pp_instance_source_process_template_field_id: 10,
pp_template_task_id: 11,
pp_template_field_id: 12,
pp_template_response_id: 13,
pp_instance_cancel_all_pending_tasks: 14,
pp_text_value: 16,
pp_user_id: 17,
pp_user_group_id: 18,
pp_date: 19,
pp_message_text: 20,
pp_increment_minutes: 21,
pp_decrement_minutes: 22,
pp_increment_value: 23,
pp_decrement_value: 24,
pp_instance_primary_dt_published: 25,
pp_user_template_user_group_id: 26,
pp_user_template_user_id: 27,
pp_user_first_name: 28,
pp_user_last_name: 29,
pp_user_email_address: 30,
pp_user_language: 31,
pp_user_date_format: 32,
pp_user_position: 33,
pp_user_department: 34,
pp_user_main_telephone: 35,
pp_user_mobile_telephone: 36,
pp_user_company_name: 37,
pp_user_company_website: 38,
sms_phone_number: 39,
sms_text: 40,
webhook_url: 41,
zapier_webhook_url: 42,
pp_user_id_list: 43,
db_query_ds_id: 44,
db_query_query_sql: 45,
pp_template_header_id: 46,
pp_template_table_lookup_field_id: 47,
pp_template_table_lookup_value: 48,
proxy_pxy_id: 49,
proxy_pxj_id: 50,
proxy_action_text: 51,
proxy_from_file_name: 52,
proxy_to_file_path: 53,
proxy_from_file_executable_arguments: 55,
proxy_mouse_click_type: 56,
proxy_mouse_click_location: 57,
proxy_key_code_1: 58,
proxy_key_code_2: 59,
proxy_key_code_3: 60,
proxy_image_file_id: 61,
proxy_pxa_id: 62,
proxy_file_column_delimiter: 64,
proxy_file_header_rows: 65,
proxy_verify_action: 66,
proxy_th_id: 67,
proxy_post_value_to_tf_id_01: 68,
proxy_source_value_for_tf_01: 69,
proxy_post_value_to_tf_id_02: 70,
proxy_source_value_for_tf_02: 71,
proxy_post_value_to_tf_id_03: 72,
proxy_source_value_for_tf_03: 73,
proxy_post_value_to_tf_id_04: 74,
proxy_source_value_for_tf_04: 75,
proxy_post_value_to_tf_id_05: 76,
proxy_source_value_for_tf_05: 77,
proxy_post_value_to_tf_id_06: 78,
proxy_source_value_for_tf_06: 79,
proxy_post_value_to_tf_id_07: 80,
proxy_source_value_for_tf_07: 81,
proxy_post_value_to_tf_id_08: 82,
proxy_source_value_for_tf_08: 83,
proxy_post_value_to_tf_id_09: 84,
proxy_source_value_for_tf_09: 85,
proxy_post_value_to_tf_id_10: 86,
proxy_source_value_for_tf_10: 87,
proxy_file_minimum_row_column_count: 88,
slack_channel_id: 90,
slack_message: 91,
proxy_to_file_name: 92,
proxy_delay: 93,
proxy_file_variable_name: 94,
proxy_window_maximize: 95,
proxy_from_file_path: 98,
proxy_to_file_contents: 99,
proxy_from_file_contents: 101,
proxy_element_tag_name: 103,
proxy_element_attribute_name: 104,
proxy_element_attribute_match_type: 105,
proxy_element_attribute_value: 106,
proxy_element_index: 107,
proxy_element_clear: 108,
proxy_post_value_to_tf_id_11: 109,
proxy_source_value_for_tf_11: 110,
proxy_post_value_to_tf_id_12: 111,
proxy_source_value_for_tf_12: 112,
proxy_post_value_to_tf_id_13: 113,
proxy_source_value_for_tf_13: 114,
proxy_post_value_to_tf_id_14: 115,
proxy_source_value_for_tf_14: 116,
proxy_post_value_to_tf_id_15: 117,
proxy_source_value_for_tf_15: 118,
proxy_chrome_window_handle: 119,
proxy_element_xpath_search: 120,
proxy_post_value_to_tf_id_16: 121,
proxy_source_value_for_tf_16: 122,
proxy_post_value_to_tf_id_17: 123,
proxy_source_value_for_tf_17: 124,
proxy_post_value_to_tf_id_18: 125,
proxy_source_value_for_tf_18: 126,
proxy_post_value_to_tf_id_19: 127,
proxy_source_value_for_tf_19: 128,
proxy_post_value_to_tf_id_20: 129,
proxy_source_value_for_tf_20: 130,
proxy_open_new_window: 131,
pp_document_template_id: 132,
pp_similar_instance_match_percent: 133,
proxy_html_header_xpath_list: 134,
proxy_html_column_xpath_list: 135,
proxy_date_picker_displayed_month: 136,
proxy_date_picker_displayed_year: 137,
proxy_date_picker_previous_month: 138,
proxy_date_picker_next_month: 139,
proxy_date_picker_calendar_day: 140,
proxy_disable_scheduled_browser_scripts: 141,
pp_ocr_search_match_type: 142,
pp_ocr_retrieve_from_relative_row_index: 143,
pp_ocr_retrieve_from_relative_column_index: 144,
pp_ocr_search_exclude_previous_results: 145,
pp_to_template_field_id: 146,
pp_ocr_retrieve_exclude_previous_results: 147,
proxy_sql_connection_str: 148,
proxy_sql_query: 149,
pp_automated_action_id_01: 153,
pp_automated_action_id_02: 154,
pp_automated_action_id_03: 155,
pp_automated_action_id_04: 156,
pp_automated_action_id_05: 157,
pp_automated_action_id_06: 158,
pp_automated_action_id_07: 159,
pp_automated_action_id_08: 160,
pp_automated_action_id_09: 161,
pp_automated_action_id_10: 162,
}
automated_action_email_from_types_enum = {
from_current_user_name: 1,
from_process_initiator_name: 2,
from_account_name: 3,
from_other_name: 4,
}
automated_action_email_reply_types_enum = {
reply_to_current_user: 1,
reply_to_process_initiator: 2,
reply_to_process_instance: 3,
reply_to_other_address: 4,
}
sentiment_types_enum = {
mixed: 1,
negative: 2,
neutral: 3,
positive: 4,
}
proxy_mouse_click_types_enum = {
left_click: 1,
right_click: 2,
double_left_click: 3,
}
proxy_result_types_enum = {
pending_start: 100,
in_progress: 101,
success: 200,
exit_job: 300,
proceed_normally: 301,
goto_action: 302,
failed: 400,
canceled: 401,
disable_proxy: 402,
}
proxy_action_types_enum = {
mouse_find_image_and_click: 1,
press_key: 2,
text_entry: 3,
window_focus: 4,
wait_for_image: 5,
clipboard_get: 6,
take_screen_capture: 7,
clipboard_clear: 8,
create_folder: 9,
goto_action: 10,
process_field_append_file: 11,
move_local_file_by_name: 13,
delete_local_files_by_name: 14,
run_powershell_script: 15,
run_python_script: 16,
run_executable: 17,
file_start_instance_for_each_file_row: 18,
create_text_file: 19,
evaluate_formula: 20,
process_field_replace_text: 21,
delay_seconds: 22,
window_maximize: 24,
window_close: 25,
chrome_url_open: 26,
chrome_element_enter_text: 27,
chrome_element_click: 28,
chrome_element_retrieve_text: 29,
chrome_element_wait_for: 30,
chrome_element_tab_to: 31,
chrome_element_exists: 33,
chrome_element_clear: 34,
add_screen_capture_to_audit_log: 35,
chrome_switch_to_window: 38,
chrome_close_window: 39,
chrome_element_select_option: 40,
chrome_open_new_window: 42,
chrome_element_retrieve_xpath: 45,
clear_field_via_keystrokes: 46,
create_pdf_file: 47,
process_field_download_files: 48,
exclusive_instance_lock: 49,
exclusive_instance_release: 50,
chrome_element_retrieve_attribute_value: 51,
find_local_file_by_name: 52,
convert_excel_to_csv: 53,
convert_url_to_pdf_file: 54,
window_wait_for: 55,
convert_html_to_csv: 56,
chrome_element_selected: 57,
chrome_calendar_date_picker: 58,
chrome_toggle_scheduled_scripts: 59,
process_field_hold_value: 60,
shutdown_robot: 61,
window_exists: 62,
chrome_retrieve_url: 63,
chrome_retrieve_page_title: 64,
sql_select: 65,
sql_update: 66,
clipboard_copy_via_keystrokes: 67,
clipboard_paste_via_keystrokes: 68,
}
match_types_enum = {
equals: 1,
starts_with: 2,
contains: 4,
closest_match_to: 5,
none: 6,
}
integration_types_enum = {
microsoft_graph: 1,
google: 2,
slack: 3,
connectwise: 4,
}
field_display_types_enum = {
markdown: 29,
text_1: 300,
text_5: 301,
text_10: 303,
numeric: 304,
dropdown: 305,
checklist: 306,
radio_button: 307,
date_picker: 308,
email_address: 310,
url: 311,
file_attachment_general: 312,
user_list_all: 313,
user_list_limited: 314,
display_only_file: 316,
display_only_text: 317,
display_only_url: 318,
rich_text_html: 332,
phone_number: 351,
sequential_number: 352,
time_picker: 354,
location: 355,
e_signature: 356,
address: 357,
grid: 359,
process_table_lookup_single: 360,
process_table_checklist: 362,
user_list_lookup: 363,
process_table_link: 364,
unique_number: 366,
saved_data_query: 367,
user_list_multiple: 368,
custom_data_query: 369,
merge_document_url: 370,
percent: 371,
process_table_launcher: 372,
user_group_list: 373,
user_role_list: 374,
parent_process_instance_link: 375,
date_time_picker: 376,
process_table_lookup_multiple: 377,
section_header: 378,
password: 379,
sequential_number_as_subprocess: 380,
knowledge_lookup_multiple: 381,
toggle_switch: 382,
text_20: 386,
document_template_selector: 387,
process_table_query: 388,
}
field_value_types_enum = {
process_template_header_id: 1,
process_template_field_id: 2,
process_template_task_id: 3,
process_template_response_id: 4,
process_automated_action_id: 5,
user_group_id: 6,
user_id: 7,
data_source_id: 8,
document_template_id: 9,
file_id: 10,
proxy_id: 11,
proxy_job_id: 12,
proxy_action_id: 13,
proxy_mouse_click_location_type: 14,
proxy_mouse_click_type: 15,
proxy_key_press_type: 17,
proxy_match_type: 18,
boolean: 25,
numeric: 26,
slack_channel_id: 27,
}
field_format_types_enum = {
no_formating: 1,
numeric_comma_dot_two: 2,
numeric_comma_dot_none: 3,
numeric_dot_comma_two: 4,
numeric_dot_comma_none: 5,
percent_dot_two: 6,
percent_dot_none: 7,
percent_comma_two: 8,
}
file_analysis_types_enum = {
document_text: 1,
document_analysis: 2,
}
task_field_visibility_types_enum = {
show_all_fields: 10,
show_no_fields: 20,
show_fields_with_values_plus_selected_fields: 30,
show_selected_fields: 40,
show_selected_fields_that_also_have_values: 50,
}
task_assignment_types_enum = {
specific_user: 1,
anyone_in_group: 2,
least_utilized_user_in_group: 3,
everyone_in_group: 4,
current_user_supervisor: 5,
a_value_selected_in_field: 6,
a_value_selected_in_field_supervisor: 7,
process_initiator: 8,
process_initiator_supervisor: 9,
whoever_completes_previous_task: 10,
whoever_completes_specific_task: 11,
whoever_assigned_previous_task: 12,
whoever_assigned_specific_task: 13,
process_people: 14,
user_role: 15,
process_proxy_office_robot: 19,
public_user: 20,
process_proxy_support: 21,
}
date_pivot_types_enum = {
none: 1,
task_created_date: 2,
instance_created_date: 3,
instance_field_date: 4,
absolute_date: 5,
}
task_checklist_requirement_enum = {
none: 1,
all: 2,
any: 3,
}
file_types_enum = {
text: 1,
file_general: 2,
url: 3,
document_template: 4,
file_form: 7,
}
data_source_drivers_enum = {
mssql: 1,
mysql: 2,
pgsql: 3,
}
date_format_types_enum = {
yyyy_mm_dd: 1,
dd_mm_yyyy: 2,
mm_dd_yyyy: 3,
mmmm_d_yyyy: 4,
d_mmm_yyyy: 5,
ddImmIyyyy: 6,
mmIddIyyyy: 7,
}
field_calculate_types_enum = {
calculate_once: 1,
calculate_if_empty: 2,
calculate_every_save: 3,
calculate_only_if_formula_source_value_changed: 4,
}
schedule_interval_types_enum = {
specific_date: 1,
hourly: 2,
weekly: 3,
daily: 4,
monthly_on_day_of_month: 5,
monthly_on_day_of_week: 6,
yearly_on_day_of_year: 7,
yearly_on_day_of_week: 8,
}
template_connector_field_map_from_types_enum = {
from_field: 1,
from_text: 2,
}
store_category_types_enum = {
cpa_firm: 1,
data_tables: 2,
miscellaneous: 3,
software_development: 4,
customer_management: 5,
law_office: 6,
managed_service_provider: 7,
sales_general: 8,
human_resources: 9,
marketing_general: 10,
office_general: 11,
technology_management: 12,
finance: 13,
project_management: 14,
incident_management: 15,
maintenance: 16,
accounting: 17,
service_delivery: 18,
heating_and_ac: 19,
iso_9001: 20,
eos: 21,
hipaa_compliance: 22,
pci_dss_compliance: 23,
soc_2_compliance: 24,
sox_compliance: 25,
gdpr_compliance: 26,
insurance: 27,
disaster_recovery: 28,
professional_services: 29,
legal: 30,
real_estate: 31,
knowledge_management: 32,
}
api_region_enum_enum = {
us0: 1,
us1: 2,
us2: 3,
us3: 4,
eu0: 5,
eu1: 6,
eu2: 7,
eu3: 8,
ap0: 9,
ap1: 10,
ap2: 11,
ap3: 12,
}