Development - Titanium - Revision history

Anw: Update for new network folder structures.

2019-10-04T16:28:23Z

Update for new network folder structures.

Anw: Added SVN information

2019-09-11T09:36:55Z

Added SVN information

← Older revision		Revision as of 11:36, 11 September 2019
Line 968:		Line 968:

	[[Category:WI 287575 EPOD Development and Release Process\|025]]		[[Category:WI 287575 EPOD Development and Release Process\|025]]

			==SVN==

			=== Moving a repository ===
			You need SVN tools installed on the new server. See here:
			* P:\Development\EPOD\_Development\Development Tools\Apache-Subversion-1.12.2.zip
			* https://www.visualsvn.com/downloads/ - use Apache Subversion command line tools.


			==== Step 1: Backup your old Repository ====
			The first thing you need when moving from one server to another is a dump of your subversion repository.

			svnadmin dump /path/to/repository > repo_name.svn_dump

			The dump file contains all the revisions you have ever made to your svn repository, so it will probably be quite large (it even includes files you may have deleted in a previous revision).

			==== Step 2: Create the new Repository ====
			Now, simply transfer the dump file on to your new subversion server, and create an empty repository:

			svnadmin create /path/to/repository


			==== Alternative to Step 1/2: Copy the repository ====
			Copy the repository directory to a new server, as long as you want an identical copy and history, and the machines are the same operating system.


			==== Step 3: Import your old repository into the new one ====
			Next import your dump file:

			svnadmin load /path/to/repository -F repo_name.svn_dump

			You may want to force subversion to use the same UUID for the new repository as the old repository. To do this add --force-uuid to your svnadmin load command. In my case I wanted to do this. If you have already loaded your repository, there is a way to set the UUID at a later date, check the docs.


			=== FAQ's ===
			What if someone committed a new revision to the old server during installation?

			You can easily import the new revision, by creating an incremental dump on the old server:

			svnadmin dump --incremental -r 1234 /path/to/repository > rev1234.svn_dump

			Copy the file to the new server.

			Now to import that revision on your new server:

			svnadmin load /path/to/repository -F rev1234.svn_dump

Anw: Added links to Appcelerator documentation

2016-12-07T14:10:30Z

Added links to Appcelerator documentation

← Older revision		Revision as of 16:10, 7 December 2016
Line 836:		Line 836:

	== Titanium Module Development ==		== Titanium Module Development ==
			{{Note}} This process has been validated with Appcelerator Studio and Titanium SDK 5.0.2, although upgrades to some of the required programs were completed.


	=== Development Environment ===		=== Development Environment ===
	{{Note}} ~~Check~~ the ~~Titanium~~ documentation ~~for which versions of these programs are required to work with your version of Appcelerator Titanium~~.		{{Note}} Always check the latest documentation resources here:
			* http://docs.appcelerator.com/platform/latest/#!/guide/Installing_Titanium_Advanced_Tools


	Requirements:		Requirements:
Line 935:		Line 940:

	=== Creating a Module ===		=== Creating a Module ===
			{{Note}} Always check the latest documentation resources here:
			* http://docs.appcelerator.com/platform/latest/#!/guide/Creating_a_New_Titanium_Module

	* Click ''File/New/Mobile Module Project''		* Click ''File/New/Mobile Module Project''
	* Enter details, moving between with the '''Next''' button		* Enter details, moving between with the '''Next''' button

Anw: formatting

2016-12-07T14:01:18Z

formatting

← Older revision		Revision as of 16:01, 7 December 2016
Line 945:		Line 945:
	** Install Platform: 4.4.2 or latest supported		** Install Platform: 4.4.2 or latest supported
	* Click '''FINISH'''		* Click '''FINISH'''
	Wait for the module to be created/		Wait for the module to be created.


	== Adding libraries to a module ===		=== Adding libraries to a module ===
	Libraries are manually added, so it's likely that the projects will not load the requisite JAR files, as they will be in a different place on your machine.		Libraries are manually added, so it's likely that the projects will not load the requisite JAR files, as they will be in a different place on your machine.

Anw: /* Titanium Module Development */ Added details on Module development.

2016-12-07T13:59:21Z

Titanium Module Development: Added details on Module development.

@@ Line 837: / Line 837: @@
 == Titanium Module Development ==
 === Development Environment ===
 Requirements:
 *Oracle Java 6 (latest subversion) JDK 32-bit
@@ Line 912: / Line 914: @@
 *    Click OK.
 You can then import your projects from the old to the new workspace.
 ==== Check the PATH ====
@@ Line 922: / Line 925: @@
 *Path – C:\Python27\;C:\Python27\Scripts;%ANDROID_NDK%\build;%ANDROID_NDK%;%JAVA_HOME%\bin;%ANDROID_HOME%\tools;%ANDROID_HOME%\platform-tools;C:\Program Files (x86)\GnuWin32\bin;C:\Program Files (x86)\gperf-3.0.1\bin;%ANT_HOME%/bin;
-=== Setting up the Program ===
 Libraries are manually added, so it's likely that the projects will not load the requisite JAR files, as they will be in a different place on your machine.
-* Look for errors on the Problems tab.
-* Change the directories to point to the correct places on your machine.
+* Paste JAR files into ''<app>\android\lib'' folder.
 === Building Modules ===

Anw: Added Server-side Styling

2016-09-26T07:40:57Z

Added Server-side Styling

← Older revision		Revision as of 09:40, 26 September 2016
Line 376:		Line 376:
	* Reusable Class - defined in Ti.App.style.styles object.		* Reusable Class - defined in Ti.App.style.styles object.
	* Styling for specific ids - defined in Ti.App.style.ids.		* Styling for specific ids - defined in Ti.App.style.ids.
	* Customer-specific classes and ids - defined in Ti.App.style.configItems, that overloads classes and ids if they exist.		* Customer-specific classes and ids - defined in Ti.App.style.configItems, that overloads classes and ids if they exist. {{Note}} This is largely replaced by Server-side styling, detailed below.


	==== Adding and Amending Classes ====		==== Adding and Amending Classes ====

	New styles are added by adding a new named object to the styles, ids of configItems objects, as follows:		New styles are added by adding a new named object to the styles, ids or configItems objects, as follows:

	Ti.App.styles={		Ti.App.styles={
Line 476:		Line 477:

	These styles are automatically applied to UI objects that are created through Ti.App.style.create<Object> methods, such as Ti.App.style.createLabel.		These styles are automatically applied to UI objects that are created through Ti.App.style.create<Object> methods, such as Ti.App.style.createLabel.


	==== Classes Available ====		==== Classes Available ====
Line 510:		Line 512:
	* scrollViewRow - used for the above.		* scrollViewRow - used for the above.
	* claused/cancelled/normal - used for Signature - container clausing.		* claused/cancelled/normal - used for Signature - container clausing.


			==== Server-side Styling ====
			Device styling changes:

			# The definitions for a specific style (e.g. PLINK, LANE etc.) can now be found:
			## In the device code in the same place (within the Ti.App.style.configItems object declared in style.js). This has been kept for backwards compatibility with older versions of the server which cannot send the style definitions (will eventually be removed).
			## On the server database on the EPOD_PDA_STYLE table. I have set the data up on the V3 dev database with the style definitions for all currently existing styles.
			## In the server code as part of the EPOD_SETUP_LISTS stored procedure. This is for the initial creation of the style data for all of the styles for new sites (the ones not required for the new site can then be deleted).
			# There have been some minor changes to the way styles are defined to allow the style data to be stored and passed as a JSON string:
			## The style definitions (both data and code, including Ti.App.style.configItems, Ti.App.style.ids and Ti.App.style.styles code) has had to stop using getString to set text. These were being evaluated when the app loaded (before any style definitions have been read from the database) and would never be re-evaluated. This also caused the existing bug where changing style would not change some titles until you had exited/re-started the app (as the strings were not being re-evaluated and so were not picking up changes to the styles label IDs). The setting of these titles have been moved to the code that creates the object so that the translations are evaluated when the individual screens are built (after any style definitions have been read from the database).
			## The styles stored in the data on the database need to have double quotes around the property names and any string values. For example where the style definition in the code is borderColor:’#220000’ the style definition in the data is "borderColor":"#220000". Note that this does not affect the code in Ti.App.style, just the definitions in the database.
			## The use of Titanium constants (e.g. Ti.UI.SIZE, Titanium.UI.KEYBOARD_NUMBER_PAD or Ti.App.resMod) has changed. These need to be stored in the database as strings, the JSON parser on the device then uses a reviver function to evaluate these strings and use the evaluated value in the strings place. The reviver function (and the regex pattern for recognising the strings that need to be evaluated can be found within the vars.funUpdateStyle function in Login.js). For example where the code has height : Ti.UI.SIZE the data must have “height”:“Ti.UI.SIZE”. Where a value is set to a multiple of Ti.App.resmode (e.g. fontSize : 22 * Ti.App.resMod) the entire property value must be stored as a string (e.g. “fontSize” : “22 * Ti.App.resMod”). Again this does not affect the code in Ti.App.style, just the definitions in the database.


			From an Android development point of view. it is expected that the following to be the process for developing new styles or large changes to styles:
			# Create a style on the server with a specific style ID and no style definition. This is so the server will pass the new style ID to the device without any style definition, the device code (designed for backwards compatibility) will then use this style definitions from the configItems property that matches the style ID.
			# Develop the style as usual with code in configItems but bearing in mind 2.a, 2.b & 2.c above (i.e. do not use getString and use double quotes around any property value that needs evaluating because it is/contains Titanium constants).
			# When the style is as required convert the style from configItems to a valid JSON string (by adding double quotes around property names and any values using of Titanium constants). There is a web tools page (the ‘Style Data Converter’ page in the ‘Device Tools’ section of the web tools page: \\10.43.0.21\Projects\Support\Utils\Web Tools\index.html)
			# Use the valid JSON string to update the style definition on the development database and test that this is passed to the device and parsed correctly.
			# Finally remove the style from configItems (unless this is a new style for an existing client using an old version of the server) and use the JSON string to update the EPOD_SETUP_LISTS stored procedure.


	==== Creating Objects ====		==== Creating Objects ====
Line 568:		Line 592:
	* Typically, a variable does not need to be created separately if it is never referenced again - see the creation of the label above.		* Typically, a variable does not need to be created separately if it is never referenced again - see the creation of the label above.
	* The example also shows the use of the vars variable, typically used to make disposing of objects quicker on closing of a window (see Garbage Collection)		* The example also shows the use of the vars variable, typically used to make disposing of objects quicker on closing of a window (see Garbage Collection)


	==== Hierarchy of Classes ====		==== Hierarchy of Classes ====
Line 579:		Line 604:
	* Style-specific Device-Specific ID (Hi-resolution, Orientation)		* Style-specific Device-Specific ID (Hi-resolution, Orientation)
	* In-line properties (highest precedence)		* In-line properties (highest precedence)


	==== Custom Controls ====		==== Custom Controls ====

Anw: /* Development QC Process */

2015-03-27T10:40:20Z

Development QC Process

@@ Line 728: / Line 728: @@
 === Development QC Process ===
-Code reviews are in place for the EPOD projects and must be followed.
+Code reviews are in place for the EPOD projects and must be followed - see section [[Development Code Reviews]] for details.
 === Other ===

Anw: /* Other */

2015-03-27T10:03:57Z

Other

← Older revision		Revision as of 12:03, 27 March 2015
Line 726:		Line 726:

	You can see the log and filter it easily through here. You can also monitor memory usage and garbage collection - see the Android (http://developer.android.com/tools/debugging/ddms.html) and Titanium (http://docs.appcelerator.com/titanium/2.1/#!/guide/Managing_Memory_and_Finding_Leaks) documentation for details.		You can see the log and filter it easily through here. You can also monitor memory usage and garbage collection - see the Android (http://developer.android.com/tools/debugging/ddms.html) and Titanium (http://docs.appcelerator.com/titanium/2.1/#!/guide/Managing_Memory_and_Finding_Leaks) documentation for details.

			=== Development QC Process ===
			Code reviews are in place for the EPOD projects and must be followed.

			The Supimix log must be referred to the Product Development Manager for assignation to a peer for review.

			When assigned, the development will be reviewed for:
			* Technical issues
			* Adherence to standards in:
			** Modified Code
			** Existing Code (may be deferred)

			A QC Document will be created for each module modified as part of this change, in the format as per the example P:\EPOD\Procedure\EPOD .Net Development Guide & Process\Dev QC document example\312147 - Lanemark QC.doc.

			QC review documents with any outstanding issues will be placed in an appropriately-named folder within the following folder: P:\EPOD\_Development\QC Documents\Prog QC\.

			For example: P:\EPOD\_Development\QC Documents\Prog QC\324491 - Use auto-update to refresh load data for existing load

			Any issues with code should be passed back to the developer, referencing the QC documents created.

			If all code passes QC review at any time, the QC folder for this change will be moved to the following directory: P:\EPOD\_Development\QC Documents\Prog QC\# Closed\.


	=== Other ===		=== Other ===

Anw: /* Other */

2015-03-18T12:52:36Z

Other

← Older revision		Revision as of 14:52, 18 March 2015
Line 730:		Line 730:
	This section details observations, suggestions and potential pitfalls that may aid the Titanium developer.		This section details observations, suggestions and potential pitfalls that may aid the Titanium developer.

	{{~~warning~~}} ~~entire~~ section ~~needs expanding~~.		{{Warning}} Additional notes will be added to the bottom of this section as discovered.


	* '''Include files once'''		* '''Include files once'''
	~~{{Warning}} Describe why~~		Our application is structured so that all code calls all other code, hierarchically, so globally accessible code included in a parent will be accessible in the child. If you include it again, you simply overwrite the definition and slow down the window you want to display. The rules are:
			* Include code only at the level that you need it.
			* Include it only once.


	* '''Describe synchronous and asynchronous parts of the code, and why return and callbacks are your friends.'''		* '''Describe synchronous and asynchronous parts of the code, and why return and callbacks are your friends.'''
Line 793:		Line 797:


	* {{Warning}} ~~add others~~ here.		* '''Problems compiling/building Android projects'''
			Note that the version of Android installed and the version of Titanium installed are extremely important to keep in line. For example:
			* Titanium 3.3.0 is valid only up to version 20 of the Android SDK.
			* Titanium 3.5.1 is valid only up to version 22 of the Android SDK.
			If later versions of the SDK are installed, Titanium will always use the latest versions, regardless of whether they are later than the maximum values allowed, which means you will receive errors when compiling, usually around the command 'aapt'. Check the compatibility matrix (http://docs.appcelerator.com/platform/latest/#!/guide/Titanium_Compatibility_Matrix), and ensure you only have the correct version installed of the SDK.


			{{Warning}} Additional notes will be added here

	== Titanium Module Development ==		== Titanium Module Development ==

Anw: /* Developer Testing and Debugging */

2015-03-18T12:27:28Z

Developer Testing and Debugging

@@ Line 675: / Line 675: @@
 ** New screens should be a member of the UI namespace
 ** New connection-based files (i.e. webservices) should be a member of the Webservices namespace.
 === Developer Testing and Debugging ===

← Older revision		Revision as of 18:28, 4 October 2019
Line 89:		Line 89:
	==Android Programming Guide==		==Android Programming Guide==
	The entire program set is automatically documented from the source code. This is stored in		The entire program set is automatically documented from the source code. This is stored in
	P:\EPOD\_Development\Documentation\Android Client\index.html		P:\Product\EPOD\_Development\Documentation\Android Client\index.html

	=== Program Folder Hierarchy ===		=== Program Folder Hierarchy ===
Line 156:		Line 156:
	=== Application Hierarchy ===		=== Application Hierarchy ===
	This section covers how the application calls each screen in a standard flow. Unless specified differently, each element is part of the UI namespace. All of these items are documented as part of the Project documentation in		This section covers how the application calls each screen in a standard flow. Unless specified differently, each element is part of the UI namespace. All of these items are documented as part of the Project documentation in
	file:///~~10.43.0.21~~/Projects/EPOD/_Development/Documentation/Android%20Client/index.html - paste this link into your browser window to begin exploring the documentation.		file:///spekefs2012/Projects/Product/EPOD/_Development/Documentation/Android%20Client/index.html - paste this link into your browser window to begin exploring the documentation.

	App Start (app.js) - create database if required and call login		App Start (app.js) - create database if required and call login
Line 530:		Line 530:
	# Create a style on the server with a specific style ID and no style definition. This is so the server will pass the new style ID to the device without any style definition, the device code (designed for backwards compatibility) will then use this style definitions from the configItems property that matches the style ID.		# Create a style on the server with a specific style ID and no style definition. This is so the server will pass the new style ID to the device without any style definition, the device code (designed for backwards compatibility) will then use this style definitions from the configItems property that matches the style ID.
	# Develop the style as usual with code in configItems but bearing in mind 2.a, 2.b & 2.c above (i.e. do not use getString and use double quotes around any property value that needs evaluating because it is/contains Titanium constants).		# Develop the style as usual with code in configItems but bearing in mind 2.a, 2.b & 2.c above (i.e. do not use getString and use double quotes around any property value that needs evaluating because it is/contains Titanium constants).
	# When the style is as required convert the style from configItems to a valid JSON string (by adding double quotes around property names and any values using of Titanium constants). There is a web tools page (the ‘Style Data Converter’ page in the ‘Device Tools’ section of the web tools page: \\~~10.43.0.21~~\Projects\Support\Utils\Web Tools\index.html)		# When the style is as required convert the style from configItems to a valid JSON string (by adding double quotes around property names and any values using of Titanium constants). There is a web tools page (the ‘Style Data Converter’ page in the ‘Device Tools’ section of the web tools page: \\spekefs2012\Projects\Product\EPOD\Support\Utils\Web Tools\index.html)
	# Use the valid JSON string to update the style definition on the development database and test that this is passed to the device and parsed correctly.		# Use the valid JSON string to update the style definition on the development database and test that this is passed to the device and parsed correctly.
	# Finally remove the style from configItems (unless this is a new style for an existing client using an old version of the server) and use the JSON string to update the EPOD_SETUP_LISTS stored procedure.		# Finally remove the style from configItems (unless this is a new style for an existing client using an old version of the server) and use the JSON string to update the EPOD_SETUP_LISTS stored procedure.
Line 707:		Line 707:
	* Set up a configuration as follows:		* Set up a configuration as follows:
	** Android SDK: 2.3.3		** Android SDK: 2.3.3
	** Distribution Location: Either the Projects folder for a full distribution (P:\EPOD\~~_Development\ePOD Release to Google Play~~\Distro), or any local folder (e.g. C:\Users\you\Titanium\distro).		** Distribution Location: Either the Projects folder for a full distribution (P:\Releases\EPOD\Android\Distro), or any local folder (e.g. C:\Users\you\Titanium\distro).
	** Keystore Location: P:\EPOD\_Development\Development Tools\AndroidKeyStore\KeyStore		** Keystore Location: P:\Product\EPOD\_Development\Development Tools\AndroidKeyStore\KeyStore
	** Keystore Password: Contact the development team for details.		** Keystore Password: Contact the development team for details.
	** Key Alias: Calidus-EPOD		** Key Alias: Calidus-EPOD