Create and manage extended properties tables

Extended properties tables allow organizations to store additional properties or associate external data with jobs to meet specific business needs. They can be updated using the Update Job Properties step and the Survey123 step and can be used as dynamic input values to other steps, such as the Run GP Service and Send Email steps. Extended properties tables can be configured with a one-to-one or a one-to-many table relationship with the ArcGIS Workflow Manager jobs table and can also be used to associate external data from a feature layer with a job. Each extended properties table in a workflow item must have a unique name.

Create an extended properties table

Complete these steps to add an extended properties table:

  1. Access the Workflow Manager web app.
  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Job Templates Job Templates.

    The Job Templates panel appears.

  4. Click the job template to which you want to add an extended properties table.

    The job template appears in the right panel.

  5. Click the Extended Properties tab.
  6. Click New Table.

    The new table appears in the list.

  7. Complete the Name and Alias fields.
    Note:

    The Name field is converted to lowercase when saved and must contain a unique value across all job templates or it is considered a duplicate.

  8. Click the Relationship toggle button to switch between a one-to-one (1-1) and a one-to-many (1-M) table relationship with the Workflow Manager jobs table.
    • 1-1—Set the relationship to one-to-one if your jobs can only have one value for the properties in the extended properties table.
    • 1-M—Set the relationship to one-to-many if your jobs can have multiple values for the properties in the extended properties table.
  9. Click Add Extended Property.

    The new property appears in the table.

  10. Provide a name for the property in the Name text box.
    Note:

    Each property in an extended property table must have a unique name.

  11. Provide the display name for the property in the Alias text box.
  12. Click the Type drop-down arrow and choose a data type for the property.

    Available data types include Boolean, date, domain, double, integer, and string.

  13. Provide a default value for the property.

    The default value is used to populate the field when a job is created.

  14. If Type is set to Domain, do the following:
    1. Click Add Domain.

      The Edit Domain dialog box appears.

    2. Click the Code Type drop-down arrow and choose a code type for the property.

      Available domain code data types include double, integer, and string.

    3. Provide a value for the domain in the Description text box.
    4. Provide a code for the domain in the Code text box.
    5. Optionally, click Add New Value and repeat substeps c and d to add more domain values and codes as necessary.
    6. Optionally, click Reorder Domain Reorder Domain next to the Value text box and drag it to the desired location to change the order of the domain values and codes.
      Note:

      Values and codes can be deleted by clicking Delete Domain Delete Domain.

    7. When you're done adding domain values and codes, click Save.
      Note:

      Once the domain has been saved, the Code Type setting can't be modified. You can edit or delete domain values and codes by clicking Edit Domain Edit Domain.

  15. Update the Field Length setting as necessary.
    Note:

    The default field length is 50 characters.

  16. Check the Required check box to specify that the property is required.
  17. Check the Editable check box to specify that the property is editable.
  18. Check the Visible check box if you want the property to be visible when used in a job.
  19. Optionally, repeat steps 9 through 18 to add more properties to the table.
    Note:

    You can delete a property by hovering over it and clicking Delete Item Delete Item.

  20. Optionally, hover over a property, click Reorder Property Reorder Property, and drag it to the desired location to reorder the properties.
  21. Optionally, repeat steps 6 through 19 to add more extended properties tables and properties.
    Tip:

    Filter the extended property list by property name or alias by typing a keyword in the Filter Extended Properties text box.

    Collapse and expand tables using Collapse table Collapse Table and Expand table Expand Table.

  22. Optionally, hover over a table, click Reorder table Reorder Table, and drag it to the desired location to reorder the tables.
  23. When you are done adding tables and properties, click Save.
    Note:

    Once an extended properties table has been saved, the table name, relationship, property name, property data type, and field length values can't be updated.

Create an extended properties table from a feature layer

Create an extended properties table from a feature layer to reference external feature layer data and associate it with jobs. Manually link a job to a record in the feature layer by updating the Link Id Field value with the Update Job Properties step. Complete these steps to create an extended properties table from a feature layer:

  1. Access the Workflow Manager web app.
  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Job Templates Job Templates.

    The Job Templates panel appears.

  4. Click the job template to which you want to add an extended properties table.

    The job template appears in the right panel.

  5. Click Add Feature Layer.

    The Add Feature Layer dialog box appears.

  6. Choose one of the following options to specify where the feature layer is located:
    • This Enterprise—Add a feature layer that is available on the same portal as Workflow Manager.
    • ArcGIS Online—Add a public feature layer located on ArcGIS Online.
    • Other—Add a public feature layer located on another portal.
  7. If you chose Other, type the URL for the portal that contains the layer in the Portal URL text box.

    For ArcGIS Enterprise, use the format https://webadaptorhost.domain.com/webadaptorname.

  8. Locate the item ID for the feature layer.
    1. Sign in to your portal or ArcGIS Online.
    2. Open the details page for the feature layer you want to use.
    3. Copy the item's ID from the portal or ArcGIS Online URL.

      For example, if the URL is https://www.arcgis.com/home/item.html?id=cb1886ff0a9d4156ba4d2fadd7e8a139, copy cb1886ff0a9d4156ba4d2fadd7e8a139.

  9. Paste the feature layer's item ID in the Item Id text box.

    The Layer/Table drop-down menu is automatically populated with the layers and tables in the feature layer.

  10. Click the Layer/Table drop-down arrow and choose the layer or table you want to use.

    The Link Id Field drop-down menu is automatically populated with the fields in the chosen layer or table.

  11. Click the Link Id Field drop-down arrow and choose a field that contains unique values that you want to use to link records in the feature layer to jobs.
    Note:

    Date, time, boolean, ObjectID and geometry fields, such as the SHAPE_AREA and SHAPE_LENGTH fields, can’t be used for the Link Id Field and are filtered from the list of available fields.

  12. Provide a name for the extended property feature layer table in the Reference Name text box.
  13. Click OK.

    The extended property table appears on the Extended Properties tab.

  14. Click the Relationship toggle button to switch between a one-to-one (1-1) and a one-to-many (1-M) table relationship with the Workflow Manager jobs table.
    • 1-1—Set the relationship to one-to-one if your jobs can only have one value for the properties in the extended properties table.
    • 1-M—Set the relationship to one-to-many if your jobs can have multiple values for the properties in the extended properties table.
  15. Optionally, update the display name for properties in the Alias text box.
  16. Check the Visible check box next to the properties that you want to be visible when used in a job.
  17. Optionally, hover over a property, click Reorder Property Reorder Property and drag it to the desired location to reorder the properties.
  18. When you are done configuring the extended properties table, click Save.

    The feature layer’s fields are automatically added to the table, and the field you chose for Link Id Field appears with a Linked Field indicator Linked Field.

    Note:

    Once an extended properties table has been saved, the table name and table relationship can't be updated.

Create an extended properties table from a Survey123 form

You can create an extended properties table from a feature layer to reference external feature layer data and associate it with jobs. You can manually link a job to a record in the feature layer by updating the Link Id Field value with the Update Job Properties step. The Link Id Field value can also be set automatically when a survey is collected using the Survey123 step. Complete these steps to create an extended properties table from a Survey123 form:

  1. Access the Workflow Manager web app.
  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Job Templates Job Templates.

    The Job Templates panel appears.

  4. Click the job template to which you want to add an extended properties table.

    The job template appears in the right panel.

  5. Click Add Survey123 Form.

    The Add Survey123 Form dialog box appears.

  6. Choose one of the following options to specify where your Survey123 form is located:
    • This Enterprise—Add a survey that is available on the same portal as Workflow Manager.
    • ArcGIS Online—Add a public survey located on ArcGIS Online.
    • Other—Add a public survey located on another portal.
  7. If you chose Other, type the URL for the portal that contains your survey in the Portal URL text box and press Enter.

    For example, https://webadaptorhost.domain.com/webadaptorname.

  8. Type the form ID for the survey in the Form Item Id text box.
  9. Provide a name for the survey in the Reference Name text box.
  10. Click OK.

    The extended property table appears on the Extended Properties tab.

  11. Click the Relationship toggle button to switch between a one-to-one (1-1) and a one-to-many (1-M) table relationship with the Workflow Manager jobs table.
    • 1-1—Set the relationship to one-to-one if your jobs can only have one value for the properties in the extended properties table.
    • 1-M—Set the relationship to one-to-many if your jobs can have multiple values for the properties in the extended properties table.
  12. Optionally, update the display name for properties in the Alias text box.
  13. Check the Visible check box next to the properties that you want to be visible when used in a job.
  14. Optionally, hover over a property, click Reorder Property Reorder Property and drag it to the desired location to reorder the properties.
  15. When you are done configuring the extended properties table, click Save.

    The feature layer’s fields are automatically added to the table and the globalid field appears with a Linked Field indicator Linked Field.

    Note:

    Once an extended properties table has been saved, the table name and table relationship can't be updated.

Duplicate an extended properties table

You can duplicate an extended properties table and share it with multiple job templates. Complete these steps to duplicate an extended properties table:

  1. Access the Workflow Manager web app.
  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Job Templates Job Templates.

    The Job Templates panel appears.

  4. Click the job template to which you want to add an extended properties table.

    The job template appears in the right panel.

  5. Click the Extended Properties tab.
  6. Click Add Existing Table.

    The Add Existing Table dialog box appears.

  7. Click the Job Template drop-down arrow and choose the job template that contains the extended properties table that you want to duplicate.
  8. Click the Table drop-down arrow and choose the extended properties table that you want to duplicate.
  9. Click OK.

    The extended properties table is duplicated and appears in the list.

  10. Click Save to save the job template.

Delete an extended properties table

Deleting an extended properties table removes it from the chosen job template. If the extended properties table is shared across multiple job templates, it is only removed from the chosen job template. Complete these steps to delete an extended properties table:

  1. Access the Workflow Manager web app.
  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Job Templates Job Templates.

    The Job Templates panel appears.

  4. Click the job template that contains the extended properties table that you want to delete.

    The job template appears in the right panel.

  5. Click the Extended Properties tab.
  6. Hover over the extended properties table you want to delete and click Delete Table Delete Table.

    A confirmation message appears.

    Caution:

    Deleted tables can't be recovered.

  7. Click Delete to delete the table or click Cancel to cancel.

Related topics