DocsMarshal /ActivityLibrary /Profiles

DocsMarshal.Workflow.ActivityLibrary.Profilesv 1.0.0.0

A set of activity essential to manage profiles in DocsMarshal. It is possible to INSERT new profiles and to UPDATE or DELETE the existing ones. It is also possible to get the value of them fields (also the multi language ones).

Operation on profile are often made using a sequence of activities. Here are described all of the necessary steps for all the possible operations:

INSERT: inserting a profile requires three steps:
- GetProfileInsert: the first necessary step is to obtain the IProfileForInsert object which represents a basic profile related to its ClassType, Domain and ObjectState.
  It is possible to perform this operation using three different activities:
  - GetProfileInsertByExtIds: allows to get a generic profile for insert (it could be related or not to a ClassType, Domain or ObjectState)
  - GetProfileInsertFromAnotherProfile: allows to get a profile for insert from an existing profile with the possibility to change its Domain or its Object State.
  - FromProfileToProfileForInsert: converts an existing profile to a profile for insert.
- SetFieldValue: the second step is to set the value of the profile fields. It is possible to perform this task using three different activity based on wether the field is MultiLanguage or not. All these activities takes in input a list of IFieldGeneric which represents the field list of the profile whose field values have to be changed. This list must be taken from the property Fields of the previously retrived ProfileForInsert:
  - SetFieldValue: set a non MultiLanguage field value.
  - SetMLFieldValue: set a single MultiLanguage field value.
  - SetMLFieldValues: set multiple MultiLanguage fields values.
- ProfileInsert: finally it is necessary to call one of the following activities to finally insert the profile in DocsMarshal:
  - ProfileInsert insert a single Profile given the IProfileForInsert created in the previous steps.
  - ProfileBulkInsert allows you to insert thousands of profiles in a very short time (less than 1 second for 4000 profiles). It is necessary to repeat the previous steps for every profile you want to insert and to add them to al List of IProfileForInsert.
UPDATE: updating a profile requires also three steps:
- GetProfileForUpdate: the first necessary step is to obtain the IProfileForUpdate object which represents the old value of the profile to update.
  It is possible to perform this operation using two different activities:
  - GetProfileForUpdate: allows to get a generic profile for update given an ObjectId.
  - GetProfileForUpdateByProfile: allows to get a profile for update profile directly from the profile itself.
- SetFieldValue: the second step is to set the value of the profile fields. It is possible to perform this task using three different activity based on wether the field is MultiLanguage or not. All these activities takes in input a list of IFieldGeneric which represents the field list of the profile whose field values have to be changed. This list must be taken from the property Fields of the previously retrived ProfileForUpdate:
  - SetFieldValue: set a non MultiLanguage field value.
  - SetMLFieldValue: set a single MultiLanguage field value.
  - SetMLFieldValues: set multiple MultiLanguage fields values.
- ProfileUpdate: finally it is necessary to call one of the following activities to apply the updates of the profile in DocsMarshal:
  - ProfileUpdate update a single Profile given the IProfileForUpdate created in the previous steps.
  - ProfileBulkUpdate allows you to update thousands of profiles in a very short time (less than 1 second for 4000 profiles). It is necessary to repeat the previous steps for every profile you want to update and to add them to al List of IProfileForUpdate.
DELETE: use the activity ProfileDelete to delete a profile given its ObjectId
SEARCH: look at the DocsMarshal.Workflow.ActivityLibrary.Profiles.Search documentation to find all details about the profile's search.

DocsMarshal.Workflow.ActivityLibrary.ApplyRegister

Apply Register with the defined ExternalId to the profile with specified ObjectId. Throws an InvalidOperationException if the profile already has a protocol code

DocsMarshal.Workflow.ActivityLibrary.CloneProfileForInsert

This activity allows you to create a copy of a profile for insert without a memory reference.

DocsMarshal.Workflow.ActivityLibrary.CreateDMObjectSecurity

This activity returns a new DMObjectSecurity object which represents the grants a security identity has on a profile.

DocsMarshal.Workflow.ActivityLibrary.CreateRelation

This activity creates a relation between two profiles in DocsMarshal.

DocsMarshal.Workflow.ActivityLibrary.FromProfileToProfileForInsert

This activity creates a new ProfileForInsert from an existing profile. It is useful in the case you want to insert a new profile starting from an existing one.

DocsMarshal.Workflow.ActivityLibrary.GetDocument

This activity allows to get a document from a profile.

DocsMarshal.Workflow.ActivityLibrary.GetFieldValue<T>

This activity returns the value of a profile field given its ExternalId.

DocsMarshal.Workflow.ActivityLibrary.GetLanguage

This activity returns a Language given its code. It takes a list of languages and search the given code. If no language is found the default value is returned.

DocsMarshal.Workflow.ActivityLibrary.GetMLFieldValue

This activity returns the value of a multilanguage field given a language code or a language id

DocsMarshal.Workflow.ActivityLibrary.GetNewIdByKey

This activity returns the first available value of an enumeration in DocsMarshal given its Key and its World

DocsMarshal.Workflow.ActivityLibrary.GetProfileForUpdate

This activity returns a ProfileForUpdate given the ObjectId of the profile to update.

DocsMarshal.Workflow.ActivityLibrary.GetProfileForUpdateByProfile

This activity returns the ProfileForUpdate of directly from the given profile.

DocsMarshal.Workflow.ActivityLibrary.GetProfileGrants

This activity returns all the grants a profile has.

DocsMarshal.Workflow.ActivityLibrary.GetProfileInsertByExtIds

This activity creates an IProfileForInsert object which represents a basic profile related to its ClassType, Domain and ObjectState.

DocsMarshal.Workflow.ActivityLibrary.GetProfileInsertFromAnotherProfile

This activity creates an IProfileForInsert object starting from an already existing profile.

DocsMarshal.Workflow.ActivityLibrary.GetProfileMaskContents

This activity returns all the properties a ClassType's mask has. The activity returns all AdditionalFieldStructures, all DynAsses and all fields' ids a mask has.

DocsMarshal.Workflow.ActivityLibrary.ProfileBulkInsert

This activity allows to massively insert profiles in DocsMarshal given a list of ProfileForInsert. If any error occurs, then no profile is inserted and the activity throws an exception.