Time Clock Client Development Guide

This guide will describe how to compile the Client and build an Microsoft Installer file (msi) that will be used when installing the Time Clock Client.

When to use this information:

Use this page when you need to make customizations in the Time Clock Client.

Content

• Prerequisites
• Compile the Time Clock Client
• Create the MSI file for the Time Clock Client

Prerequisites

1. Installed 7-zip.
2. Installed Microsoft Visual Studio 2013 with .NET Framework 4.5.2 Developer Pack which are installed together by CoS by default.
3. Installed Extension called Microsoft Visual Studio Installer Projects for Visual Studio 2013.
   how to do it:
   Download and install the extension using MS web page with VS extensions. You could try link https://visualstudiogallery.msdn.microsoft.com/9abe329c-9bba-44a1-be59-0fbf6151054d.
4. Available build of IFS Applications containing component timclo.
5. project_root generated from Build for which we want to generate Time Clock binaries.

   how to do it:

   Enter folder <Build_Home>/source,

   execute _create_project_root.cmd,

   enter folder name of the project_root being created e.g. C:\15_Timclo\project_root, which will be referenced as <project root>

   check if project_root was created successfully, in that case "BUILD SUCCESSFUL" message is displayed on the output screen near the end of output log.

Compile the Time Clock Client

1. Configure IFS Development Environment. Suitable utility could be obtained from e.g. file://corpnet/files/F1Tools/IFSApplicationFormsDevelopment/.

   how to do it:

   execute SetupIFSAPFDevelopment90.exe,

   enter <local project folder> e.g. C:\15_Timclo\DevEnv_work,

   set Team Development checkbox,

   enter Team Server ProjectShare Folder, use <project root> folder name.

2. Copy component timclo into <local_project_folder>/workspace.
3. Execute <local project folder>/"Update Deploy Files from Team Server" to copy files to local project folder. Use "Update All" option.
4. Create script ExtractSattelliteAssemblies.cmd to copy and extract satellite assemblies using template presented below. Set correct values for PROJECTROOT and PATH variables. Place it in folder <local project folder>\DeployFiles  e.g. C:\15_Timclo\DevEnv_work\DeployFiles.

   SET PROJECTROOT=C:\15_Timclo\project_root\client\runtime
   PATH=%PATH%;C:\Program Files\7-Zip
   
   FOR %%a IN (en-NZ en-US ar-LY cs-CZ da-DK de-DE en-GB es-ES fa-IR fi-FI fr-CA fr-FR hu-HU it-IT ja-JP nb-NO nl-NL pl-PL pt-PT ro-RO ru-RU sk-SK sv-SE zh-CN) DO (
      xcopy %PROJECTROOT%\%%a\*.* "%%a\" /d/i/y
      7z x %%a\Ifs.Language.%%a.zip -o%%a -y
   )
   PAUSE

5. Execute ExtractSattelliteAssemblies.cmd.
6. Build TimClockExe from solution TimClockExe.sln.
   Open TimClockExe.sln.
   Change Active Solution Configuration from Debug to Release in the Configuration Manager.
   Select node TimClockExe and start Build from right mouse button menu.
   The solution will be built to <local project folder>\... .

Create the MSI file for the Time Clock Client

1. Remove references to non-existing languages from TimClockSetup.sln.
   Open the solution file, TimClockSetup.sln, located in folder <local project folder>\workspace\timclo\source\timclo\client\TimeClockSetup, with Microsoft Visual Studio.
   Click twice in Solution Explorer on one of dependecies. The window "File System (TimeClockSetup)" appears.

   In the window remove all references to languages you don't have (were not copied and extracted by the script). Remove all files from the language folders and then these folders themselves. The application hangs for more than a few seconds each time you remove files.

2. Build TimClockSetup from solution TimClockSetup.sln.
   Open TimClockSetup.sln.
   Change Active Solution Configuration from Debug to Release in the Configuration Manager.
   Select node TimClockSetup and start Build from right mouse button menu.
   The solution will be built to <local project folder>\DeployFiles.
3. Copy built files setup.exe and TimeClockSetup.msi to suitable folder inside Build of IFS Applications: <build_home>\Build\win32client\Time Clock\TimcloSetup.

The Build of IFS Application is now ready to install Time Clock Client. setup.exe program from <build_home> folder should be used to install Time Clock Client.