IG Data Creation Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== IG.GFX.Packager ======
The IG.GFX.Packager is a tool, to:
  * convert typescript to javascript
  * build IG packages for interactors, evaluators and context
  * upload it to the IG.Creator

===== Requirements  =====
  * [[https://www.npmjs.com/package/@intelligentgraphics/ig.gfx.packager|IG.GFX.Packager]] and IG.GFX.Packager from the Tools repo, lastest versions
  * node.js version 15.0.0
  * IG.Creator login + extra lizence for uploading files to the database

===== Setting up the IG.GFX.Packager =====
Get the IG.GFX.Packager.zip file from the tools repo and unzip it into your folder directory

==== 1. Creating environment variables ====
To upload a package into the IG.Creator, the IG.GFX.Packager requires a set of predefined environment variables.

^ Variable name       ^ Value^
|IG_GFX_USER         | IG.Creator login user|
|IG_GFX_PWD          | IG.Creator login user password|
|IG_GFX_ASSET_SERVICE| IG.Creator link (default: http://ig5.intelligentgraphics.biz:8087)|
|IG.GFX.PACKAGER     | Path to the IG.GFX.Packager exe file|


==== 2. Using the IG.GFX.Packager inside a project ====
In case the IG.GFX.Packager is used inside a common project, the folder structure looks like:
<code> 
-ProjectFolder
    -SubProjectFolderEval
       -Scripts
           -_Index.json
           -_Package.json
           -_AnyScript.ts
    -SubProjectFolderInt
       -Scripts
           -_Index.json
           -_Package.json
           -AnyScript.ts
    -SubProjectFolder
       +Factory
       +Geometries
       -Scripts
           -_Index.json
           -_Package.json
           -Context.ts
           -AnyScript.ts
    -build.txt
    -package.json
       
</code>

First of all, inside the //ProjectFolder// open a command line or terminal and install the [[https://www.npmjs.com/package/@intelligentgraphics/ig.gfx.packager|IG.GFX.Packager]]. This will add the //node_modules// folder with its packages. 

This procedure need to be done only at the very first beginning of a project. As soon as this IG.GFX.Packager is installed inside this ProjectFolder, this command is not needed any more .

Next step is to set up the the package.json. For this follow the instructions from the [[https://www.npmjs.com/package/@intelligentgraphics/ig.gfx.packager|IG.GFX.Packager]] web side.
The resulting package.json looks like:

<code>
{
  "devDependencies": {
    "@intelligentgraphics/ig.gfx.packager": "Here is the latest version or higher (^) written"
  },
  "scripts": {
    "build": "packager build",
    "upload": "packager publish"
  },
  "packager": {
    "banner": "This file is part of the IG.Graphics XYZ Data Package. \n Copyright (C) intelligentgraphics. All Rights Reserved."
  }
}
</code>

Also, this part is set up one time per project. Push it to git, so everyone can work on this package.json

Next step is to create and fill the build.txt.
This file is a help file to remember the needed steps to push to the creator.
The commands needed here are explained on the [[https://www.npmjs.com/package/@intelligentgraphics/ig.gfx.packager|IG.GFX.Packager]] web side.

<code>
copy and paste this to Console/Cmd window:

this should normally defined in your environment:

SET IG_GFX_ASSET_SERVICE=http://ig5.intelligentgraphics.biz:8087

Comments:
For a new project use 1.0.0.100 as release version number and 1.0.0.1 as dev version number.
Usually version numbers will be increased within the release process.
Sort the workspaces alphabetically!.

=====================================================
=====================================================

PACKAGES

========= ProjectFolder =========

Release:
npm run upload ProjectFolder -- --newVersion=1.0.0.100
Dev:
npm run upload ProjectFolder -- --newVersion=1.0.0.1

</code>

On the top of the file, there is a generall how to. \\
After PACKAGES each package is listed separatly with the given template.\\
**Sort the projects alphanumerically, to keep a better overview!**

Each project has two commands.\\
The command under //Release// is used when a package is published. The command under //Dev// is used for develepment. The numbers are increased when it is nessesary for releases or new development steps

:!: Make sure not to match the version numbers, this will lead to problems on the live server :!:

The build.txt is pushed to git to, so every one can use it.


Examples for Evaluator and Interactor Packages:

<code>
GLOBAL PACKAGES


========= Evaluators =========

Release:
npm run upload SubProjectFolderEval -- --domain=DomainName --subdomain=SubdomainName--newVersion=1.0.0.100
Dev:
npm run upload SubProjectFolderEval -- --domain=DomainName --subdomain=SubdomainName--newVersion=1.0.0.1

========= Interactors =========

Release:
npm run upload SubProjectFolderInt -- --domain=DomainName --subdomain=SubdomainName--newVersion=1.0.0.100
Dev:
npm run upload SubProjectFolderInt -- --domain=DomainName --subdomain=SubdomainName--newVersion=1.0.0.1

</code>

==== 3. Using the IG.GFX.Packager ====
After everything is set up, the commands from the build.txt can be used.

Simply open a command line or terminal inside the ProjectFolder and copy the upload command into the terminal or command line.
In case any errors occour, they will be written there, otherwise the package is uploaded successfully into the IG.Creator.

:!: For debugging reasons it may be helpfull to know where the packages are created. The created package can be found inside the ProjectFolder/bin directory as zip file (DomainName.SubDomainName_VERSION.zip).
This file can be unziped and the java script files can be analysed. :!:

:!: In the IG.Creator,the created packages can be found at the //Assets/Scripts// page in the list. :!:
====== Known Issues And How To Solve ======
  * Error during upload to the Database. Got Status Code: InternalServerError.
    * This is any problem with the Server. Ask the IG Admin for help.

  * Existing Version 1.0.1.100 cannot be replaced by Version 1.0.0.1
    * A higher package version cannot be replaced by a lower one. Increase the version number.


  * Stopped execution because of the following error:
    * Something went wrong during programming. Check what kind of error it is exactly and solve it.


  * packager is not recognized as internal or external command
    * Make sure the IG.GFX.Packager is installed in your current directory.
    * Make sure you are in the correct directory

  * My animation.json is not uploaded to the IG.Creator.
    * This can happen in case an Interactor folder only exists out of animation.json files and no typescript files. Use these commands as fallback:
<code>
npm run build ProjectFolderInt
%IG_GFX_PACKAGER% -domain=DomainName -subdomain=ProjectFolderInt -target-subdomain=SubdomainName -version=1.0.0.1 -service=%IG_GFX_ASSET_SERVICE% -user=%IG_GFX_USER% -password=%IG_GFX_PWD%
</code>