DMConfig_AdditionalFieldUpdate

Description

This activity allows to update properties of an AdditionalField that already exists in the specified DocsMarshal installation.

It is enough to set only properties whose value you want to change. Each of the left empty parameters will be ignored and the corresponding value of the additional field won't be changed.


Additional Field

Description InArgument<String>

The description of the AdditionalField. Here we briefly explain what the field is for and how it should be used.

ExternalId InArgument<String>

The ExternalId of the AdditionalField.

The name of the AdditionalField.


Destination

AdditionalFieldExternalId InArgument<String>

The ExternalId of the AdditionalField to be modified. If Id and ExternalId have both a value only the Id will be considered.

AdditionalFieldId InArgument<Int32?>

The Id of the AdditionalField to be modified. If Id and ExternalId have both a value only the Id will be considered.


DocsMarshal Connection

Orchestrator InArgument<IManager>

The orchestrator object represents the connection to a DocsMarshal installation.

If this argument is left null the activity will work on the running installation. To work on another installation you must get its orchestrator by the activity DatabaseOrchestrator.

For decimal fields

Precision InArgument<Int32>

With this parameter DocsMarshal provides the ability to specify the quantity of decimal value numbers. This argument must be used only when the FieldType is 'Decimal'.

Scale InArgument<Int32>

By default it is set to 2. With this parameter DocsMarshal provides the possibility to change the quantity of numbers after the comma. This argument must be used only when the FieldType is 'Decimal'.


For string fields

StringSize InArgument<Int32?>

Indicates the maximum length of the string. This argument must be used only when the FieldType is 'String'.


Type

AllowNull InArgument<Boolean>

Indicates whether the additional field can accept null values or not.

FieldType InArgument<EFieldType>

Indicates the data type of the additional field.

Check the page dedicated to the EFieldType enumeration for more information and to see the list of all possible values.

Visibility

VisibleInSearchView InArgument<Boolean>

Sets whether this field is visible in the search view or not.