Go to the http://www.awareim.com/dtd/ folder.
You should see 3 files. You can right-click on them and save them to your machine.
The following is in the Aware.dtd file:
<!-- DTD for the component that can call Aware IM server using XML -->
<!-- Definitions of generic types as well as business space version is included here -->
<!ENTITY % BSV SYSTEM "bsv.dtd">
%BSV;
<!-- This is BASE64 encoded binary data -->
<!ELEMENT binary_data (CDATA) >
<!ELEMENT binary_file (binary_data) >
<!ATTLIST binary_file file_name CDATA #REQUIRED>
<!ELEMENT object_identifier EMPTY >
<!ATTLIST object_identifier name %ObjectName; #REQUIRED>
<!ATTLIST object_identifier id ID #REQUIRED>
<!ELEMENT attribute EMPTY >
<!ATTLIST attribute name %AttributeName; #REQUIRED>
<!ELEMENT attribute_value EMPTY >
<!ATTLIST attribute_value name %AttributeName; #REQUIRED>
<!ATTLIST attribute_value value CDATA #IMPLIED>
<!ELEMENT reference_value (object_identifier*) >
<!ATTLIST reference_value name %AttributeName; #REQUIRED>
<!ELEMENT business_object ((attribute_value)|(reference_value)) >
<!ATTLIST business_object id ID #REQUIRED>
<!ATTLIST business_object name %ObjectName; #REQUIRED>
<!ATTLIST business_object version_no %Integer; #REQUIRED>
<!ELEMENT business_object_template ((attribute_value)|(reference_value)) >
<!ATTLIST business_object_template name %ObjectName; #REQUIRED>
<!ELEMENT notification ((attribute_value)|(reference_value)) >
<!ATTLIST notification name %ObjectName; #REQUIRED>
<!-- Nested objects or templates are those used during inline editing -->
<!ELEMENT nested_objects (business_object+) >
<!ATTLIST nested_objects name %AttributeName; #REQUIRED>
<!ELEMENT nested_templates (business_object_template+) >
<!ATTLIST nested_templates name %AttributeName; #REQUIRED>
<!-- Context used when running a process or query -->
<!ELEMENT context_element (object_identifier|business_object_template) >
<!ELEMENT context (context_element+) >
<!ELEMENT session_id (#PCDATA) >
<!ELEMENT process_id (%Integer😉 >
<!-- The data contains reason for failure -->
<!ELEMENT failure (#PCDATA) >
<!ELEMENT success EMPTY >
<!-- These are all different parameters for different types of actions that the SERVER may require the client
to execute (see action_request)
-->
<!ELEMENT enter_new_params (business_object_template?) >
<!ATTLIST enter_new_params object_name %ObjectName; #REQUIRED>
<!ATTLIST enter_new_params form_name %FormName; #IMPLIED>
<!ELEMENT edit_view_params (business_object|object_identifier) >
<!ATTLIST edit_view_params read_only %Boolean; "false">
<!ATTLIST edit_view_params form_name %FormName; #IMPLIED>
<!ELEMENT display_document_params (binary_file?) >
<!ATTLIST display_document_params document_name %DocumentName; #IMPLIED>
<!ELEMENT display_pick_from_params (query_definition, object_identifier*) >
<!ATTLIST display_pick_from_params multi_select %Boolean; "false">
<!ATTLIST display_pick_from_params no_confirmation_for_one %Boolean; "false">
<!ELEMENT display_message_question_params EMPTY >
<!ATTLIST display_message_question_params message CDATA #REQUIRED>
<!ATTLIST display_message_question_params is_question %Boolean; "false">
<!ELEMENT display_url_params EMPTY >
<!ATTLIST display_url_params url CDATA #REQUIRED>
<!ELEMENT run_query_params (query_definition) >
<!-- This may be returned upon execution of certain actions that the CLIENT wants SERVER to execute. This request
indicates that the rule action has been invoked that requires user interaction, such as creating an object
using a form, picking from a list of objects etc. Essentially this represents a request of the SERVER to the
CLIENT to perform some user interaction in response to the original client's request
-->
<!ELEMENT action_request (process_id, (enter_new_params|edit_view_params|display_document_params|display_pick_from_params|display_message_question_params|run_query_params|display_url_params)) >
<!ATTLIST action_request action_name (enter_new|edit|view|display_document|display|pick_from|display_message|display_question|run_query|display_url) #REQUIRED>
<!ATTLIST action_request reply_expected %Boolean; "true">
<!-- Login action. If business space is not specified, default is used. If user_name is not specified - guest login -->
<!ELEMENT login_action EMPTY >
<!ATTLIST login_action business_space CDATA #IMPLIED>
<!ATTLIST login_action user_name CDATA #IMPLIED>
<!ATTLIST login_action password CDATA #IMPLIED>
<!ATTLIST login_action testing_mode %Boolean; "false">
<!ELEMENT login_action_return (session_id|failure) >
<!ELEMENT logout_action (session_id?) >
<!-- Return the current business space version -->
<!ELEMENT get_business_space_version_action (session_id?) >
<!ELEMENT get_business_space_version_action_return (business_space_version|failure) >
<!-- Return the current business space version for testing -->
<!ELEMENT get_test_version_action (session_id?) >
<!ELEMENT get_test_version_action_return (business_space_version|failure) >
<!-- Create a new business object from template. Nested templates should be used only if related objects
are created at the same time (for example, during inline editing). -->
<!ELEMENT create_object_action (session_id?, business_object_template, nested_templates*) >
<!ELEMENT create_object_action_return (business_object|action_request|failure) >
<!-- Modify a business object with new values. Nested templates or objects should be used only if related objects
are created/modified at the same time (for example, during inline editing). -->
<!ELEMENT modify_object_action (session_id?, business_object, ((nested_templates)|nested_objects)) >
<!ELEMENT modify_object_action_return (success|action_request|failure) >
<!ELEMENT stack_frame (CDATA) >
<!ELEMENT process_frame (CDATA) >
<!ELEMENT form_context (stack_frame, process_frame, (business_object | business_object_template)) >
<!ATTLIST form_context form %FormName; #REQUIRED>
<!ATTLIST form_context section %SectionName; #REQUIRED>
<!ATTLIST form_context mode (create|modify|view) #REQUIRED>
<!-- get_form_context_action and post_form_context_action should be used in custom forms -->
<!ELEMENT get_form_context_action (session_id?) >
<!ELEMENT get_form_context_action_return (form_context|failure) >
<!ELEMENT next_form EMPTY >
<!ELEMENT prev_form EMPTY >
<!ELEMENT cancel EMPTY >
<!ELEMENT post_form_context_action (session_id?, stack_frame, process_frame, (create_object_action|modify_object_action|next_form|prev_form|cancel)) >
<!ATTLIST post_form_context_action mode (create|modify|view) #REQUIRED>
<!ELEMENT post_form_context_action_return (success|failure) >
<!-- Delete business objects -->
<!ELEMENT delete_objects_action (session_id?, object_identifier+) >
<!ELEMENT delete_objects_action_return (success|action_request|failure) >
<!-- get the specified objects from the server -->
<!ELEMENT get_objects_action (session_id?, object_identifier+) >
<!ELEMENT get_objects_action_return ((business_object+)|failure) >
<!-- When business objects are retrieved their binary attributes such as documents and pictures are not
retrieved. They are only retrieved using the following action
attribute - the attribute that is retrieved (must be binary)
-->
<!ELEMENT get_binary_data_action (session_id?, object_identifier) >
<!ATTLIST get_binary_data_action attribute %AttributeName; #REQUIRED>
<!ELEMENT get_binary_data_action_return (binary_data|failure) >
<!-- Set data of the binary attribute such as document and picture
attribute - the attribute that is set (must be binary)
-->
<!ELEMENT set_binary_data_action (session_id?, object_identifier, binary_data) >
<!ATTLIST set_binary_data_action attribute %AttributeName; #REQUIRED>
<!ELEMENT set_binary_data_action_return (success|failure) >
<!-- Get ALL references of the specified object through the specified attribute (must of reference type)
-->
<!ELEMENT get_all_references_action (session_id?, object_identifier) >
<!ATTLIST get_all_references_action attribute %AttributeName; #REQUIRED>
<!ELEMENT get_all_references_action_return ((business_object*)|failure) >
<!-- Add references to the reference attribute of the object
object_identifier - references to add
attribute - name of the reference attribute in the object
-->
<!ELEMENT add_references_action (session_id?, object_identifier, object_identifier+) >
<!ATTLIST add_references_action attribute %AttributeName; #REQUIRED>
<!ELEMENT add_references_action_return (success|action_request|failure) >
<!-- Delete references from the reference attribute of the object
object_identifier - references to delete. If not specified all references are deleted
attribute - name of the reference attribute in the object
-->
<!ELEMENT delete_references_action (session_id?, object_identifier, object_identifier*) >
<!ATTLIST delete_references_action attribute %AttributeName; #REQUIRED>
<!ELEMENT delete_references_action_return (success|action_request|failure) >
<!-- Execute the specified process
context - context of the process
-->
<!ELEMENT execute_process_action (session_id?, context?) >
<!ATTLIST execute_process_action name %ProcessName; #REQUIRED>
<!-- If process id has been returned the process takes a while to complete -->
<!ELEMENT execute_process_action_return (success|action_request|failure|process_id) >
<!-- Cancel the specified process -->
<!ELEMENT cancel_process_action (session_id?, process_id) >
<!ELEMENT cancel_process_action_return (success|failure) >
<!-- Execute service of an intelligent business object
object_identifier - provider of the service (intelligent business object)
business_object* - parameters of the service
-->
<!ELEMENT execute_object_service_action (session_id?, object_identifier, business_object*) >
<!ATTLIST execute_object_service_action name %ServiceName; #REQUIRED>
<!-- Return of the service is the notification that the service sends -->
<!ELEMENT execute_object_service_action_return (notification|action_request|failure) >
<!-- Execute service exposed by the business space
business_object* - parameters of the service
-->
<!ELEMENT execute_service_action (session_id?, business_object*) >
<!ATTLIST execute_service_action name %ServiceName; #REQUIRED>
<!-- Return of the service is the notification that the service sends -->
<!ELEMENT execute_service_action_return (notification|action_request|failure) >
<!-- Values of query parameters that need to be entered at run time -->
<!ELEMENT prompted_value EMPTY >
<!ATTLIST prompted_value key CDATA #REQUIRED>
<!ATTLIST prompted_value value CDATA #REQUIRED>
<!ELEMENT query_result (business_object*) >
<!ATTLIST query_result total_number %Integer; #REQUIRED>
<!-- Execute query having the given name -->
<!ELEMENT execute_named_query_action (session_id?, context?, prompted_value*) >
<!ATTLIST execute_named_query_action name %QueryName; #REQUIRED>
<!ATTLIST execute_named_query_action start %Integer; "1">
<!ATTLIST execute_named_query_action span %Integer; "20">
<!ELEMENT execute_named_query_action_return (query_result|failure) >
<!-- Execute the specified query -->
<!ELEMENT execute_query_action (session_id?, query_definition, context?, prompted_value*) >
<!ATTLIST execute_query_action start %Integer; "1">
<!ATTLIST execute_query_action span %Integer; "20">
<!ELEMENT execute_query_action_return (query_result|failure) >
<!ELEMENT document_path EMPTY >
<!ATTLIST document_path path CDATA #REQUIRED>
<!ELEMENT document_result (binary_file, document_path*) >
<!-- Run the specified report or document -->
<!ELEMENT run_document_action (session_id?, business_object, prompted_value) >
<!ATTLIST run_document_action name %DocumentName; #REQUIRED>
<!ATTLIST run_document_action print_results %Boolean; "false">
<!ELEMENT run_document_action_return (document_result|failure) >
<!ELEMENT process_status (process_id) >
<!ATTLIST process_status status (finished|waiting|running|failed) #REQUIRED>
<!ATTLIST process_status process_name %ProcessName; #IMPLIED>
<!ATTLIST process_status progress %Integer; #IMPLIED>
<!ATTLIST process_status startup_time CDATA #REQUIRED>
<!ATTLIST process_status error_msg CDATA #IMPLIED>
<!-- Return statuses of all processes in the system -->
<!ELEMENT get_process_statuses_action (session_id?) >
<!ELEMENT get_process_statuses_action_return ((process_status*)|failure) >
<!-- Return status of the specified process -->
<!ELEMENT get_process_status_action (session_id?, process_id) >
<!ELEMENT get_process_statuses_action_return (process_status|failure) >
<!-- Fill out the initial values of the specified business object template executing the corresponding rules -->
<!ELEMENT calculate_initial_values_action (session_id?, business_object_template) >
<!ATTLIST calculate_initial_values_action changed_attribute %AttributeName; #IMPLIED>
<!ELEMENT calculate_initial_values_action_return (business_object_template|failure) >
<!-- Invoke calculation rules of the object after it has been changed -->
<!ELEMENT recalculate_object_action (session_id?, business_object) >
<!ATTLIST recalculate_object_action changed_attribute %AttributeName; #IMPLIED>
<!ELEMENT recalculate_object_action_return (business_object|failure) >
<!ELEMENT import_results (binary_file, binary_file?) >
<!ATTLIST import_results errors_detected %Boolean; #REQUIRED>
<!-- Import the CSV file -->
<!ELEMENT import_action (session_id?, binary_file) >
<!ATTLIST import_action object_name %ObjectName; #REQUIRED>
<!ATTLIST import_action batch_size %Integer; "1000">
<!ATTLIST import_action validate %Boolean; "false">
<!ELEMENT import_action_return (import_results|failure) >
<!-- Import relationships file -->
<!ELEMENT import_relationships_action (session_id?, binary_file) >
<!ATTLIST import_relationships_action object_name %ObjectName; #REQUIRED>
<!ATTLIST import_relationships_action batch_size %Integer; "1000">
<!ELEMENT import_relationships_action_return (import_results|failure) >
<!ELEMENT export_attribute EMPTY >
<!ATTLIST export_attribute name %AttributeName; #REQUIRED>
<!ATTLIST export_attribute format CDATA #IMPLIED>
<!ELEMENT export_options (export_attribute*) >
<!ATTLIST export_options for_update %Boolean; #REQUIRED>
<!ATTLIST export_options export_binary %Boolean; "false">
<!ATTLIST export_options export_relationships %Boolean; "false">
<!ATTLIST export_options export_format (csv|html) "csv">
<!-- The first file is always an export file. The second is optional relationship file -->
<!ELEMENT export_results (binary_file, binary_file?) >
<!-- Export the CSV file -->
<!ELEMENT export_action (session_id?, query_definition, export_options) >
<!ELEMENT export_action_return (export_results|failure) >
<!ELEMENT log_settings EMPTY >
<!ATTLIST log_settings logging_level (generic|actions|rules) #REQUIRED>
<!-- Get logging settings for the current session -->
<!ELEMENT log_settings_action (session_id?) >
<!ELEMENT log_settings_action_return (log_settings|failure) >
<!-- Get log for the current session -->
<!ELEMENT log_action (session_id?) >
<!ELEMENT log_action_return (binary_file|failure) >
<!-- Get user defined template document -->
<!ELEMENT user_defined_template_action (session_id?) >
<!ATTLIST user_defined_template_action name %DocumentName; #REQUIRED>
<!ELEMENT user_defined_template_action_return (document_definition|failure) >
<!-- Change user defined template document -->
<!ELEMENT change_user_defined_template_action (session_id?, binary_file) >
<!ATTLIST change_user_defined_template_action name %DocumentName; #REQUIRED>
<!ELEMENT change_user_defined_template_action_return (success|failure) >
<!-- Reset user defined template document changed by the user to the original definition in business space version -->
<!ELEMENT reset_user_defined_template_action (session_id?) >
<!ATTLIST reset_user_defined_template_action name %DocumentName; #REQUIRED>
<!ELEMENT reset_user_defined_template_action_return (success|failure) >
<!-- Return the binary resource of the business space version, such as document, image etc -->
<!ELEMENT get_binary_resource_action (session_id?) >
<!ATTLIST get_binary_resource_action resource_key CDATA #REQUIRED>
<!ELEMENT get_binary_resource_action_return (binary_file|failure) >
<!-- These are data that UI operation is supposed to provide to the server in reply to a request for an
operation that involves interaction with the user (see action_request) -->
<!ELEMENT enter_new_data (business_object_template, nested_templates) >
<!ELEMENT edit_data (business_object, ((nested_templates)|nested_objects)) >
<!ELEMENT pick_from_data (object_identifier) >
<!ELEMENT display_question_data EMPTY >
<!ATTLIST display_question_data reply (yes|no) #REQUIRED>
<!ELEMENT display_document_data (prompted_value*) >
<!ATTLIST display_document_data name %DocumentName; #REQUIRED>
<!ELEMENT run_query_data (query_definition) >
<!-- This is used in reply_to_server_action - see below -->
<!ELEMENT reply_data (enter_new_data|edit_data|display_document_data|pick_from_data|display_question_data|run_query_data) >
<!-- The following action should be used to reply to the server after the server has requested an
operation that involves interaction with a user (see action_request)
The process id returned in the action request must be specified in the reply
-->
<!ELEMENT reply_to_server_action (session_id?, process_id, reply_data?) >
<!ATTLIST reply_to_server_action action_name (enter_new|edit|view|display_document|display|pick_from|display_message|display_question|run_query|display_url) #REQUIRED>
<!ATTLIST reply_to_server_action operation_cancelled %Boolean; "false">
<!ELEMENT reply_to_server_action_return (success|action_request|failure) >
