# Class R.E.EnvelopeRemoteServicesManager:

Part of Reportek.EnvelopeRemoteServicesManager View In Hierarchy

Known subclasses: Reportek.Envelope.Envelope

This class which Envelope subclasses from handles the integration with various remote systems (GDEM, UNS, etc.)

Line # | Kind | Name | Docs
--- | --- | --- | ---
48 | Method | hasSpecificFile | Checks if an envelope has an XML file with certain schema
54 | Method | hasFilesForSchema | If a values was provided for the p_schema_url, determine whether there are
66 | Method | canRunQAOnFiles | Returns a list of QA script labels
76 | Method | runQAScript | Runs the QA script with the specified id against
110 | Method | callQAEnvelope | Calls the envelope-level statistics, based on a script id which is different for each dataflow.
119 | Method | runQAScripts | Runs multiple QA scripts with the specified file ids
166 | Method | getDocumentsForRemoteService | Finds all Report Documents of type XML that have to begin/complete a remote operation
181 | Method | triggerApplication | Triggers remote applications
194 | Method | saveXML | Saves the XML file modified by the WebQ as Report Document
227 | Method | fetchFile | Grabbs a file from a certain location and uploads it as Report Document
246 | Method | getXMLFiles | Returns a list of the XML files in this envelope.
260 | Method | getXMLSchemas | Gets all the schemas from the contained XML files
270 | Method | getValidXMLSchemas | The purpose is to know if to put an edit button and a record in 'view as...' select
280 | Method | getWebQ_BeforeEditForm_URL | Retrieves the URL to the edit for of the XML file - if any
284 | Method | getWebQ_MenuEnvelope_URL | Retrieves the URL to the edit for of the XML file - if any

def hasSpecificFile(self, schema):
Checks if an envelope has an XML file with certain schema

def hasFilesForSchema(self, p_schema_url):
If a values was provided for the p_schema_url, determine whether there are XML files in the envelope with a certain schema. Otherwise checks if there are any files at all

def canRunQAOnFiles(self):
Returns a list of QA script labels which can be manually run against the contained XML files

def runQAScript(self, p_file_url, p_script_id, REQUEST, return_inline=0):
Runs the QA script with the specified id against the source XML file This method can be only called from the browser and the result is displayed in a temporary page or, in case 'return_inline' is not false, the result is a string

def callQAEnvelope(self, p_script_id):
Calls the envelope-level statistics, based on a script id which is different for each dataflow.

def runQAScripts(self, REQUEST):

    Runs multiple QA scripts with the specified file ids
    This method can be only called from the browser and the result is
    displayed in a temporary page

    Parameters in query string:
        file_url1=script_id11,script_id12&...
    This function assumes that all qa results have the same content type: 'text/html'

def getDocumentsForRemoteService(self):
Finds all Report Documents of type XML that have to begin/complete a remote operation Returns the dictionary of {xml_schema_location:[URL_file]}

def triggerApplication(self, p_workitem_id, REQUEST=None):
Triggers remote applications

def saveXML(self, file_id, file, schema_url='', title='', REQUEST=''):
Saves the XML file modified by the WebQ as Report Document Called by HTTP For now, the return values are file_id- success and 0 - something went wrong, but they could be detailed with error codes and values

def fetchFile(self, p_location='', p_file_name='', REQUEST=None):
Grabbs a file from a certain location and uploads it as Report Document

def getXMLFiles(self):
Returns a list of the XML files in this envelope. The return value is a struct where the key is the schemaurl and the value is a list of structs containing fileurls and file-titles

def getXMLSchemas(self):
Gets all the schemas from the contained XML files

def getValidXMLSchemas(self):
The purpose is to know if to put an edit button and a record in 'view as...' select next to XML files

def getWebQ_BeforeEditForm_URL(self):
Retrieves the URL to the edit for of the XML file - if any

def getWebQ_MenuEnvelope_URL(self):
Retrieves the URL to the edit for of the XML file - if any