5.4 Doc Profile Services (Core Content Server)

The following services are used when creating, maintaining, or deleting document profiles:

5.4.1 ADD_DOCPROFILE

Service that is used to add a document profile. The service adds the profile and description to the content profile listing and generates the profile definition file from the data which is passed in.

Note:

The data provided for this service becomes the profile definition. When editing the profile (using EDIT_DOCPROFILE), the profile definition must first be read using GET_DOCPROFILE before adding or changing the desired values.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpName: The name for the profile. This must be a unique name.

  • dpDescription: A description of the new profile.

  • dpTriggerValue: The trigger value associated with the profile.

  • dpDisplayLabel: The display label for the profile.

Optional Service Parameters

  • isValidateTrigger: When set to true, validates that the trigger value exists. If the value does not exist, the service fails. When set to false, the profile is added without validating the trigger.

5.4.2 ADD_DOCRULE

Service used to create a new content profile rule. This service adds the rule to the content rule listing and creates the rule definition file. The data provided to the service becomes the rule definition.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpRuleName: The name for the new rule. This name must be unique.

  • dpRuleDescription: A description for the rule.

5.4.3 DELETE_DOCPROFILE

Service used to remove a document profile from the profile listing and removes the content profile definition file.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpName: The name for the profile.

5.4.4 DELETE_DOCRULE

Service used to remove a content rule from the rule listing and deletes the content rule definition file from the system.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpRuleName: The name for the rule.

5.4.5 DOCPROFILE_PREVIEW

Service used in the Configuration Manager applet to simulate the use of a content profile. The preview executes in the desired context and returns the resulting data in a data binder. The context consists of the event (submit, request, or import) and the action (search, checkin, and so on). It also includes a user name and a content item when necessary. The data includes display information for each field and which rule determined the display for each field.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpName: The name for the rule to be used in the preview.

  • dpTriggerValue: the trigger value to use for the preview.

5.4.6 EDIT_DOCPROFILE

Service used to edit a document profile.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpName: The name for the profile to be edited.

  • dpDescription: The new description for the profile.

  • dpTriggerValue: The new trigger value for the profile.

  • dpDisplayLabel: The new display label.

5.4.7 EDIT_DOCPROFILE_TRIGGER

Service that changes the metadata field that will be used as the trigger field for the content profile.

Note:

Changing the metadata fields may invalidate all existing profiles.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpName: The name of the profile to be edited.

  • dpTriggerField: The new trigger field to be used for the profile. Changing the trigger to empty (dpTriggerfield=) invalidates all profiles.

5.4.8 EDIT_DOCRULE

Service that changes a document rule description.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpRuleName: The name of the rule to be edited.

  • dpRuleDescription: The new description for the rule.

5.4.9 GET_DOCPROFILE

Service that returns the profile definition file for the specified rule. The returned data is in a data binder and contains all information used to define the profile.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpName: The name of the profile to be used.

5.4.10 GET_DOCPROFILES

Service that returns the listing file for the content profiles. The listing file contains the name, description, trigger value and display label for each profile.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.4.11 GET_DOCRULE

Service that returns the rule definition file for the specified rule. The returned data is returned in a data binder and contains all the information used to define the rule.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

  • dpRuleName: The name of the profile to be used.

5.4.12 GET_DOCRULES

Service that returns the listing file for the content rules. The listing file contains the name and description for each rule in the system.

Location: IdcHomeDir/resources/core/templates/std_services.htm