Objekt TMOSCommunicator

Modul pro práci se skripty podporuje komunikaci s MaximObjServerem. Je tak možné například snadno odeslat výsledek sestavy na vzdálený server a k dispozici jsou i funkce pro manipulaci s dokumenty uloženými na vzdáleném serveru.

Objekt TMOSCommunicator

TMOSCommunicator = class
  property ErrMessage: string;
  property Connected: Boolean;
  constructor Create(IP, UserName, UserPswd: String; CodedLogin: LongInt);
  function SetupConnection(BINfile, IP, UserName, UserPswd: String; CodedLogin: LongInt): Boolean;
  function SetupConnectionBinFile(BINfile: String): Boolean;
  function Connect: Boolean;
  procedure Disconnect;
  function SendFile(FileName, AServerFileName, Email, Subject, TextMail:String; ANoPrefix: Boolean = False): Boolean;
  function SendFileByAlias(FileName, AServerFileName, Alias: String; FileTime: TDateTime = 0): Boolean;
  function SendSMS(TelNo, SMSMsg : String): Boolean;
  function GetFile(FileName, AServerFileName, Alias: String): Boolean;
  function GetFileInfo(Alias, FileName: String; var RemoteFileName: String; var FileSize: Extended; var FileTime: TDateTime): Boolean;
  function GetFileList(Alias, FileName: String; var FileNameList: String):Boolean
  function REMOTE_FileCopy  (FromAlias, FromDir, ToAlias, ToDir, FileName: String): Boolean;
  function REMOTE_FileMove  (FromAlias, FromDir, ToAlias, ToDir, FileName: String): Boolean;
  function REMOTE_FileRename(FromAlias, FromDir, FromFileName, ToFileName: String): Boolean;
  function REMOTE_FileDelete(FromAlias, FromDir, FromFileName: String): Boolean;
  function REMOTE_DirCreate (FromAlias, DirName: String): Boolean;
  function REMOTE_DirDelete (FromAlias, DirName: String): Boolean;
end; 

Po vytvoření objektu pomocí Create je třeba nastavit parametry připojení pomocí SetupConnection. Pokud je k dispozici BIN soubor s parametry připojení, tak není třeba vyplňovat parametry IP, UserName a UserPswd. Většina funkci umožňuje pracovat v režimu, kdy se nejdříve zahájí připojení pomocí Connect, pak se provede příslušná komunikace a nakonec se provede odpojení pomocí Disconnect. Tento způsob komunikace může vyžadovat novou verzi MaximObjServeru (verze 28 a vyšší).

Tento objekt slouží k připojení na MaximObjServer (MOS) a práci se soubory pomocí tohoto serveru.

Funkce	Popis
ErrMessage	Obsahuje chybové hlášení, pokud některá z následujících funkcí skončila chybou.
Connected	Vrací True pokud je objekt připojen k MOSu
constructor Create(BINfile, IP, UserName, UserPswd: String; CodedLogin: LongInt)	Vytvoří objekt a nastaví hodnoty nezbytné pro připojení obdobně jako následující dvě funkce. Pokud je vyplněný parametr BINfile (jméno souboru s interním certifikátem pro připojení), tak se ostatní parametry ignorují.
function SetupConnection(IP, UserName, UserPswd: String; CodedLogin: LongInt): Boolean	Nastaví hodnoty nezbytné pro připojení. Je třeba volat jen pokud je potřeba připojení k novému serveru nebo jinému uživatelskému účtu bez nutnosti rušit a znova vytvářet objekt. Volání této funkce způsobí přerušení spojení s MOSem (pokud bylo navázáno).
function SetupConnectionBinFile(BINfile: String): Boolean	Obdoba funkce SetupConnection ale připojovací hodnoty načítá z BIN souboru. Ostatní vlastnosti jsou u obou funkcí shodné.
function Connect: Boolean	Připojí se k MOSu a při úspěšném připojení nastaví vlastnost Connect na True.
procedure Disconnect	Odpojí se od MOSu.
function SendFile(FileName, AServerFileName, Email, Subject, TextMail: String; ANoPrefix: Boolean = False): Boolean	Odešle soubor z klientské stanice na server. Způsob zpracování serverem MOS se určuje podle přípony přenášeného souboru. Funkce je určená pro základní nastavení definované v sekci [Pripony] v souboru MaximObjServer.ini na serveru. Pokud nejsou určené parametry Email, Subject a TextMail, tak se provede odeslání mailu podle parametrů určených serverem. Pokud nastavíte parametr ANoPrefix na True, tak se na serveru ponechá jméno souboru dle parametru FileName, jinak je ke jménu souboru připojena časová značka (umožňuje ve stejnou dobu přijímat stejně pojmenované soubory).
function SendFileByAlias(FileName, AServerFileName, Alias: String; FileTime: TDateTime = 0): Boolean	Obdoba SendFile, ale přenos souboru povoluje nastavení vlastností aliasu na MOSu. Využívá se nastavení v souboru MaximObjServer.xml na serveru. Parametr FileName určuje lokální jméno souboru. Parametr AServerFileName určuje jméno souboru na serveru včetně případné podsložky (hlavní složka na serveru je určená serverem na základě parametru Alias). Parametr Alias určuje jméno aliasu definovaného v MaximObjServer.xml. Parametr FileTime je nepovinný a určuje datum a čas poslední změny souboru, pod jakým se soubor uloží na serveru; pokud má hodnotu 0 nebo není uveden, tak se datum a čas souboru automaticky převezme z lokálního souboru.
function SendSMS(TelNo, SMSMsg : String): Boolean	Pokud je MOS připojen k SMS bráně, je možné odesílat SMS.
function GetFile(FileName, AServerFileName, Alias: String): Boolean	Načte soubor z MOSu na klienta. Využívá se nastavení v souboru MaximObjServer.xml na serveru. Parametr FileName určuje lokální jméno souboru. Parametr AServerFileName určuje jméno souboru na serveru včetně případné podsložky (hlavní složka na serveru je určená serverem na základě parametru Alias). Parametr Alias určuje jméno aliasu definovaného v MaximObjServer.xml.
function GetFileInfo(Alias, FileName: String; var RemoteFileName: String; var FileSize: Extended; var FileTime: TDateTime): Boolean	Zjistí informace o souborech na MOSu. Ve FileName může být i maska pro výběr více souborů např.: *.*, *.jpg apod. Funkce v tom případě vrací informace o prvním nalezeném souboru. Soubory se vybírají z adresáře daného aliasem. Využívá se nastavení aliasů v souboru MaximObjServer.xml na serveru. Funkce vrací v parametru RemoteFileName jméno souboru ze serveru, v parametru FileSize velikost souboru v bytech a ve FileTime vrací datum a čas poslední změny souboru na serveru.
function GetFileList(Alias, FileName: String; var FileNameList: String):Boolean	Načte seznam souborů z MOSu odpovídající zvolené masce souborů danou parametrem FileName. Ve FileName může být buď maska pro výběr více souborů např.: *.*, *.jpg nebo konkrétní jméno souboru. Funkce vrací seznam souborů ve formě jednoho stringu, kde jednotlivé názvy souborů jsou oddělené znakem #13 neboli chr(13). Soubory se vybírají z adresáře na serveru daného aliasem. Využívá se nastavení aliasů v souboru MaximObjServer.xml na serveru.

Skupina funkcí začínající REMOTE_... pracuje se soubory na serveru a není určena pro přenos mezi klientem a serverem. Využívá se nastavení aliasů v souboru MaximObjServer.xml na serveru (včetně nastavení přístupových práv pro uživatelské role pro jednotlivé aliasy).

Funkce	Popis
function REMOTE_FileCopy (FromAlias, FromDir, ToAlias, ToDir, FileName: String): Boolean	Kopíruje soubor mezi dvěma adresáři.
function REMOTE_FileMove (FromAlias, FromDir, ToAlias, ToDir, FileName: String): Boolean	Přesune soubor mezi dvěma adresáři. To znamená, že původní soubor bude smazán.
function REMOTE_FileRename (FromAlias, FromDir, FromFileName, ToFileName: String): Boolean	Soubor bude přejmenován.
function REMOTE_FileDelete (FromAlias, FromDir, FromFileName: String): Boolean	Smaže soubor z disku.
function REMOTE_DirCreate (FromAlias, DirName: String): Boolean	Vytvoří nový adresář.
function REMOTE_DirDelete (FromAlias, DirName: String): Boolean	Smaže prázdný adresář. Pokud adresář nebude prázdný tak mazání skončí chybou.

Starší verze podporují režim bez předchozího připojení, tj. po Create je možné ihned zavolat funkci pro komunikaci (ta zajistí připojení, komunikaci i odpojení). Pro přenos jednotlivého souboru tedy doporučujeme použít tento druhý postup. Funkce začínající REMOTE jsou určené pro manipulaci s dokumenty na vzdáleném serveru (aliasy se definují v konfiguračním XML souboru na serveru).

Viz příklad Příklady PASCAL