FRAMES | NO FRAMES Description | Parameters | Examples | Response
Update ConfigProperties
URL http://<wmservice-url>/updateConfigProperties
Parent Resource Workflow Manager Service

Description

This operation is supported from 10.3.1 onwards.

Updates the system configuration properties in the Workflow Manager database.

The possible values for the returnCode response property and their meanings are as follows:

Parameters

Parameter Details
f Description: The response format. The default response format is html.

Values: html | json
user Required
Description: The username of the person who makes the update configuration properties request. The person must have AdministratorAccess Privilege.
properties Required
Description: A JSON object containing the system configuration propertes to update. At least one parameter from the list in below needs to be specified to update.

F
  • USE_STEP_STATUS: Use step status assignment. Values: true | false
  • SHOW_STEP_IDS: Show step IDs on workflow. Values: true | false
  • DEFAULT_SENDER_EMAIL: The default email to send notifications.
  • DEFAULT_SENDER_NAME: The default name displayed to send notifications.
  • HTML_SUPPORT: Support HTML Notifications. Values: true | false
  • JOB_ID_START_VALUE: The starting value of Job IDs.
  • WF_SEL_STEP_FILL_COLOR: The fill color of selected step in workflow. The value is an integer in range of 0 to 167772155. Value of "-1" will check off the option.
  • WF_SEL_STEP_OUTLINE_COLOR: The outline color of selected step in workflow. The value is an integer in range of 0 to 167772155. Value of "-1" will check off the option.
  • WF_SEL_STEP_OUTLINE_WIDTH: The outline width of selected step in workflow. Values: 1 | 2 | 3.
  • WF_SEL_STEP_TEXT_COLOR: The text color of selected step in workflow. The value is an integer in range of 0 to 167772155. Value of "-1" will check off the option.
  • AOIOVERLAP: AOI overlapping rules. Values: allow | disallow | disallowjobtype
  • PROMPTSDEPWD: The name of the field by which to order the results. Only a single field name may be specified. Values: true | false
  • AUTOASSIGNJOB: Auto assign job based on step assignment.Values: true | false
  • AUTOCOMMITWORKFLOW: Auto commit job workflows. Values: true | false
  • AUTOSTATUSASSIGN: Use automatic status assignment. Values: true | false
  • SMTP_SERVER: The SMTP Server to be used for sending notifications.
  • CONFIRMPROCEDURALCHECK: Confirm procedural step completion. Values: true | false
  • AUTOCLOSEJOB: Auto close jobs when workflow complete. Values: true | false
  • AOISELECTIONCOLOR: AOI Selection Color.The value is an integer in range of 0 to 167772155.
  • REQUIREPROCEDURALCHECKSTART: Require procedural steps to be marked as started.Values: true | false
  • USER_STORE: User Store of Workflow Manager database. Values: traditional | portal
  • PENDING_DAYS_USE_HOLDS: Deduct hold time from pending days. Values: true | false
  • SEND_SN_CUSTOM_POST: Send spatial notifications on Workflow Manager Post. Values: true | false
  • ZOOMTOAOI: Zoom to job AOI in AOI Map View. Values: true | false
  • USEUSERDOMAIN: Authenticate users using domain. Values: true | false
  • SHOW_STEP_PERCENT_COMPLETE: Show step completion percentage. Values: true | false
  • RESTRICT_AOI_OPTION: AOI editing restriction rules. Values: Warn | NoSelect | Off
    • "Warn" = Warn users when selecting features outside the job AOI.
    • "NoSelect" = Prevent users from selecting features outside the job AOI.
    • "Off" = Allow edits to features outside the job AOI.
  • RESTRICT_AOI_OPERATOR: AOI operator to apply AOI editing rules. Values: disjoint | !contains | default
    • "disjoint" = Completely Outside
    • "!contains" = Outside
    • "default" = No operator.
  • SMTP_USERNAME: User name that is authenticated in the secure SMTP server.
  • SMTP_PASSWORD: Use password of authenticated SMTP user.
  • SMTP_PORT: SMTP server port.
  • SMTP_PROTOCOL: SMTP Authentication protocol. Values: SSL | TLS | user's entry
  • SHOW_PENDING_DAYS: Show pending days. Values: true | false

Syntax:

{
  "USE_STEP_STATUS":"<true | false>",
  "SHOW_STEP_IDS":"<true | false>",
  "DEFAULT_SENDER_EMAIL":"<defaultsenderEmail>",
  "DEFAULT_SENDER_NAME":"<defaultsenderName>",
  "HTML_SUPPORT":"<true | false>",
  "JOB_ID_START_VALUE":"<jobIdstartingValue>",
  "WF_SEL_STEP_FILL_COLOR":"<selectedstepfillColor>",
  "WF_SEL_STEP_OUTLINE_COLOR":"<selectedstepoutlineColor>",
  "WF_SEL_STEP_OUTLINE_WIDTH":"<1 | 2 | 3>",
  "WF_SEL_STEP_TEXT_COLOR":"<selectedsteptextColor>",
  "AOIOVERLAP":"<allow | disallow | disallowjobtype>",
  "PROMPTSDEPWD":"<true | false>",
  "AUTOASSIGNJOB":"<true | false>",
  "AUTOCOMMITWORKFLOW":"<true | false>",
  "AUTOSTATUSASSIGN":"<true | false>",
  "SMTP_SERVER":"<SMTPServer>",
  "CONFIRMPROCEDURALCHECK":"<true | false>",
  "AUTOCLOSEJOB":"<true | false>",
  "AOISELECTIONCOLOR":"<AOIselectionColor>",
  "REQUIREPROCEDURALCHECKSTART":"<true | false>",
  "USER_STORE":"<traditional | portal>",
  "PENDING_DAYS_USE_HOLDS":"<true | false>",
  "SEND_SN_CUSTOM_POST":"<true | false>",
  "ZOOMTOAOI":"<true | false>",
  "USEUSERDOMAIN":"<true | false>",
  "SHOW_STEP_PERCENT_COMPLETE":"<true | false>",
  "RESTRICT_AOI_OPTION":"<Warn | NoSelect | Off>",
  "RESTRICT_AOI_OPERATOR":"<disjoint | !contains | default>",
  "SMTP_USERNAME":"<SMTPUsername>",
  "SMTP_PASSWORD":"<SMTPPassword>",
  "SMTP_PORT":"<SMTPPort>",
  "SMTP_PROTOCOL":"<SMTPProtocol>",
  "SHOW_PENDING_DAYS":"<true | false>";
}

Example Usage

Example 1: URL for updating configuration properties in the "Workflow" service on sampleserver. The person who makes the request is "admin0000" and the properties to be updates including "AOIOVERLAP","USER_STORE", and "ZOOMTOAOI".

http://sampleserver/arcgis/rest/services/Workflow/WMServer/updateConfigProperties?user=admin0000&properties={"AOIOVERLAP":"disallow","USER_STORE":"portal","ZOOMTOAOI":"true"}&f=pjson

All the three properties are updated successfully and the returns code "1".

Example 2: URL for updating configuration properties in the "Workflow" service on sampleserver. The person who makes the request is "admin0000" and the properties to be updates including "ZOOMTOAOI","AOISELECTIONCOLOR", and "RESTRICT_AOI_OPTION".

http://sampleserver/arcgis/rest/services/Workflow/WMServer/updateConfigProperties?user=admin0000&properties={"ZOOMTOAOI":"","AOISELECTIONCOLOR":"-1","RESTRICT_AOI_OPTION":""}&f=pjson

All the three properties value are invalid and failed to be updated and returns code "2".

The correct URL is:

http://sampleserver/arcgis/rest/services/Workflow/WMServer/updateConfigProperties?user=admin0000&properties={"ZOOMTOAOI":"true","AOISELECTIONCOLOR":"255","RESTRICT_AOI_OPTION":"!contains"}&f=pjson

Example 3: URL for updating configuration properties in the "Workflow" service on sampleserver. The person who makes the request is "admin0000" and the properties to be updates including "AUTOASSIGNJOB","USE_STEP_STATUS", and "WF_SEL_STEP_OUTLINE_WIDTH".

http://sampleserver/arcgis/rest/services/Workflow/WMServer/updateConfigProperties?user=admin0000&properties={"AUTOASSIGNJOB":"true","USE_STEP_STATUS":"off","WF_SEL_STEP_OUTLINE_WIDTH":"0"}&f=pjson

Not all the three properties value are invalid and failed to be updated. It returns code "3" and failed properties are listed.

The correct URL is:

http://sampleserver/arcgis/rest/services/Workflow/WMServer/updateConfigProperties?user=admin0000&properties={"AUTOASSIGNJOB":"true","USE_STEP_STATUS":"false","WF_SEL_STEP_OUTLINE_WIDTH":"1"}&f=pjson

JSON Response Syntax

{ "returnCode": 1 }

{ "returnCode": 2 }

{ "returnCode": 3,
  "failedProperties": [
  "property1",
  "property2"
  ]   
 }

JSON Response Example

{ "returnCode": 1 }

{ "returnCode": 2 }

{ "returnCode": 3,
  "failedProperties": [
  "USE_STEP_STATUS",
  "WF_SEL_STEP_OUTLINE_WIDTH"
  ]   
 }