FileMan Delphi Components/FMDC Quick Start Guide - Revision history

NeilArmstrong: Added glossary link to Record~

2012-04-07T13:22:23Z

Added glossary link to Record~

← Older revision		Revision as of 13:22, 7 April 2012
Line 1:		Line 1:
	= Introduction =		= Introduction =
	This quick start guide goes immediately to the heart of the matter, showing you how to edit ~~records~~ in a particular file using the VA FileMan Delphi Components (FMDC).		This quick start guide goes immediately to the heart of the matter, showing you how to edit [[record~\|Record]]s in a particular file using the VA FileMan Delphi Components (FMDC).

	= Quick Start Steps =		= Quick Start Steps =
	To edit ~~records~~ in a given VA FileMan file with the VA FileMan Delphi Components:		To edit [[record~\|Record]]s in a given VA FileMan file with the VA FileMan Delphi Components:

	== 1. Establish an [[RPC Broker]] connection: ==		== 1. Establish an [[RPC Broker]] connection: ==
Line 16:		Line 16:
	b. Set its [[FileMan_Delphi_Components/RPCBroker_property\|RPCBroker property]] to point to your [[Delphi_Form\|form]]'s [[FileMan_Delphi_Components/TRPCBroker\|TRPCBroker]] [[Delphi_component\|component]].		b. Set its [[FileMan_Delphi_Components/RPCBroker_property\|RPCBroker property]] to point to your [[Delphi_Form\|form]]'s [[FileMan_Delphi_Components/TRPCBroker\|TRPCBroker]] [[Delphi_component\|component]].

	c. Set its [[FileMan_Delphi_Components/FileNumber_property\|FileNumber property]] to the [[VA FileMan File]] containing ~~records~~ to retrieve.		c. Set its [[FileMan_Delphi_Components/FileNumber_property\|FileNumber property]] to the [[VA FileMan File]] containing [[record~\|Record]]s to retrieve.

	== 3. Add a [[FileMan_Delphi_Components/TFMFiler\|TFMFiler]] [[Delphi_component\|component]] to file changes: ==		== 3. Add a [[FileMan_Delphi_Components/TFMFiler\|TFMFiler]] [[Delphi_component\|component]] to file changes: ==
Line 57:		Line 57:
	b. Set the properties of these controls and [[Delphi_component\|component]]s according to the [[VA_FileMan_field\|field]]-specific guidelines for the [[VA_FileMan_field_data_type\|Field Type]]: [[FileMan_Delphi_Components/Free_text\|Free text]], [[FileMan_Delphi_Components/numeric\|numeric]], [[FileMan_Delphi_Components/date\|date]] - [[FileMan_Delphi_Components/Boolean_set_of_codes\|"Boolean" set of codes]] - [[FileMan_Delphi_Components/Set_of_Codes\|Set of Codes]] - [[FileMan_Delphi_Components/Word_Processing\|Word Processing]] - [[FileMan_Delphi_Components/Pointer\|Pointer]] - [[FileMan_Delphi_Components/Computed\|Computed]].		b. Set the properties of these controls and [[Delphi_component\|component]]s according to the [[VA_FileMan_field\|field]]-specific guidelines for the [[VA_FileMan_field_data_type\|Field Type]]: [[FileMan_Delphi_Components/Free_text\|Free text]], [[FileMan_Delphi_Components/numeric\|numeric]], [[FileMan_Delphi_Components/date\|date]] - [[FileMan_Delphi_Components/Boolean_set_of_codes\|"Boolean" set of codes]] - [[FileMan_Delphi_Components/Set_of_Codes\|Set of Codes]] - [[FileMan_Delphi_Components/Word_Processing\|Word Processing]] - [[FileMan_Delphi_Components/Pointer\|Pointer]] - [[FileMan_Delphi_Components/Computed\|Computed]].

	== 6. Select and retrieve a record: ==		== 6. Select and retrieve a [[record~\|Record]]: ==

	a. To select a record, follow the procedure in the topic "[[FileMan_Delphi_Components/TFMLookUp_Select_a_record_custom_dialog\|Select a record with the TFMLookUp custom dialog]]". You'll add a [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]] and [[FileMan_Delphi_Components/TFMLister\|TFMLister]] [[Delphi_component\|component]] to your [[Delphi_Form\|form]], and add a button that calls the [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]]'s [[FileMan_Delphi_Components/TFMLookUp_Execute\|Execute]] method to perform the lookup.		a. To select a [[record~\|Record]], follow the procedure in the topic "[[FileMan_Delphi_Components/TFMLookUp_Select_a_record_custom_dialog\|Select a record with the TFMLookUp custom dialog]]". You'll add a [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]] and [[FileMan_Delphi_Components/TFMLister\|TFMLister]] [[Delphi_component\|component]] to your [[Delphi_Form\|form]], and add a button that calls the [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]]'s [[FileMan_Delphi_Components/TFMLookUp_Execute\|Execute]] method to perform the lookup.

	b. [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]].[[FileMan_Delphi_Components/TFMLookUp_Execute\|Execute]] returns a record number. With this record number, you can retrieve the record and populate your data controls with the record's [[VA_FileMan_field\|field]] values. To retrieve the record, follow the procedure in the "[[FileMan_Delphi_Components/Retrieve_a_Record\|How to Retrieve a Record]]" topic. You'll call the [[FileMan_Delphi_Components/TFMGets\|TFMGets]] [[FileMan_Delphi_Components/TFMGets_GetAndFill\|GetAndFill]] method to retrieve the record and populate data controls.		b. [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]].[[FileMan_Delphi_Components/TFMLookUp_Execute\|Execute]] returns a [[record~\|Record]] number. With this [[record~\|Record]] number, you can retrieve the [[record~\|Record]] and populate your data controls with the [[record~\|Record]]'s [[VA_FileMan_field\|field]] values. To retrieve the [[record~\|Record]], follow the procedure in the "[[FileMan_Delphi_Components/Retrieve_a_Record\|How to Retrieve a Record]]" topic. You'll call the [[FileMan_Delphi_Components/TFMGets\|TFMGets]] [[FileMan_Delphi_Components/TFMGets_GetAndFill\|GetAndFill]] method to retrieve the [[record~\|Record]] and populate data controls.

	c. The code for the button that executes [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]]'s [[FileMan_Delphi_Components/TFMLookUp_Execute\|Execute]] method (step a) can also perform the retrieval (step b). The code that combines these tasks would look similar to the following:		c. The code for the button that executes [[FileMan_Delphi_Components/TFMLookUp\|TFMLookUp]]'s [[FileMan_Delphi_Components/TFMLookUp_Execute\|Execute]] method (step a) can also perform the retrieval (step b). The code that combines these tasks would look similar to the following:
Line 67:		Line 67:
	<code>		<code>
	procedure TForm1.Button1Click(Sender: TObject);		procedure TForm1.Button1Click(Sender: TObject);
	var ~~AddRecord~~:Boolean;		var Add[[Record~\|Record]]:Boolean;
	begin		begin
	if FMLookup1.Execute(~~AddRecord~~) then begin		if FMLookup1.Execute(Add[[Record~\|Record]]) then begin
	FMGets1.IENS:=FMLookUp1.~~RecordNumber~~+',';		FMGets1.IENS:=FMLookUp1.[[Record~\|Record]]Number+',';
	// Call any TFMListBox/TFMComboBox GetList methods		// Call any TFMListBox/TFMComboBox GetList methods
	// here, before calling GetAndFill.		// here, before calling GetAndFill.
Line 76:		Line 76:
	end		end
	else		else
	ShowMessage('No record chosen.');		ShowMessage('No [[record~\|Record]] chosen.');

	end;		end;
Line 89:		Line 89:
	== 8. Provide an event to save changes: ==		== 8. Provide an event to save changes: ==

	a. To save changes the user makes to the record, follow the procedure in the "[[FileMan_Delphi_Components/How_To_File_Changes\|How to File Changes]]" topic. You'll add a button whose caption is something like "Save Changes." You'll add code for this button's OnClick event handler that calls your [[FileMan_Delphi_Components/TFMFiler\|TFMFiler]]'s [[FileMan_Delphi_Components/TFMFiler\|TFMFiler_Update\|Update]] method to file changes.		a. To save changes the user makes to the [[record~\|Record]], follow the procedure in the "[[FileMan_Delphi_Components/How_To_File_Changes\|How to File Changes]]" topic. You'll add a button whose caption is something like "Save Changes." You'll add code for this button's OnClick event handler that calls your [[FileMan_Delphi_Components/TFMFiler\|TFMFiler]]'s [[FileMan_Delphi_Components/TFMFiler\|TFMFiler_Update\|Update]] method to file changes.

	== 9. (Optional) Provide context-sensitive [[VA_FileMan_field\|field]] help: ==		== 9. (Optional) Provide context-sensitive [[VA_FileMan_field\|field]] help: ==

NeilArmstrong: Added glossary link to Application~

2012-02-23T01:02:08Z

Added glossary link to Application~

← Older revision		Revision as of 01:02, 23 February 2012
Line 103:		Line 103:
	* [[FileMan_Delphi_Components/Calling_A_TFMHelp_component\|Calling a]][[FileMan_Delphi_Components/TFMHelp\|TFMHelp]] [[Delphi_component\|component]] directly		* [[FileMan_Delphi_Components/Calling_A_TFMHelp_component\|Calling a]][[FileMan_Delphi_Components/TFMHelp\|TFMHelp]] [[Delphi_component\|component]] directly

	== 10. Register your application: ==		== 10. Register your [[application~\|Application]]: ==

	Registering your application is part of [[RPC Broker]] security. For all users that do not possess the XUPROGMODE key, your application must register itself based on a "B"-type option in the Option file on the server.		Registering your [[application~\|Application]] is part of [[RPC Broker]] security. For all users that do not possess the XUPROGMODE key, your [[application~\|Application]] must register itself based on a "B"-type option in the Option file on the server.

	The RPC multiple of this option must include the RPCs invoked by all VA FileMan Delphi Components methods that your application uses.		The RPC multiple of this option must include the RPCs invoked by all VA FileMan Delphi Components methods that your [[application~\|Application]] uses.

	For a listing of the [[REMOTE PROCEDURE CALL\|RPC]] invoked by each VA FileMan Delphi Components method, please refer to the "[[FileMan_Delphi_Components/Security_And_Registering_FMDC_RPCS\|Security & Registering FMDC RPCs]]" topic.		For a listing of the [[REMOTE PROCEDURE CALL\|RPC]] invoked by each VA FileMan Delphi Components method, please refer to the "[[FileMan_Delphi_Components/Security_And_Registering_FMDC_RPCS\|Security & Registering FMDC RPCs]]" topic.

DavidWhitten at 19:35, 10 February 2011

2011-02-10T19:35:38Z

← Older revision		Revision as of 19:35, 10 February 2011
Line 113:		Line 113:
	For more information on RPC Broker security, please refer to the documentation for the [[RPC Broker]].		For more information on RPC Broker security, please refer to the documentation for the [[RPC Broker]].

	== Overview Picture ==		= Overview Picture =
	[[Image:FMDC_Object_Hierarchy_.png]]		[[Image:FMDC_Object_Hierarchy_.png]]

DavidWhitten at 19:35, 10 February 2011

2011-02-10T19:35:19Z

← Older revision		Revision as of 19:35, 10 February 2011
Line 112:		Line 112:

	For more information on RPC Broker security, please refer to the documentation for the [[RPC Broker]].		For more information on RPC Broker security, please refer to the documentation for the [[RPC Broker]].

			== Overview Picture ==
			[[Image:FMDC_Object_Hierarchy_.png]]

DavidWhitten: /* 6. Select and retrieve a record: */

2011-02-07T23:58:31Z