5.8 Meta Services (Core Content Server)

The Meta Services are used to manage and alter metadata in the Content Server. Frequently used services are marked with an asterisk (*) in the following list.

The following services are described in this section:

• ADD_METADEF

• DEL_METADEF

• EDIT_METADEF

• GET_ADVANCED_SEARCH_OPTIONS

• *GET_DOC_METADATA_INFO

• GET_OPTION_LIST

• GET_USER_METADATA_INFO

• MOVE_METADEF

• UPDATE_ADVANCED_SEARCH_OPTIONS

• UPDATE_USER_META

• UPDATE_USER_META_TABLE

• UPDATE_META_TABLE

• UPDATE_OPTION_LIST

5.8.1 ADD_METADEF

Service that creates a new metadata field.

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

Note: See UPDATE_META_TABLE and START_SEARCH_INDEX for more details. These services must be run before storing data in a new metadata field. See also UPDATE_OPTION_LIST for details about updating the OptionLists database table.

Additional Required Service Parameters

• dName: Internal name of the field.

• dCaption: User-visible caption used to label the field in the Content Server pages.

• dIsRequired: Prevents files from being checked in if the field does not contain a value. Values are 1 (required) or 0 (not required). Default is 0.

• dIsEnabled: Enables the field to be displayed on user interface pages. Values are 1 (enabled) or 0 (disabled). Default is 1.

• dIsSearchable: Enables the field to be indexed and searchable. Values are 1 (searchable) or 0 (not searchable). Default is 1.

• dIsOptionList: Allows the use of a user-selectable option list on Content Server pages. Values are 1 (enabled) or 0 (disabled). Default is 0. If 1 is used then dOptionListKey is also required.

• dOptionListKey: Name of the option list to be used.

• dOptionListType: Specifies the type of option list to be used. Values can be choice (Select List Validated), chunval (Select List Not Validated), combo (Edit and Select List), multi2 (Multiselect List) or multi (Edit and Multiselect List).

• dType: The type of field. Values can be Text (Text), BigText (Long Text), Int (Integer), Date (Date), Memo (Memo). Default: Text.

• dOrder: Sequence in which the field is displayed on Content Server pages. The default value is the highest current value of any existing field, plus one.

• dDefaultValue: Default value for the metadata field being created.

Example

IdcService=ADD_METADEF
dIsRequired=0
dOptionListKey=Web_SectionList
dOptionListType=choice
dIsOptionList=1
dOrder=5
dName=xWeb_Section
dIsSearchable=1
dIsEnabled=1
dType=Text
FieldName=Web_Section
dCaption=Web Section

5.8.2 DEL_METADEF

Service that deletes an existing custom metadata field. You cannot delete the standard metadata fields such as dDocName, dSecurityGroup, and so forth.

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

Additional Required Service Parameters

• dName: The metadata field name, including the 'x' prefix.

Example

IdcService=DEL_METADEF
dName=xCustomField

5.8.3 EDIT_METADEF

Service that modifies an existing custom metadata field.

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

Additional Required Service Parameters

• dName: The metadata field name, including the 'x' prefix. For example, xDepartment.

• dCaption: The metadata field caption.

• dType: The metadata field type, such as Text, BigText, Memo, Date, or Integer.

• dOrder: The display order.

• dIsRequired: 1 (true: The field is required. 0 (false): The field is optional.

• dIsEnabled: 1 (true): The field is enabled on the user interface. 0 (false): The field is disabled on the user interface.

• dIsSearchable: 1 (true): The field is searchable. 0 (false): The field is not searchable.

• dDefaultValue: The default value for the metadata field.

• dIsOptionList: 1 (true): The field has an option list. 0 (false): The field does not have an option list.

• dOptionListKey: The option list key.

• dOptionListType: The option list type.

Example

IdcService=EDIT_METADEF
dName=xDepartment
dType=BigText
dIsRequired=1
dIsEnabled=1
dIsSearchable=1
dCaption=Caption_Changed
dIsOptionList=1
dDefaultValue=two
dOptionListKey=xDepartmen_fieldList
dOptionListType=chunval
dOrder=4

5.8.4 GET_ADVANCED_SEARCH_OPTIONS

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

5.8.5 GET_DOC_METADATA_INFO

Service that returns a list of custom metadata fields from the DocMetaDefinition table, and a listing of information for the available DocTypes as result sets. Also returns two option lists of available values for SecurityGroups and Accounts filtered to show only those the user can access. Used with SOAP retrievals and other remote applications.

Access Level: Read, Global, Scriptable (49)

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

Results

• Result Sets:

  • DocMetaDefinition (All rows and fields from DocMetaDefiniton database table.)

  • Doctypes (All rows and fields from DocTypes database table.)

• Option Lists:

  • SecurityGroups (Option list of security groups filtered based upon user's privileges/)

  • Accounts (Option list of Accounts filtered based upon user's privileges.)

• Local Data:

  • isAutoNumber

  • useAccounts

Used By

• Other: SoapCustom:Wsdl:MetaData:Services

5.8.6 GET_OPTION_LIST

Service that returns a table of all option lists. Returns the common key value, option value, and order for each option list.

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

5.8.7 GET_USER_METADATA_INFO

Service that returns metadata information for users. Used with SOAP retrievals.

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

5.8.8 MOVE_METADEF

Service used by the Configuration Manager to move a metadata field up or down in the list. Moving the metadata in the list changes the default order in which it is displayed on the Checkin, Update, Info, and Search pages.

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

Additional Required Service Parameters

• dName: Name of the metadata field to move.

Optional Service Parameters

• isMoveUp: Default is false.Set to true to move the field up, not down.

5.8.9 UPDATE_ADVANCED_SEARCH_OPTIONS

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

5.8.10 UPDATE_USER_META

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

5.8.11 UPDATE_USER_META_TABLE

Service that updates the user information fields in the database. This service alters the database by adding, altering, and deleting columns.

• By default, fields will only be added or changed, not deleted. To delete a user information field, it must be specifically mentioned in the optional parameter MetaFieldsToDelete.

• This service is run when you add or delete user information fields in the User Admin applet and click the Update Database Design button.

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

Caution: Data may be lost if a column is deleted. Use this service carefully.

Optional Service Parameters

• MetaFieldsToDelete: Specifies a comma-delimited list of the database columns to delete.

Example

• IdcCommand command file format:

  IdcService=UPDATE_USER_META_TABLE
  

• HDA format (deletes two fields from the database):

  @Properties LocalData
  IdcService=UPDATE_USER_META_TABLE
  MetaFieldsToDelete=xUserLocation,xDivision
  @end
  

5.8.12 UPDATE_META_TABLE

Service that updates the metadata fields in the database.

This service alters the database by adding, altering, and deleting columns in the DocMeta table to conform to the DocMetaDefinition table. By default, fields will only be added or changed, not deleted. To delete a metadata field, it must be specifically mentioned in the optional parameter MetaFieldsToDelete.

This service is run when you add or delete metadata fields in the Configuration Manager applet and click the Update Database Design button.

Caution: Data may be lost if a column is deleted. Use this service carefully.

Optional Service Parameters

• MetaFieldsToDelete: Specifies a comma-delimited list of the database columns to delete from the DocMeta table.

Example

• IdcCommand command file format:

  # Synchronize the DocMeta table with the design in the DocMetaDefinition table
  IdcService=UPDATE_META_TABLE
  

• HDA format (deletes two fields from the database):

  @Properties LocalData
  IdcService=UPDATE_META_TABLE
  MetaFieldsToDelete=xInteger,xMemo
  @end
  

5.8.13 UPDATE_OPTION_LIST

Service that adds or updates an option list for a metadata field. Updates or adds an option list in the OptionLists database table.

Caution: The option list values specified in the OptionListString parameter replace any existing values. To retain existing values, you must include the existing values along with any new values.

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

Additional Required Service Parameters

• dKey: The option list key.

• OptionListString: The list of options, separated by the \n escape sequence.

Example

• IdcCommand command file format:

  # Add the new options list 'LocationList' and
  # Add values Madrid, Tokyo, London, Washington
  IdcService=UPDATE_OPTION_LIST
  dKey=LocationList
  OptionListString=Madrid\nTokyo\nLondon\nWashington
  

• HDA format (adds the option list LocationList with the values Madrid, Tokyo, London, and Washington):

  @Properties LocalData
  IdcService=UPDATE_OPTION_LIST
  dKey=LocationList
  OptionListString=Madrid\nTokyo\nLondon\nWashington
  @end