Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction

• 1.1 About This Guide
• 1.2 Organization

2 What's New

• 2.1 Changes to Services
• 2.2 New Services Interface
• 2.3 Additional Changes

3 Using Services

• 3.1 Service Overview
  • 3.1.1 Service Requests and Responses
    • 3.1.1.1 Internal Service Requests
    • 3.1.1.2 External Service Requests
    • 3.1.1.3 Request Parameters
    • 3.1.1.4 Date and Time Formatting
    • 3.1.1.5 Case Sensitivity Considerations
  • 3.1.2 Page Retrieval
  • 3.1.3 Content Server Search Services
  • 3.1.4 Integration Methods
  • 3.1.5 Calling Services Using Persistent URLs
  • 3.1.6 Customizing Locale Parameters
  • 3.1.7 Forcing Authentication Challenges
• 3.2 Custom Application Example
  • 3.2.1 Services Called
    • 3.2.1.1 Private Functions
    • 3.2.1.2 Sample Code
• 3.3 Redirecting Template Page for Response Output
  • 3.3.1 Basic Concepts
  • 3.3.2 Creating a HCST Page
  • 3.3.3 Reformatting the Search Results Page
  • 3.3.4 Additional Options

4 Customizing Services

• 4.1 Service Structure Overview
  • 4.1.1 Name
  • 4.1.2 Attributes
    • 4.1.2.1 Service Class
    • 4.1.2.2 Access Level
    • 4.1.2.3 Template Page
    • 4.1.2.4 Service Type
    • 4.1.2.5 Subjects Notified
    • 4.1.2.6 Error Message
  • 4.1.3 Actions
    • 4.1.3.1 Action Type
    • 4.1.3.2 Action Name
    • 4.1.3.3 Action Parameters
    • 4.1.3.4 Action Control Mask
    • 4.1.3.5 Action Error Message
• 4.2 Service Example
  • 4.2.1 DOC_INFO Service Definition
  • 4.2.2 DOC_INFO Attributes
  • 4.2.3 DOC_INFO Actions
    • 4.2.3.1 Action 1 Definition and Description
    • 4.2.3.2 Action 2 Definition and Description
    • 4.2.3.3 Action 3 Definition and Description
    • 4.2.3.4 Action 4 Definition and Description
    • 4.2.3.5 Action 5 Definition and Description
    • 4.2.3.6 Action 6 Definition and Description
    • 4.2.3.7 Action 7 Definition and Description
    • 4.2.3.8 Action 8 Definition and Description
    • 4.2.3.9 Action 9 Definition and Description
    • 4.2.3.10 Action 10 Definition and Description
  • 4.2.4 DOC_INFO Template
• 4.3 Creating a Service Resource
  • 4.3.1 Creating a Custom Service Manually
  • 4.3.2 Define the service in an HTM file
    • 4.3.2.1 Load the service in the custom component HDA file
  • 4.3.3 Creating a Custom Service using Component Wizard

5 Core Content Server Services

• 5.1 About Core Content Server Services
• 5.2 General Services (Core Content Server)
  • 5.2.1 ADD_DOC_ACCOUNT
  • 5.2.2 ADD_DOCEXTENSION
  • 5.2.3 ADD_DOCFORMAT
  • 5.2.4 ADD_DOCTYPE
  • 5.2.5 APPLET_DOCINFO
  • 5.2.6 CONFIG_INFO
  • 5.2.7 DELETE_DOC_ACCOUNT
  • 5.2.8 DELETE_DOCEXTENSION
  • 5.2.9 DELETE_DOCFORMAT
  • 5.2.10 DELETE_DOCTYPE
  • 5.2.11 EDIT_DOCEXTENSION
  • 5.2.12 EDIT_DOCFORMAT
  • 5.2.13 EDIT_DOCTYPE
  • 5.2.14 EDIT_TRACE_OPTIONS
  • 5.2.15 GET_DATARESULTSET
  • 5.2.16 GET_DOCEXTENSIONS
  • 5.2.17 GET_DOCFORMATS
  • 5.2.18 GET_DOCTYPES
  • 5.2.19 GET_FILELIST
  • 5.2.20 GET_METADEFS
  • 5.2.21 GET_RESULT_OPTIONS
  • 5.2.22 GET_SYSTEM_AUDIT_INFO
  • 5.2.23 GET_TABLE
  • 5.2.24 GET_USER_METADEFS
  • 5.2.25 JAVA_PROPERTIES
  • 5.2.26 LM_BUILD_WEB_STRING_FILES
  • 5.2.27 LM_LOAD_LAYOUTS
  • 5.2.28 LM_LOAD_LAYOUTS_SUB
  • 5.2.29 LOAD_DOC_ENVIRONMENT
  • 5.2.30 LOGIN
  • 5.2.31 MERGE_TABLE
  • 5.2.32 PING_SERVER
  • 5.2.33 QUERY_DOC_ACCOUNTS
  • 5.2.34 SOAP_FAULT
• 5.3 Doc Services (Core Content Server)
  • 5.3.1 ASSIGN_DOCINFO_FORM
  • 5.3.2 CACHE_CHECKIN_NEW
  • 5.3.3 CACHE_CHECKIN_SEL
  • 5.3.4 CACHE_SUBMIT_HTML_FORM
  • 5.3.5 CACHE_WORKFLOW_CHECKIN
  • 5.3.6 CHECKIN_ARCHIVE_NO_NOTIFY
  • 5.3.7 CHECKIN_BYNAME
  • 5.3.8 CHECKIN_CONFIRM_FORM
  • 5.3.9 CHECKIN_LIST
  • 5.3.10 CHECKIN_NEW
  • 5.3.11 CHECKIN_NEW_FORM
  • 5.3.12 CHECKIN_NEW_SUB
  • 5.3.13 CHECKIN_SEL
  • 5.3.14 CHECKIN_SEL_FORM
  • 5.3.15 CHECKIN_SEL_SUB
  • 5.3.16 CHECKIN_SIMILAR_FORM
  • 5.3.17 CHECKIN_UNIVERSAL
  • 5.3.18 CHECKOUT
  • 5.3.19 CHECKOUT_BY_NAME
  • 5.3.20 CHECKOUT_OK
  • 5.3.21 CHECKOUT_SUB
  • 5.3.22 CONTINUE_CHECKIN
  • 5.3.23 CONTINUE_SUBMIT_HTML_FORM
  • 5.3.24 CREATE_SUBSCRIPTION_TYPE
  • 5.3.25 DELETE_BYCLASS
  • 5.3.26 DELETE_BYNAME
  • 5.3.27 DELETE_BYREV
  • 5.3.28 DELETE_BYREV_REVISION
  • 5.3.29 DELETE_CHECKIN_CACHE
  • 5.3.30 DELETE_DOC
  • 5.3.31 DELETE_REV
  • 5.3.32 DELETE_REV_EX
  • 5.3.33 DELETE_SUBSCRIPTION_TYPE
  • 5.3.34 DOC_FORMATS_WIZARD
  • 5.3.35 DOC_INFO
  • 5.3.36 DOC_INFO_BY_NAME
  • 5.3.37 DOC_INFO_LATESTRELEASE
  • 5.3.38 DOC_INFO_SIMPLE
  • 5.3.39 DOC_INFO_SIMPLE_BYREV
  • 5.3.40 DOC_SUBS_LIST
  • 5.3.41 EDIT_DOC_FORMATS
  • 5.3.42 FORM_PROCESS
  • 5.3.43 FORM_SUBMIT
  • 5.3.44 GET_CACHED_CHECKIN_INFO
  • 5.3.45 GET_DOC_CONFIG_INFO
  • 5.3.46 GET_DOC_SUBSCRIBERS
  • 5.3.47 GET_ENVIRONMENT
  • 5.3.48 GET_EXPIRED
  • 5.3.49 GET_PACKAGE_ENVIRONMENT_PAGE
  • 5.3.50 GET_UPDATE_FORM
  • 5.3.51 NOTIFY_INDEXER
  • 5.3.52 ODMA_DOC_INFO_SIMPLE
  • 5.3.53 PACKAGE_ENVIRONMENT
  • 5.3.54 REMOVE_METAFILE_SUB
  • 5.3.55 REPLACE_METAFILE_SUB
  • 5.3.56 RESUBMIT_FOR_CONVERSION
  • 5.3.57 REV_HISTORY
  • 5.3.58 SELECTDOC
  • 5.3.59 SUBMIT_HTML_FORM
  • 5.3.60 SUBSCRIBE
  • 5.3.61 SUBSCRIBE_DOC_USER
  • 5.3.62 SUBSCRIBE_EX
  • 5.3.63 SUBSCRIBE_FORM
  • 5.3.64 SUBSCRIPTION_LIST
  • 5.3.65 UNDO_CHECKOUT
  • 5.3.66 UNDO_CHECKOUT_BY_NAME
  • 5.3.67 UNSUBSCRIBE
  • 5.3.68 UNSUBSCRIBE_FORM
  • 5.3.69 UNSUBSCRIBE_FROM_LIST
  • 5.3.70 UNSUBSCRIBE_FROM_LIST_EX
  • 5.3.71 UPDATE_BYREV
  • 5.3.72 UPDATE_DOCINFO
  • 5.3.73 UPDATE_DOCINFO_BYFORM
  • 5.3.74 UPDATE_DOCINFO_BYREV
  • 5.3.75 UPDATE_DOCINFO_METAFILE_BYREV
  • 5.3.76 UPDATE_DOCINFO_STATUS
  • 5.3.77 UPDATE_DOCINFO_SUB
  • 5.3.78 UPDATE_SUBSCRIPTION_NOTIFY
  • 5.3.79 UPDATE_SUBSCRIPTION_TYPE
  • 5.3.80 UPDATE_SUBSCRIPTION_USED
  • 5.3.81 UPDATE_METADATA
  • 5.3.82 VALIDATE_DOCINFO
  • 5.3.83 WORK_IN_PROGRESS
• 5.4 Doc Profile Services (Core Content Server)
  • 5.4.1 ADD_DOCPROFILE
  • 5.4.2 ADD_DOCRULE
  • 5.4.3 DELETE_DOCPROFILE
  • 5.4.4 DELETE_DOCRULE
  • 5.4.5 DOCPROFILE_PREVIEW
  • 5.4.6 EDIT_DOCPROFILE
  • 5.4.7 EDIT_DOCPROFILE_TRIGGER
  • 5.4.8 EDIT_DOCRULE
  • 5.4.9 GET_DOCPROFILE
  • 5.4.10 GET_DOCPROFILES
  • 5.4.11 GET_DOCRULE
  • 5.4.12 GET_DOCRULES
• 5.5 File Services (Core Content Server)
  • 5.5.1 ADD_WEB_APP
  • 5.5.2 APPEND_FILE_CACHING_INFO
  • 5.5.3 GET_DYNAMIC_CONVERSION
  • 5.5.4 GET_DYNAMIC_CONVERSION_SUB
  • 5.5.5 GET_DYNAMIC_URL
  • 5.5.6 GET_EXTERNAL_DYNAMIC_CONVERSION
  • 5.5.7 GET_TEMPLATE_CONVERSIONS
  • 5.5.8 GET_WEB_APP_STATUS
  • 5.5.9 LOAD_RESOURCE_FILE
  • 5.5.10 REMOVE_WEB_APP
  • 5.5.11 SAVE_TEMPLATE_CONVERSIONS
• 5.6 Indexer Services (Core Content Server)
  • 5.6.1 CANCEL_SEARCH_INDEX
  • 5.6.2 CONTROL_SEARCH_INDEX
  • 5.6.3 GET_FILE
  • 5.6.4 START_SEARCH_INDEX
• 5.7 Internal Services (Core Content Server)
  • 5.7.1 CANCEL_COMPONENT_INSTALL
  • 5.7.2 CLEAR_SERVER_OUTPUT
  • 5.7.3 DOWNLOAD_COMPONENT
  • 5.7.4 GET_COMPONENT_CONFIG
  • 5.7.5 GET_COMPONENT_INSTALL_FORM
  • 5.7.6 GET_COMPONENT_INSTALL_PROMPTS_FORM
  • 5.7.7 GET_COMPONENT_INSTALL_SETTINGS'
  • 5.7.8 GET_LOCAL_REGISTRATION_FORM
  • 5.7.9 GET_MANIFEST_INFO
  • 5.7.10 GET_SERVER_OUTPUT
  • 5.7.11 PROXIED_REQUEST
  • 5.7.12 UNINSTALL_COMPONENT
  • 5.7.13 UPDATE_COMPONENT_CONFIG
  • 5.7.14 UPDATE_LICENSE
  • 5.7.15 UPLOAD_NEW_COMPONENT
• 5.8 Meta Services (Core Content Server)
  • 5.8.1 ADD_METADEF
  • 5.8.2 DEL_METADEF
  • 5.8.3 EDIT_METADEF
  • 5.8.4 GET_ADVANCED_SEARCH_OPTIONS
  • 5.8.5 GET_DOC_METADATA_INFO
  • 5.8.6 GET_OPTION_LIST
  • 5.8.7 GET_USER_METADATA_INFO
  • 5.8.8 MOVE_METADEF
  • 5.8.9 UPDATE_ADVANCED_SEARCH_OPTIONS
  • 5.8.10 UPDATE_USER_META
  • 5.8.11 UPDATE_USER_META_TABLE
  • 5.8.12 UPDATE_META_TABLE
  • 5.8.13 UPDATE_OPTION_LIST
• 5.9 Miscellaneous Services (Core Content Server)
  • 5.9.1 CHUNKED_UPLOAD
  • 5.9.2 DOWNLOAD_LISTBOX_ITEMS
  • 5.9.3 LOAD_USER_LOCALIZATION
• 5.10 Page Handler/Page Request Services (Core Content Server)
  • 5.10.1 DELETE_RESULT_TEMPLATE
  • 5.10.2 GET_ADMIN_PAGE
  • 5.10.3 GET_DOC_PAGE
  • 5.10.4 GET_DYNAMIC_PAGE
  • 5.10.5 GET_PERSONALIZED_JAVASCRIPT
  • 5.10.6 GET_PORTAL_PAGE
  • 5.10.7 GET_SECURE_PAGE
  • 5.10.8 LOAD_GLOBALINCLUDES
  • 5.10.9 PAGE_HANDLER
  • 5.10.10 PNE_SAVE_QUERY
  • 5.10.11 PNE_UPDATE_PERSONAL_URLS
  • 5.10.12 PNE_UPDATE_PORTAL_INFO
  • 5.10.13 SAVE_GLOBALINCLUDES
  • 5.10.14 UPDATE_RESULT_TEMPLATE
• 5.11 Provider Manager Services (Core Content Server)
  • 5.11.1 ADD_EDIT_PROVIDER
  • 5.11.2 APPEND_DATABASE_AUDIT_INFO
  • 5.11.3 DELETE_PROVIDER
  • 5.11.4 ENABLE_DISABLE_PROVIDER
  • 5.11.5 GET_ADD_EDIT_PROVIDER_FORM
  • 5.11.6 GET_ALL_PROVIDERS
  • 5.11.7 GET_PROVIDER_INFO
  • 5.11.8 NOTIFY_CHANGE
  • 5.11.9 REQUEST_SECURITYINFO
  • 5.11.10 TEST_PROVIDER
• 5.12 Schema Services (Core Content Server)
  • 5.12.1 ADD_SCHEMA_FIELD
  • 5.12.2 ADD_SCHEMA_RELATION
  • 5.12.3 ADD_SCHEMA_VIEW
  • 5.12.4 ADDOREDIT_SCHEMA_TABLE
  • 5.12.5 CONTROL_SCHEMA
  • 5.12.6 DELETE_SCHEMA_FIELD
  • 5.12.7 DELETE_SCHEMA_RELATION
  • 5.12.8 DELETE_SCHEMA_TABLE
  • 5.12.9 DELETE_SCHEMA_VIEW
  • 5.12.10 EDIT_SCHEMA_FIELD
  • 5.12.11 EDIT_SCHEMA_NODE
  • 5.12.12 EDIT_SCHEMA_RELATION
  • 5.12.13 EDIT_SCHEMA_VIEW
  • 5.12.14 EDIT_SCHEMA_VIEW_VALUES
  • 5.12.15 GET_SCHEMA_FIELD_INFO
  • 5.12.16 GET_SCHEMA_FIELDS
  • 5.12.17 GET_SCHEMA_RELATIONS
  • 5.12.18 GET_SCHEMA_STATS
  • 5.12.19 GET_SCHEMA_TABLE_INFO
  • 5.12.20 GET_SCHEMA_TABLES
  • 5.12.21 GET_SCHEMA_VIEW_EDIT_INFO
  • 5.12.22 GET_SCHEMA_VIEW_FRAGMENT
  • 5.12.23 GET_SCHEMA_VIEW_INFO
  • 5.12.24 GET_SCHEMA_VIEW_VALUES
  • 5.12.25 GET_SCHEMA_VIEWS
  • 5.12.26 PUBLISH_SCHEMA
• 5.13 Search Services (Core Content Server)
  • 5.13.1 APPEND_SEARCH_AUDIT_INFO
  • 5.13.2 GET_EXTERNAL_DOC_INFO
  • 5.13.3 GET_EXTERNAL_HIGHLIGHT_INFO
  • 5.13.4 GET_EXTERNAL_XML_HIGHLIGHT_INFO
  • 5.13.5 GET_HIGHLIGHT_INFO
  • 5.13.6 GET_SEARCH_RESULTS
  • 5.13.7 GET_SEARCH_RESULTS_FORCELOGIN
  • 5.13.8 GET_XML_HIGHLIGHT_INFO
  • 5.13.9 PNE_GET_SEARCH_RESULTS
  • 5.13.10 VIEW_DOC
• 5.14 User Services (Core Content Server)
  • 5.14.1 ADD_ALIAS
  • 5.14.2 ADD_GROUP
  • 5.14.3 ADD_ROLE
  • 5.14.4 ADD_USER
  • 5.14.5 CHANGE_USER_AUTH_TYPE
  • 5.14.6 CHECK_USER_CREDENTIALS
  • 5.14.7 DELETE_ALIAS
  • 5.14.8 DELETE_GROUP
  • 5.14.9 DELETE_ROLE
  • 5.14.10 DELETE_USER
  • 5.14.11 EDIT_ALIAS
  • 5.14.12 EDIT_GROUP
  • 5.14.13 EDIT_ROLE
  • 5.14.14 EDIT_USER
  • 5.14.15 EDIT_USER_PROFILE
  • 5.14.16 GET_ALIASES
  • 5.14.17 GET_FILTER_ADMIN_PAGE
  • 5.14.18 GET_SELF_REGISTER_PAGE
  • 5.14.19 GET_USER_INFO
  • 5.14.20 GET_USERS
  • 5.14.21 LOAD_PNE_PORTAL
  • 5.14.22 LOAD_USER_TOPIC
  • 5.14.23 QUERY_GROUP
  • 5.14.24 QUERY_USER_ATTRIBUTES
  • 5.14.25 REGISTER_USER
  • 5.14.26 SAVE_USER_TOPICS
  • 5.14.27 UPDATE_FILTER_INFO
  • 5.14.28 UPDATE_USEROPTION_LIST
• 5.15 Collaboration Services (Core Content Server)
  • 5.15.1 ADD_COLLABORATION
  • 5.15.2 ADD_COLLABORATION_FORM
  • 5.15.3 DELETE_COLLABORATION
  • 5.15.4 EDIT_CLBRA_ACCESS_LIST
  • 5.15.5 EDIT_CLBRA_ACCESS_LIST_FORM
  • 5.15.6 EDIT_COLLABORATION
  • 5.15.7 EDIT_COLLABORATION_FORM
  • 5.15.8 GET_CLBRA_DOCUMENTS
  • 5.15.9 GET_CLBRA_INFO
  • 5.15.10 GET_COLLABORATION_LIST
  • 5.15.11 GET_USER_CLBRA_LIST

6 Workflow Services

• 6.1 About Workflow Services
• 6.2 Doc and General Services (Workflows)
  • 6.2.1 ADD_PROBLEMREPORT
  • 6.2.2 DELETE_PROBLEMREPORT
  • 6.2.3 GET_CRITERIA_WORKFLOWS_FOR_GROUP
  • 6.2.4 GET_DOCUMENT_PROBLEMREPORTS
  • 6.2.5 GET_PROBLEMREPORTS_SEARCH_FORM
  • 6.2.6 GET_PROBLEMREPORTS_SEARCH_RESULTS
  • 6.2.7 GET_UPDATE_PROBLEMREPORT_FORM
  • 6.2.8 GET_WORKFLOWDOCUMENTS
  • 6.2.9 GET_WORKFLOWS_FOR_ALL
  • 6.2.10 LOAD_WORKFLOW_QUEUE
  • 6.2.11 NOTIFY_CONTRIBUTOR
  • 6.2.12 PROBLEMREPORT_INFO
  • 6.2.13 RESEND_PROBLEMREPORT
  • 6.2.14 REVIEW_WORKFLOW_DOC
  • 6.2.15 UPDATE_PROBLEMREPORT
  • 6.2.16 WORKFLOW_CHECKIN_SUB
  • 6.2.17 WORKFLOW_EDIT_REV
  • 6.2.18 WORKFLOW_NEW_REV
  • 6.2.19 WORKFLOW_REJECT_FORM
• 6.3 Workflow Template Services
  • 6.3.1 ADD_WF_TEMPLATE
  • 6.3.2 DELETE_WF_TEMPLATE
  • 6.3.3 EDIT_WF_TEMPLATE
  • 6.3.4 GET_WF_TEMPLATE
  • 6.3.5 GET_WF_TEMPLATES
• 6.4 Workflow Services
  • 6.4.1 ADD_WORKFLOW
  • 6.4.2 ADD_WORKFLOW_SCRIPT
  • 6.4.3 ADD_WORKFLOW_TOKEN
  • 6.4.4 ADD_WORKFLOWALIASES
  • 6.4.5 ADD_WORKFLOWDOCUMENT
  • 6.4.6 ADD_WORKFLOWDOCUMENT_SUB
  • 6.4.7 ADD_WORKFLOWDOCUMENTS
  • 6.4.8 ADD_WORKFLOWSTEP
  • 6.4.9 CRITERIAWORKFLOW_DISABLE
  • 6.4.10 CRITERIAWORKFLOW_DISABLE_SUB
  • 6.4.11 CRITERIAWORKFLOW_ENABLE
  • 6.4.12 DELETE_WFCONTRIBUTORS
  • 6.4.13 DELETE_WORKFLOW
  • 6.4.14 DELETE_WORKFLOW_SCRIPT
  • 6.4.15 DELETE_WORKFLOW_TOKEN
  • 6.4.16 DELETE_WORKFLOWCRITERIA
  • 6.4.17 DELETE_WORKFLOWDOCUMENTS
  • 6.4.18 DELETE_WORKFLOWSTEP
  • 6.4.19 EDIT_WORKFLOW
  • 6.4.20 EDIT_WORKFLOW_SCRIPT
  • 6.4.21 EDIT_WORKFLOW_TOKEN
  • 6.4.22 EDIT_WORKFLOWCRITERIA
  • 6.4.23 EDIT_WORKFLOWSTEP
  • 6.4.24 GET_ACTIVE_WORKFLOWS
  • 6.4.25 GET_ALL_WORKFLOWDOCREVISIONS
  • 6.4.26 GET_CRITERIA_WORKFLOWS_FOR_GROUP
  • 6.4.27 GET_WF_COMPANION_INFO
  • 6.4.28 GET_WORKFLOW
  • 6.4.29 GET_WORKFLOW_INFO
  • 6.4.30 GET_WORKFLOW_INFO_BYNAME
  • 6.4.31 GET_WORKFLOW_SCRIPT
  • 6.4.32 GET_WORKFLOWDOCREVISIONS
  • 6.4.33 GET_WORKFLOWS
  • 6.4.34 TEST_WORKFLOW_SCRIPT
  • 6.4.35 WORKFLOW_APPROVE
  • 6.4.36 WORKFLOW_CANCEL
  • 6.4.37 WORKFLOW_CHECKIN
  • 6.4.38 WORKFLOW_EDIT_APPROVE
  • 6.4.39 WORKFLOW_REJECT
  • 6.4.40 WORKFLOW_START

7 Archiving Services

• 7.1 About Archiving Services
• 7.2 Archive Services
  • 7.2.1 ADD_ARCHIVE
  • 7.2.2 ADD_COLLECTION
  • 7.2.3 ADD_PROXIEDCOLLECTION
  • 7.2.4 CANCEL_ARCHIVE
  • 7.2.5 CHECKIN_ARCHIVE
  • 7.2.6 COPY_ARCHIVE
  • 7.2.7 DELETE_ARCHIVE
  • 7.2.8 DELETE_BATCH_FILE
  • 7.2.9 DELETE_BATCH_FILE_DOCUMENTS
  • 7.2.10 DELETE_BATCH_FILE_TABLES
  • 7.2.11 EDIT_ARCHIVE
  • 7.2.12 EDIT_ARCHIVEDATA
  • 7.2.13 EDIT_EXPORTERS
  • 7.2.14 EDIT_TRANSFEROPTIONS
  • 7.2.15 EXECUTE_BATCH
  • 7.2.16 EXPORT_ARCHIVE
  • 7.2.17 GET_ARCHIVECOLLECTIONS
  • 7.2.18 GET_ARCHIVETABLECONTENT
  • 7.2.19 GET_ARCHIVED_FILE
  • 7.2.20 GET_ARCHIVES
  • 7.2.21 GET_ARCHIVERELATIONQUERY
  • 7.2.22 GET_BATCH_FILE_DOCUMENTS
  • 7.2.23 GET_BATCH_PROPERTIES
  • 7.2.24 GET_BATCH_SCHEMA
  • 7.2.25 GET_BATCH_VALUES
  • 7.2.26 GET_BATCHFILES
  • 7.2.27 GET_PROXIED_ARCHIVECOLLECTIONS
  • 7.2.28 GET_PROXIEDSERVERS
  • 7.2.29 GET_REPLICATION_DATA
  • 7.2.30 GET_TABLECOLUMNLIST
  • 7.2.31 GET_TARGET_INFO
  • 7.2.32 GET_TARGET_TRANSFER_STATUS
  • 7.2.33 GET_TRANSFER_SOURCE_INFO
  • 7.2.34 IMPORT_ARCHIVE
  • 7.2.35 IMPORT_ARCHIVE_START_AUTOMATED
  • 7.2.36 IMPORT_BATCHFILE
  • 7.2.37 IMPORT_DOCUMENT
  • 7.2.38 IMPORT_TABLE_ENTRY
  • 7.2.39 INSERT_NATIVE
  • 7.2.40 INSERT_NEW
  • 7.2.41 REGISTER_IMPORTER
  • 7.2.42 REMOVE_COLLECTION
  • 7.2.43 REMOVE_EXPORTER
  • 7.2.44 REMOVE_IMPORTER
  • 7.2.45 REMOVE_PROXIEDTRANSFER
  • 7.2.46 REMOVE_QUEUED_IMPORT
  • 7.2.47 REMOVE_TRANSFER
  • 7.2.48 REQUEST_TRANSFER
  • 7.2.49 TRANSFER_ARCHIVE
  • 7.2.50 UPDATE_TARGET_TOTALS
  • 7.2.51 UPDATE_TRANSFER_STATUS
  • 7.2.52 UPLOAD_ARCHIVE_TRANSFER

8 Folders Services

• 8.1 About Folder Services
• 8.2 Folder Services
  • 8.2.1 COLLECTION_ADD
  • 8.2.2 COLLECTION_ADD_LINK
  • 8.2.3 COLLECTION_ADD_MOUNT
  • 8.2.4 COLLECTION_BROWSE
  • 8.2.5 COLLECTION_CHECKIN_NEW
  • 8.2.6 COLLECTION_CHECKIN_REVISION
  • 8.2.7 COLLECTION_CHECKIN_SEL_SUB
  • 8.2.8 COLLECTION_COPY_ALL
  • 8.2.9 COLLECTION_COPY_COLLECTION
  • 8.2.10 COLLECTION_COPY_ITEM
  • 8.2.11 COLLECTION_COPY_LOT
  • 8.2.12 COLLECTION_DELETE_ALL
  • 8.2.13 COLLECTION_DELETE_COLLECTION
  • 8.2.14 COLLECTION_DELETE_ITEM
  • 8.2.15 COLLECTION_DELETE_LOT
  • 8.2.16 COLLECTION_DISPLAY
  • 8.2.17 COLLECTION_EDIT
  • 8.2.18 COLLECTION_GET_ADMIN_CONFIG
  • 8.2.19 COLLECTION_GET_ADMIN_INHERIT_CONFIG
  • 8.2.20 COLLECTION_GET_ADMIN_MARKED_CONFIG
  • 8.2.21 COLLECTION_GET_ADMIN_META_CONFIG
  • 8.2.22 COLLECTION_GET_ADMIN_METADATA_DEFAULTS
  • 8.2.23 COLLECTION_GET_ADMIN_MOUNTED_CONFIG
  • 8.2.24 COLLECTION_GET_ARCHIVE
  • 8.2.25 COLLECTION_GET_BRANCH
  • 8.2.26 COLLECTION_GET_COLLECTION
  • 8.2.27 COLLECTION_GET_COLLECTIONS
  • 8.2.28 COLLECTION_GET_CONTENT_FILE
  • 8.2.29 COLLECTION_GET_CONTENTS
  • 8.2.30 COLLECTION_GET_FILE
  • 8.2.31 COLLECTION_GET_INFO
  • 8.2.32 COLLECTION_GET_LINKS
  • 8.2.33 COLLECTION_GET_META_MAPPING
  • 8.2.34 COLLECTION_GET_PROFILE_METADATA_DEFAULTS
  • 8.2.35 COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS
  • 8.2.36 COLLECTION_GET_REFERENCE
  • 8.2.37 COLLECTION_GET_SEARCH_FORM
  • 8.2.38 COLLECTION_GET_SYSTEM_FILE
  • 8.2.39 COLLECTION_GET_USER_CONFIG
  • 8.2.40 COLLECTION_INDEX_MOUNTS
  • 8.2.41 COLLECTION_INFO
  • 8.2.42 COLLECTION_ISVALID_META
  • 8.2.43 COLLECTION_LOCK
  • 8.2.44 COLLECTION_MOVE_ALL
  • 8.2.45 COLLECTION_MOVE_COLLECTION
  • 8.2.46 COLLECTION_MOVE_ITEM
  • 8.2.47 COLLECTION_MOVE_LOT
  • 8.2.48 COLLECTION_NEW
  • 8.2.49 COLLECTION_PROFILE_UPDATE_COLUMNS
  • 8.2.50 COLLECTION_REBUILD_MOUNT
  • 8.2.51 COLLECTION_REMOVE_MOUNT
  • 8.2.52 COLLECTION_RESTORE_COLLECTION
  • 8.2.53 COLLECTION_RESTORE_ITEM
  • 8.2.54 COLLECTION_SEARCH_CONTENT
  • 8.2.55 COLLECTION_SEARCH_RESULTS
  • 8.2.56 COLLECTION_SET_ARCHIVE
  • 8.2.57 COLLECTION_SET_USER_CONFIG
  • 8.2.58 COLLECTION_UNLOCK
  • 8.2.59 COLLECTION_UPDATE
  • 8.2.60 COLLECTION_UPDATE_ADMIN_CONFIG
  • 8.2.61 COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG
  • 8.2.62 COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS
  • 8.2.63 COLLECTION_UPDATE_ALL
  • 8.2.64 COLLECTION_UPDATE_ITEM
  • 8.2.65 COLLECTION_UPDATE_META
  • 8.2.66 COLLECTION_UPDATE_META_TABLE
  • 8.2.67 COLLECTION_UPDATE_MOUNTS
  • 8.2.68 COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS
  • 8.2.69 COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS
  • 8.2.70 COLLECTION_UPDATE_STRUCTURE
  • 8.2.71 GOTO_COLLECTION
  • 8.2.72 GOTO_ROOT_COLLECTION
  • 8.2.73 GET_OPTION_LISTS

9 Content Publisher Services

• 9.1 About Content Publisher Services
• 9.2 Content Publisher Services
  • 9.2.1 CHECKIN_PUBLISH
  • 9.2.2 END_PUBLISHING
  • 9.2.3 GET_PREVIEW_LIST
  • 9.2.4 GET_PREVIEW_LIST_EX
  • 9.2.5 GET_PROJECT_ACTIONS
  • 9.2.6 GET_PROJECT_INFO
  • 9.2.7 GET_PROJECT_REGISTRATION
  • 9.2.8 GET_REGISTEREDPROJECTS
  • 9.2.9 PREVIEW_DOCUMENT
  • 9.2.10 REGISTER_PROJECT
  • 9.2.11 START_PUBLISHING
  • 9.2.12 UNREGISTER_PROJECT

10 Universal Record Manager Services

• 10.1 About Record Manager Services
• 10.2 Record Manager Services
  • 10.2.1 ACTIVATE_SERVICE
  • 10.2.2 APPROVE_DELETE_SERVICE
  • 10.2.3 BROWSE_CATEGORY_FORM
  • 10.2.4 BROWSE_FOLDER_FORM
  • 10.2.5 BROWSE_SERIES_FORM
  • 10.2.6 CHECKIN_NEW_REVISION_SERVICE
  • 10.2.7 CHECKIN_SIMILAR_FORM
  • 10.2.8 CLEAR_FOLDER_CANCELLED_DATE
  • 10.2.9 CLEAR_FOLDER_EXPIRATION_DATE
  • 10.2.10 CLEAR_FOLDER_OSBOLETE_DATE
  • 10.2.11 CLEAR_FOLDER_RESCINDED_DATE
  • 10.2.12 CLEAR_FOLDER_REVIEW_DATE
  • 10.2.13 CLEAR_RECORD_CANCELLED_DATE
  • 10.2.14 CLEAR_RECORD_EXPIRATION_DATE
  • 10.2.15 CLEAR_RECORD_OBSOLETE_DATE
  • 10.2.16 CLOSE_FOLDER
  • 10.2.17 CREATE_FOLDER
  • 10.2.18 CREATE_FOLDER_FORM
  • 10.2.19 DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE
  • 10.2.20 DELETE_FOLDER
  • 10.2.21 DELETE_REVISION_SERVICE
  • 10.2.22 EDIT_FOLDER
  • 10.2.23 EDIT_FOLDER_FORM
  • 10.2.24 FREEZE_FOLDER
  • 10.2.25 FREEZE_RECORD
  • 10.2.26 INFO_CATEGORY_FORM
  • 10.2.27 INFO_FOLDER_FORM
  • 10.2.28 INFO_FOLDER_LIFECYCLE
  • 10.2.29 INFO_FOLDER_METADATA_HISTORY
  • 10.2.30 INFO_FOLDER_REVIEW_HISTORY
  • 10.2.31 INFO_RECORD_LIFECYCLE
  • 10.2.32 INFO_RECORD_METADATA_HISTORY
  • 10.2.33 INFO_RECORD_REVIEW_HISTORY
  • 10.2.34 INFO_SERIES_FORM
  • 10.2.35 MARK_FOLDER_ACTIVATION_DATE
  • 10.2.36 MARK_FOLDER_CANCELLED_DATE
  • 10.2.37 MARK_FOLDER_EXPIRATION_DATE
  • 10.2.38 MARK_FOLDER_OBSOLETE_DATE
  • 10.2.39 MARK_FOLDER_RESCINDED_DATE
  • 10.2.40 MARK_FOLDER_REVIEW_DATE
  • 10.2.41 MARK_FOLDER_REVIEW_DATE_ RECURSIVE
  • 10.2.42 MARK_RECORD_CANCELLED_DATE
  • 10.2.43 MARK_RECORD_EXPIRATION_DATE
  • 10.2.44 MARK_RECORD_OBSOLETE_DATE
  • 10.2.45 MARK_RECORD_RESCINDED_DATE
  • 10.2.46 MARK_RECORD_REVIEW_DATE
  • 10.2.47 MOVE_FOLDER
  • 10.2.48 PREVIEW_RECORD_LIFECYCLE
  • 10.2.49 RMA_CLOSE_SERVICE
  • 10.2.50 RMA_CUTOFF_SERVICE
  • 10.2.51 RMA_DESTROY_SERVICE
  • 10.2.52 RMA_EXPORT_ARCHIVE_SERVICE
  • 10.2.53 RMA_EXPORT_SERVICE
  • 10.2.54 RMA_MARK_COMPLETED
  • 10.2.55 RMA_NO_ACTION_SERVICE
  • 10.2.56 RMA_OBSOLETE_SERVICE
  • 10.2.57 RMA_SCRUB_SERVICE
  • 10.2.58 RMA_SUPERSEDE_SERVICE
  • 10.2.59 UNCLOSE_FOLDER
  • 10.2.60 UNFREEZE_FOLDER
  • 10.2.61 UNFREEZE_RECORD

11 Extended User Attributes Services

• 11.1 About Extended User Attributes Services
• 11.2 Extended User Attributes Services
  • 11.2.1 ADD_EXTENDED_USER_ATTRIBUTES
  • 11.2.2 EDIT_EXTENDED_USER_ATTRIBUTES
  • 11.2.3 DELETE_EXTENDED_USER_ATTRIBUTES
  • 11.2.4 DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION
  • 11.2.5 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER
  • 11.2.6 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION
  • 11.2.7 QUERY_EXTENDED_USER_ATTRIBUTES
  • 11.2.8 QUERY_EXTENDED_ATTRIBUTE_MAPPINGS
  • 11.2.9 EC_SET_PROPERTY
  • 11.2.10 EC_DELETE_PROPERTY
  • 11.2.11 EC_GET_PROPERTY
  • 11.2.12 EC_GET_PROPERTY_BY_KEY
  • 11.2.13 SET_DEFAULT_ATTRIBUTES
  • 11.2.14 DELETE_DEFAULT_ATTRIBUTES
  • 11.2.15 GET_DEFAULT_ATTRIBUTES
  • 11.2.16 SET_EXTENDED_ATTRIBUTE_MAPPINGS
  • 11.2.17 DELETED_EXTENDED_ATTRIBUTE_MAPPINGS
  • 11.2.18 ADD_USER
  • 11.2.19 EDIT_USER
  • 11.2.20 DELETE_USER
  • 11.2.21 QUERY_USER_ATTRIBUTES

12 Folios Services

• 12.1 Folio Services
  • 12.1.1 LOAD_FOLIO_NODE
  • 12.1.2 UPDATE_FOLIO
  • 12.1.3 CHECKIN_NEW_FOLIO
  • 12.1.4 CREATE_FOLIO_SNAPSHOT
  • 12.1.5 LOCK_FOLIO
  • 12.1.6 UNLOCK_FOLIO
  • 12.1.7 CREATE_FOLIO_RENDITION
  • 12.1.8 GENERATE_GUIDS

13 VirtualContentRepository Services

• 13.1 VirtualContentRepository Services
  • 13.1.1 VCR_GET_CONTENT_TYPE
  • 13.1.2 VCR_GET_CONTENT_TYPES
  • 13.1.3 VCR_GET_DOCUMENT
  • 13.1.4 VCR_GET_DOCUMENT_BY_NAME

A Actions

• A.1 About Service Actions
• A.2 A
• A.3 B
• A.4 C
• A.5 D
• A.6 E
• A.7 F
• A.8 G
• A.9 H
• A.10 I
• A.11 L
• A.12 M
• A.13 N
• A.14 P
• A.15 Q
• A.16 R
• A.17 S
• A.18 T
• A.19 U
• A.20 V

Index