General services are used throughout the Content Server and are often not tied to a specific functionality. Frequently used services are marked with an asterisk (*) in the following list.
This section describes these services:
Service used to create a new account. The most likely error is an account name that is not unique.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocAccount: The security account for the content item.
IdcService=ADD_DOC_COLLECTION dDocAccount=newaccount
Service that adds a file extension to an existing file. The most likely error is when a matching file with that extension already exists in the system.
Additional Required Service Parameters
dExtension: The file extension such as hcsf, doc, txt.
dFormat: The formatting process used to create the Web-viewable version of the content. For example, application/hcsf or application/doc.
IdcService=ADD_DOCEXTENSION dExtension=doc dFormat=application/doc
Service that creates a new file format. The most likely error is when the file format already exists in the system.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dFormat: The formatting process used to create the Web-viewable version of the content. For example, application/hcsf or application/doc.
dConversion: The conversion algorithm is determined by the parameter dConversion.
If the conversion type is not Passthru or NoConversion (default value) and the content is not Web-viewable or has a publish state, the content gets added to the queue to get converted. Otherwise, the server looks for the Web-viewable (if applicable) and the vault file and updates the processing state to say that the file has already been converted.
If the file mime-type is application/FDF, the server sets the conversion to exchange-fdf.
dDescription: The file format description.
IdcService=ADD_DOCFORMAT dFormat=application/doc dDescription=msword dConversion=PASSTHRU
Used to create a new content item type. The most likely error is when the content item type name is not unique.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocType: The new content item Type.
dDescription: Description of the new type.
dGif: The file name of the GIF image that is displayed as an icon to represent the new doc type. Include the .gif extension.
IdcService=ADD_DOCTYPE dDocType=MYTEST dDescription=My Description. dGif=adeng.gif
Service that retrieves content item information. The most likely error is when the content item no longer exists in the system.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dID: The generated content item revision ID.
IdcService=APPLET_DOCINFO dID=47
Service that retrieves configuration information from the Admin Server. The service retrieves configuration information for the currently active component.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that deletes an existing account.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocAccount: The account name.
IdcService=DELETE_DOC dDocAccount=mainaccount
Service that deletes an existing file extension.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dExtension: The file extension, such as hcsf, doc, txt.
IdcService=DELETE_DOCEXTENSION dExtension=hcsf
Service that deletes an existing document format.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dFormat: The name of the MIME format. For example, application/hcsf or application/doc.
IdcService=DELETE_DOCFORMAT dFormat=application/hcsf
Service that deletes an existing content item type. The most likely errors are when the specified file type does not exist or when a file of that type still exists in the system.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocType: The content item type.
IdcService=DELETE_DOCTYPE dDocType=TEST
Service that modifies an existing file extension.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dExtension: The file extension such as doc, txt, or pdf.
dFormat: The formatting process used to create the Web-viewable version of the content. For example, application/hcsf or application/doc.
IdcService=EDIT_DOCEXTENSION dExtension=hcsf dFormat=application/hcsf
Service that modifies an existing content item format. This service is called from the Configuration Manager applet.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dFormat: The formatting process used to create the Web-viewable version of the content. For example, application/hcsf or application/doc.
dDescription: The format description.
dConversion: The conversion algorithm is determined by this parameter.
If the conversion type is not Passthru or NoConversion (default value) and the content is not Web-viewable or has a publish state, the content gets added to the queue to get converted. Otherwise, the server looks for the Web-viewable (if applicable) and the vault file and updates the processing state to say that the file has already been converted.
If the file mime-type is application/FDF, the server sets the conversion to exchange-fdf.
IdcService=EDIT_DOCFORMAT dFormat=application/hcsf dDescription=hypercontent dConversion=PASSTHRU
Service that modifies an existing content item type.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocType: The content item type.
dDescription: The type description.
dGif: The file name of the GIF image that is displayed as an icon to represent the type. Include the .gif extension.
IdcService=EDIT_DOCTYPE dDocType=MY_TEST dDescription=edit testing dGif=admkt.gif
Service that retrieves trace options on the System Audit Info page.
Location: IdcHomeDir/resources/core/templates/std_services.htm
This service executes a Select query against the database. The query is built from the dataSource parameter. The service returns the following information:
The resultset containing the results of the query.
An indication if the results were truncated. If the dataSource was defined so it cannot exceed the maximum number of rows and if the query returns more than the maximum allowed, the copyAborted key is set to 1 (true). This indicates that the returned resultset only contains a subset of the query.
Any query that tries to select against certain core Content Server tables have a security clause applied. In particular, Documents, Revisions, and Users tables have extra security clauses applied.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dataSource: A Select query with a potential WHERE clause and ORDER BY clause that is provided by the caller. The dataSource is a Content Server resource, defined in the DataSources table (see the resource.htm file for the standard list of dataSources.)
whereClause: The WHERE clause to the Select query.
orderClause: If set to true, orders the query by clause.
resultName: specifies the name to use for the resultset of the query.
Service that returns a list of all content item extensions and the file format each extension is mapped to. Returns the properties information and ExtensionFormatMap ResultSet.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that returns a list of all content item formats and their associated conversion methods and descriptions. Returns the properties information and DocFormats ResultSet.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that returns a list of all content item types, their descriptions, and their associated GIF images. Returns the properties information and DocTypes ResultSet.
Location: IdcHomeDir/resources/core/templates/std_services.htm
An administrative service that retrieves a file listing in a directory matching a specified filter. The directory is specified by an ID, not by the user. The service then maps the ID to a directory.
In practice, this service is only used to retrieve the content type GIF list for the Configuration Manager applet. This list is located in the /weblayout/images/docgifs directory. The results are returned in the value specified in the fileListName parameter as an option list.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
directoryID: The directory identifier. Possible values include docgifs, images, templates, resources.
fileFilter: Wild card filter to use to select the files.
fileListName: Option list which holds the values returned.
Service that returns a list of all custom metadata fields and their attributes. Returns the properties information and MetaFieldInfo ResultSet.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that returns information from the search results templates.
Note:
As of version 3.5.3, the Content Server no longer uses this service. It remains in the std_services.htm file as legacy code for reverse compatibility.Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that retrieves system audit information for the Content Server.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that exports a database table to a ResultSet in an HDA file.
If the specified table is not found, the service fails. It is up to the calling program receiving the HDA data to store this ResultSet for later usage.
The most likely error is a table name that does not exist.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
tableName: The name of table to export.
IdcCommand command file format:
IdcService=GET_TABLE tableName=Users
HDA format:
@Properties LocalData IdcService=GET_TABLE tableName=Users @end
Service that returns a list of all user information fields and their attributes. Returns the properties information and ResultSet.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that returns information about the Java Resource Environment in use.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that publishes strings to a static .js file.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that loads user interface layouts from the DomainHome/ucm/cs/weblayout/common/layouts directory. Calls LM_LOAD_LAYOUTS_SUB.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Subservice used to call layouts from the DomainHome/ucm/cs/weblayout/common/layouts directory.
Location: IdcHomeDir/resources/core/templates/std_services.htm
This subservice loads the template page configuration information for the content item environment.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Service that forces a login and executes an HTML page request. This is one of many ways to authenticate the user with the Web server.
Access Level: N/A (0)
Location: IdcHomeDir/resources/core/templates//std_services.htm
Additional Required Service Parameters
Action: The action to execute. Usually GetTemplatePage.
Page: The name of the page template.
Auth: Required only when logging in from a browser interface. For example:
Auth=Internet
The other possible value is Intranet, which is used for NTLM logins.
Local Data:
dUser
RedirectParams
StatusMessage
Response Template: null (default redirect to HOME_PAGE)
Resource Includes:
pne_nav_userprofile_links
subscription_action_script
home_page_static_content
Templates:
QUERY_NOTIFICATION (query_notification_mail.htm)
SELF_REGISTER_PROMPT_LOGIN (self_register_prompt_login.htm)
(std_home_page.htm)
Standard Navigation: commonNav.js
Displays the home page when you login to the Content Server:
IdcService=LOGIN
Action=prepareRedirect Page=HOME_PAGE
Service that merges a ResultSet with an existing database table. All errors are logged to the Content Server log.
Important:
By default, this service is not error tolerant and does not execute the merge in a transaction. Consequently, if the isErrorTolerant or isTransactional optional parameters are not set to true and if the service encounters an error, it terminates where the error occurred and does not roll back the already updated and inserted rows. In this situation, if you do not specify constraints and rerun the merge table, the merge fails in Microsoft SQL Server and Oracle due to constraint violations.Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
tableName: The name of the database table to merge into. The ResultSet must have the same name as this table.
Important:
The ResultSet definition for the table containing the rows to insert or update must also be specified.constraintKeys: Specifies a comma-delimited list of column names used as unique identifiers. The service initially does a look up with these constraints. If the row is found, the service does an update. Otherwise, a new row is inserted.
If this parameter is not defined, the service attempts to insert the rows.
isDeleteTable: If true, the service deletes the table before attempting the merge. The delete is performed in a transaction with the merge, if isTransactional is true. By default, this value is false.
isErrorTolerant: If true, does not terminate when errors are encountered during the merge. By default, this value is false.
isTransactional: If true, the merge is performed in a transaction. If an error occurs during the merge and isErrorTolerant is false, the merge terminates and rolls back all the changes. By default, this value is false.
IdcCommand command file format:
# Merge new entries into the Alias table IdcService=MERGE_TABLE tableName=Alias constraintKeys=dAlias # Rows to be updated or inserted @ResultSet Alias 2 dAlias dAliasDescription MyAlias Just a test alias @end <<EOD>> # Delete the alias table and insert new rows, do a rollback if something fails. IdcService=MERGE_TABLE tableName=Alias isTransactional=true isDeleteTable=true # Rows to be updated or inserted @ResultSet Alias 2 dAlias dAliasDescription MyAlias Just a test alias @end <<EOD>>
HDA format (Example 1):
@Properties LocalData
IdcService=MERGE_TABLE tableName=Alias constraintKeys=dAlias @end @ResultSet Alias 2 dAlias dAliasDescription MyAlias Just a test alias @end
HDA format defining a table name and ResultSet and inserting a new row into the database (inserts new row into Users table):
@Properties LocalData
IdcService=MERGE_TABLE tableName=Users @end @ResultSet Users 2 dName dUserAuthType user15 LOCAL @end
Service that evaluates if a connection to the Content Server exists and returns status information. It also forces users to log in if they are not already logged in.
Tip:
Execute a PING_SERVER request before calling other services to ensure that there is a connection to the Content Server and that you are logged in as a user authorized to execute commands.Access Level: N/A (0)
Location: IdcHomeDir/resources/core/templates/std_services.htm
Local Data:
dUser
StatusMesage
Response Template: null
Applets:
Batch Loader
Configuration Manager
Page Builder
Templates:
SUBSCRIBE_FORM (subscribe_form.htm)
SUBSCRIPTION_LIST (subscription_list.htm)
UNSUBSCRIBE_FORM (unsubscribe_form.htm)
HDA format:
@Properties LocalData IdcService=PING_SERVER IsJava=1 Auth=Internet @end
Sample return information:
Content-type: text/html
Content-Length: 421
<?hda version="6.0 SNAP-020207" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
dUser=sysadmin
blFieldTypes=StatusMessage message
refreshSubMonikers=
StatusMessage=You are logged in as 'sysadmin'.
loadedUserAttributes=1
blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
changedSubjects=
refreshSubjects=
Auth=Internet
refreshMonikers=
changedMonikers=
IdcService=PING_SERVER
IsJava=1
@end
Service that returns a list of all accounts in the Content Server.
Location: IdcHomeDir/resources/core/templates/std_services.htm