To create a Server object, you typically need at least a host name:

myServer = Rfm::Server.new({:host => 'my.host.com'})

Several other options are supported

• host the hostname of the Web Publishing Engine (WPE) server (defaults to 'localhost')

• port the port number the WPE is listening no (defaults to 80 unless ssl true which sets it to 443)

• account_name the default account name to log in to databases with (you can also supply a account name on a per-database basis if necessary)

• password the default password to log in to databases with (you can also supplly a password on a per-databases basis if necessary)

• log_actions when true, RFM logs all action URLs that are sent to FileMaker server to stderr (defaults to false)

• log_responses when true, RFM logs all raw XML responses (including headers) from FileMaker to stderr (defaults to false)

• warn_on_redirect normally, RFM prints a warning to stderr if the Web Publishing Engine redirects (this can usually be fixed by using a different host name, which speeds things up); if you *don't* want this warning printed, set warn_on_redirect to true

• raise_on_401 although RFM raises error when FileMaker returns error responses, it typically ignores FileMaker's 401 error (no records found) and returns an empty record set instead; if you prefer a raised error when a find produces no errors, set this option to true

SSL Options (SSL AND CERTIFICATE VERIFICATION ARE ON BY DEFAULT)

• ssl false if you want to turn SSL (HTTPS) off when connecting to connect to FileMaker (default is true)

If you are using SSL and want to verify the certificate, use the following options:

• root_cert true is the default. If you do not want to verify your SSL session, set this to false. You will want to turn this off if you are using a self signed certificate and do not have a certificate authority cert file. If you choose this option you will need to provide a cert root_cert_name and root_cert_path (if not in root directory).

• root_cert_name name of pem file for certificate verification (Root cert from certificate authority who issued certificate. If self signed certificate do not use this option!!). You can download the entire bundle of CA Root Certificates from curl.haxx.se/ca/cacert.pem. Place the pem file in config directory.

• root_cert_path path to cert file. (defaults to '/' if no path given)

Configuration Examples

Example to turn off SSL:

myServer = Rfm::Server.new({
        :host => 'localhost',
        :account_name => 'sample',
        :password => '12345',
        :ssl => false 
        })

Example using SSL without root_cert:

myServer = Rfm::Server.new({
        :host => 'localhost',
        :account_name => 'sample',
        :password => '12345',
        :root_cert => false 
        })

Example using SSL with root_cert at file root:

myServer = Rfm::Server.new({
         :host => 'localhost',
         :account_name => 'sample',
         :password => '12345',
         :root_cert_name => 'example.pem' 
         })

Example using SSL with root_cert specifying root_cert_path:

myServer = Rfm::Server.new({
         :host => 'localhost',
         :account_name => 'sample',
         :password => '12345',
         :root_cert_name => 'example.pem'
         :root_cert_path => '/usr/cert_file/'
         })

Performs a raw FileMaker action. You will generally not call this method directly, but it is exposed in case you need to do something "under the hood."

The action parameter is any valid FileMaker web url action. For example, -find, -finadny etc.

The args parameter is a hash of arguments to be included in the action url. It will be serialized and url-encoded appropriately.

The options parameter is a hash of RFM-specific options, which correspond to the more esoteric FileMaker URL parameters. They are exposed separately because they can also be passed into various methods on the Layout object, which is a much more typical way of sending an action to FileMaker.

This method returns the Net::HTTP response object representing the response from FileMaker.

For example, if you wanted to send a raw command to FileMaker to find the first 20 people in the "Customers" database whose first name is "Bill" you might do this:

response = myServer.connect(
  '-find',
  {
    "-db" => "Customers",
    "-lay" => "Details",
    "First Name" => "Bill"
  },
  { :max_records => 20 }
)