Implementing Response Frames - Revision history

John: /* Adding the External Program to the Container */

2022-04-10T14:33:43Z

Adding the External Program to the Container

← Older revision		Revision as of 14:33, 10 April 2022
Line 57:		Line 57:

	docker cp mycustomprogram mycontainername:/opt/telstar/volume		docker cp mycustomprogram mycontainername:/opt/telstar/volume

	The above command assumes that the volume path is set at its default value. See [[Configuration Options]].		The above command assumes that the volume path is set at its default value. See [[Configuration Options]].

John at 14:33, 10 April 2022

2022-04-10T14:33:32Z

← Older revision		Revision as of 14:33, 10 April 2022
Line 50:		Line 50:

	The binary file ''telstar-openweather-linux-amd64'' is a custom program designed to retrieve weather information from the Openweather service. When implementing response frames this would be replaced with whatever action was required. This could be a binary program as in the above example, a python program or perhaps a bash script.		The binary file ''telstar-openweather-linux-amd64'' is a custom program designed to retrieve weather information from the Openweather service. When implementing response frames this would be replaced with whatever action was required. This could be a binary program as in the above example, a python program or perhaps a bash script.


	== Adding the External Program to the Container ==		== Adding the External Program to the Container ==

	To ~~follow.~~..		To copy a custom program or script file to the container for use with a response frame, the following Docker copy command can be used:

			docker cp mycustomprogram mycontainername:/opt/telstar/volume

			The above command assumes that the volume path is set at its default value. See [[Configuration Options]].

John: /* response-action */

2022-04-10T14:29:05Z

response-action

← Older revision		Revision as of 14:29, 10 April 2022
Line 45:		Line 45:
	=== response-action ===		=== response-action ===

	The ''response-action'' section of the frame definition determines what happens when the ~~uset~~ submits the form. In the example above the ''exec'' setting causes a binary file (''telstar-openweather-linux-amd64''), stored in the containers volume directory, to be executed with a single argument (''myopenweatherapikey''). This ~~file returns~~ a collection of pages in json format. Any application or script that is executed should output either a single page or multiple pages. These will get captured by Telstar and placed into temporary store.		The ''response-action'' section of the frame definition determines what happens when the user submits the form. In the example above, the ''exec'' setting causes a binary file (''telstar-openweather-linux-amd64''), stored in the containers volume directory, to be executed with a single argument (''myopenweatherapikey''). This program outputs a collection of pages in json format. Any application or script that is executed should output either a single page or multiple pages. These will get captured by Telstar and placed into temporary store.

	In the case above ''post-action-frame'' is set to 290b, in this example frame 290b is output by the program ''telstar-openweather-linux-amd64'' along with 290c, 290d and so on. These contain the weather forcast and are captured by Telstar and placed in temporary store. The user is then directed to 290b and is presented with the weather.		In the case above ''post-action-frame'' is set to ''290b'', in this example frame 290b is output by the program ''telstar-openweather-linux-amd64'' along with 290c, 290d and so on. These contain the weather forcast and are captured by Telstar and placed in temporary store. The user is then directed to 290b and is presented with the weather.



	The binary file ''telstar-openweather-linux-amd64'' is a custom program designed to retrieve weather information from the Openweather service. When implementing response frames this would be replaced with whatever action was required. This could be a binary program as in the above example, a python program or perhaps a bash script.

			The binary file ''telstar-openweather-linux-amd64'' is a custom program designed to retrieve weather information from the Openweather service. When implementing response frames this would be replaced with whatever action was required. This could be a binary program as in the above example, a python program or perhaps a bash script.

	== Adding the External Program to the Container ==		== Adding the External Program to the Container ==

	To follow...		To follow...

John: /* response-data */

2022-04-10T14:26:10Z

response-data

← Older revision		Revision as of 14:26, 10 April 2022
Line 41:		Line 41:
	The length of the field is set at 16 which means that a maximum of 16 characters can be entered. If the ''auto-submit'' had been set to ''true'' then entering the 16th character would have either moved the cursor to the next field, had there been one, or in this case where there are no other fields, submit the form.		The length of the field is set at 16 which means that a maximum of 16 characters can be entered. If the ''auto-submit'' had been set to ''true'' then entering the 16th character would have either moved the cursor to the next field, had there been one, or in this case where there are no other fields, submit the form.

	Setting ''password'' to true would ensure that it is not displayed on the screen as it is entered.		Setting ''password'' to ''true'' would ensure that it is not displayed on the screen as it is entered.

	=== response-action ===		=== response-action ===

John: /* response-data */

2022-04-10T14:25:59Z

response-data

← Older revision		Revision as of 14:25, 10 April 2022
Line 39:		Line 39:
	The ''response-data'' section above shows the definition for a single response field. This field will be presented to the user for completion at positions ''vpos'', ''hpos'' on the frame. The field has the ''required'' attribute set to ''true'' which means that it must be completed in order to continue and the field's ''type'' is ''alphanumeric''. Other possible field types include ''numeric'' and ''alpha''.		The ''response-data'' section above shows the definition for a single response field. This field will be presented to the user for completion at positions ''vpos'', ''hpos'' on the frame. The field has the ''required'' attribute set to ''true'' which means that it must be completed in order to continue and the field's ''type'' is ''alphanumeric''. Other possible field types include ''numeric'' and ''alpha''.

	The length of the field is set at 16 which means that a maximum of 16 characters can be entered. If the ''auto-submit'' had been set to ''true'' then entering the 16th character would have either moved to the next field, had there been one, or in this case where there are no other fields, submit the form.		The length of the field is set at 16 which means that a maximum of 16 characters can be entered. If the ''auto-submit'' had been set to ''true'' then entering the 16th character would have either moved the cursor to the next field, had there been one, or in this case where there are no other fields, submit the form.

	Setting ''password'' to true would ensure that it is not displayed on the screen as it is entered.		Setting ''password'' to true would ensure that it is not displayed on the screen as it is entered.

John at 14:24, 10 April 2022

2022-04-10T14:24:39Z

@@ Line 1: / Line 1: @@
-Response frames are frames that allow a user to enter data to be processed i.e. a frame where a user enters data such as a form. The data from these frames would typically be processed using an external program or script referred to as a plugin. The plugin can be any software that can be executed, all that is required is that the plugin can return a json result. The Telstar system https://glasstty.com weather page is handled in this way.
+== Introduction ==
-Plugins are simple to create and deploy within a Telstar container and can be written in any language supported by the platform.
+Response frames are frames that can be used to present the user with a form to complete. This form can then be processed by a program external to Telstar. The results of the external program are automatically passed back to Telstar for presentation to the user etc.
-More to follow...
+== Frame Definition ==

John: Created page with "Response frames are frames that allow a user to enter data to be processed i.e. a frame where a user enters data such as a form. The data from these frames would typically be processed using an external program or script referred to as a plugin. The plugin can be any software that can be executed, all that is required is that the plugin can return a json result. The Telstar system https://glasstty.com weather page is handled in this way. Plugins are simple to create and..."

2022-04-09T20:37:12Z

Created page with "Response frames are frames that allow a user to enter data to be processed i.e. a frame where a user enters data such as a form. The data from these frames would typically be processed using an external program or script referred to as a plugin. The plugin can be any software that can be executed, all that is required is that the plugin can return a json result. The Telstar system https://glasstty.com weather page is handled in this way. Plugins are simple to create and..."

New page

Response frames are frames that allow a user to enter data to be processed i.e. a frame where a user enters data such as a form. The data from these frames would typically be processed using an external program or script referred to as a plugin. The plugin can be any software that can be executed, all that is required is that the plugin can return a json result. The Telstar system https://glasstty.com weather page is handled in this way.

Plugins are simple to create and deploy within a Telstar container and can be written in any language supported by the platform.

More to follow...