Knowledge Base

Loading the SM Customer, Contract or Unit Enquiry Forms from an XML Job

Hint Ref: 021110030004
Hint Date: 04/10/2011

Hint Details:

It is now possible to open the Customer, Contract or Unit Enquiry form from within an XML Jobrunner job. Alternatively, the same command can be used to open a Woodpecker form.

 

The command to do so is <OpenForm> which must be passed two attributes;

formid = this is the form to open (Case sensitive)
static = this should be set to either YES or NO and indicates if the 'formid' is for a compiled form (YES) or a WoodPecker form (NO)

Various Parameters can be passed ( as child <Writeln> statements ) to the command, which are detailed below.

(Version Note: CustomerDetails is available from 2.2.4.52 onwards. All others are available from 2.2.5.0 onwards)


CUSTOMER ENQUIRY FORM:

formid = CustomerDetails
static = YES

Parameter 1 = customerid

example:

<OpenForm formid="CustomerDetails" static="YES">
  <Writeln>{customerid}</Writeln>
</OpenForm>


CONTRACT ENQUIRY FORM:

formid = ContractDetails
static = YES

Parameter 1 = contractid
Parameter 2 = '1' if the default tab selected should be the 'Transaction' Tab. '0' or omitted if it should be the 'Units' tab.

example:

<OpenForm formid="ContractDetails" static="YES">
  <Writeln>{contractid}</Writeln>
  <Writeln>1</Writeln>
</OpenForm>


UNIT ENQUIRY FORM:

formid = UnitDetails
static = YES

Parameter 1 = unitid

example:

<OpenForm formid="UnitDetails" static="YES">
  <Writeln>{unitid}</Writeln>
</OpenForm>

CONTACT EVENT FORM:

If you want to open this form to create a new contact event then leave the first parameter empty and fill the other 3 as required (in this case a customerid MUST be provided).

If the first parameter is filled the others are ignored

formid = ContactEvent
static = YES

Parameter 1 = contacteventid
Parameter 2 = customerid
Parameter 3 = contractid
Parameter 4 = reservationid

example:

<OpenForm formid="ContactEvent" static="YES">
  <Writeln/>
  <Writeln>{customerid}</Writeln>
  <Writeln>{contractid}</Writeln>
</OpenForm>


(Please Note: This Procedure can be destructive and should only be used by Advanced Users.  RADical Systems (UK) Limited or its Partners cannot be held responsible, in anyway, for any consequence of using this or any other Database Function, Procedure, XML Script or SQL command.  Responsibility resides solely with the user.  

IT IS HIGHLY RECOMMENDED THAT A FULL AND VALID SPACE MANAGER DATABASE BACKUP IS TAKEN AND VERIFIED AS VALID BEFORE MAKING ANY CHANGES TO THE DATABASE.)