Offline Deploy

New or updated Fabric project implementations must be deployed to the server side. A deployment can be performed either from the Fabric Studio or from the Fabric Server (also known as an Offline Deploy).

An Offline Deploy is implemented by running the Deploy command on the Fabric Server using artifacts that can be created either by the Fabric Studio or by the script on the server side.

When Should I Use Offline Deploy?

When a Fabric project is developed by a group of programmers it is important that the environment is always up-to-date. This can be challenging. Fabric provides a solution that enables combining the code changes that have been implemented and committed by several programmers and deploying them to a specific environment. To do so, the Development team should prepare an automated Jenkins process that takes the project's latest sources from the Git or SVN repository and copies them to the server. The process then runs the script that creates the artifacts based on this code and then deploys them on a server. This process can run on the Fabric Server without any dependency on the Fabric Studio.

Click for more information about Best Practices for working with GIT and SVN.

How Do I Perform an Offline Deployment?

There are two ways to perform an Offline Deployment:

  • Build and deploy in two steps. First build the artifacts either from the Fabric Studio or from the server using the buildArtifacts.sh deployment script. Then do the deployment by running the Deploy command on the server.

  • Build and deploy in one step. Build and deploy from the server using the buildAndDeployArtifacts.sh deployment script. It is also possible to deploy without the build, whereby the script only runs a Deploy command without creating and deleting artifacts.

Build and Deploy in Two Steps

  1. To build the artifacts from the Fabric Studio:

    a. Right click the object (for example, Web Services) and click Build Deploy Artifacts. A notification is displayed after the artifacts are successfully built.

    16_03_offline_deploy1

    b. Right click the same object and select Open Folder. The Windows Explorer opens in the following location: [Your PC Folder]\K2View Fabric Studio\Projects\[Project Name]\Implementation\LogicalUnits\[LU Name].

    c. Copy the ludb.JAR and ludbXMLs.ZIP files to the server.

  2. To build the artifacts from the Fabric Server, run the buildArtifacts.sh deployment script.

  3. To do the deployment, run the Deploy command using the following syntax :

    DEPLOY WITH JAR <'jar_path'> ZIP_FILE <'zip path'> [WS_METHODS <'string'>] NOSYNC .

    Note that if the LUT parameter is populated by a k2_ws (Web Service LU Type), you can populate the WS_METHODS using the list of Web Services to be deployed. If this parameter is not populated or is empty, all the WS are deployed into the Fabric Server.

    Example:

    DEPLOY k2_ws WITH JAR '/home/k2view/AutoTests/Data/StudioProject/QA/Implementation/LogicalUnits/k2_ws/ludb.jar' ZIP_FILE '/home/k2view/AutoTests/Data/StudioProject/QA/Implementation/LogicalUnits/k2_ws/ludbXMLs.zip' WS_METHODS 'dbQueryOnAnyDB' NOSYNC true;

Build and Deploy in One Step

To build the artifacts and the deployment together in one step from the server, run the buildAndDeployArtifacts.sh deployment script.

Deployment Scripts Syntax and Options

The following table describes the syntax and the mandatory/optional parameters for calling the deployment scripts. The scripts are located under $K2_HOME/fabric/scripts in the Fabric Server.

buildArtifacts.sh for Linux or

buildArtifacts.bat for windows

Description: Build the artifact files.

Usage: ./buildArtifacts.sh [-h --help] -pd [PATH_TO_PROJECT] -l [LUTNAME] -d [OUTPUT DIRECTION]

Options:

  • -h/--help displays the usage of the script.
  • -pd [PROJ_NAME] - mandatory parameter. Sets the path to the project.
  • -l [LUTNAME] - optional parameter. If not set, the artifacts are created for the entire project.
  • -d [OUTPUT DIRECTION] - optional parameter. If not set, the artifacts are created in the given/each LU folder.

buildAndDeployArtifacts.sh for Linux or buildAndDeployArtifacts.bat for Windows

Description: Build and deploy the artifact files.

Usage: ./buildAndDeployArtifacts.sh -pd [PATH_TO_PROJECT] -s [NOSYNC] -l [LUT_NAME] -u [USER] -p [PASSWORD] -d [DEPLOYONLY]

Options:

  • -h/--help - displays the usage of the script.
  • -pd [PROJ_NAME] - mandatory parameter. Sets the path to the project.
  • -s [NOSYNC] - optional parameter. Default is True.
  • -l [LUTNAME] - optional parameter. If not set, the deploy runs for the entire project.
  • -u [USER] - optional parameter. Default is admin.
  • -p [PASSWORD] - optional parameter. Default is admin.
  • -d [DEPLOYONLY] - optional parameter. If True, the script only runs a deploy command without creating and deleting the artifacts.

Deploy Command Syntax and Options

The following table describes the syntax and the mandatory/optional parameters when invoking the deploy command on the Fabric Server.

DEPLOY

Usage: DEPLOY <LUT> WITH JAR <'jar_path'> ZIP_FILE <'zip path'> [WS_METHODS <'string'>] NOSYNC <Boolean>.

Options:

  • LUT - Logical Unit Type name.
  • JAR - mandatory parameter. Path to JAR file, relative to USER_DIR.
  • ZIP_FILE - optional parameter. Path to ZIP file, relative to USER_DIR.
  • NOSYNC - gets Boolean value:
    • NOSYNC TRUE: any deployment triggers a sync the first time the instance is accessed.
    • NOSYNC FALSE: only Schema updates trigger the sync after the deployment.
    Note that NOSYNC TRUE is the same as checking Force Upgrade Post Deploy in the Server Configuration window in the Fabric Studio.
  • WS_METHODS - For LU Type = Web Services (k2_ws), specify which methods are selected, separated by “,”. Empty for all.

Previous

Offline Deploy

New or updated Fabric project implementations must be deployed to the server side. A deployment can be performed either from the Fabric Studio or from the Fabric Server (also known as an Offline Deploy).

An Offline Deploy is implemented by running the Deploy command on the Fabric Server using artifacts that can be created either by the Fabric Studio or by the script on the server side.

When Should I Use Offline Deploy?

When a Fabric project is developed by a group of programmers it is important that the environment is always up-to-date. This can be challenging. Fabric provides a solution that enables combining the code changes that have been implemented and committed by several programmers and deploying them to a specific environment. To do so, the Development team should prepare an automated Jenkins process that takes the project's latest sources from the Git or SVN repository and copies them to the server. The process then runs the script that creates the artifacts based on this code and then deploys them on a server. This process can run on the Fabric Server without any dependency on the Fabric Studio.

Click for more information about Best Practices for working with GIT and SVN.

How Do I Perform an Offline Deployment?

There are two ways to perform an Offline Deployment:

  • Build and deploy in two steps. First build the artifacts either from the Fabric Studio or from the server using the buildArtifacts.sh deployment script. Then do the deployment by running the Deploy command on the server.

  • Build and deploy in one step. Build and deploy from the server using the buildAndDeployArtifacts.sh deployment script. It is also possible to deploy without the build, whereby the script only runs a Deploy command without creating and deleting artifacts.

Build and Deploy in Two Steps

  1. To build the artifacts from the Fabric Studio:

    a. Right click the object (for example, Web Services) and click Build Deploy Artifacts. A notification is displayed after the artifacts are successfully built.

    16_03_offline_deploy1

    b. Right click the same object and select Open Folder. The Windows Explorer opens in the following location: [Your PC Folder]\K2View Fabric Studio\Projects\[Project Name]\Implementation\LogicalUnits\[LU Name].

    c. Copy the ludb.JAR and ludbXMLs.ZIP files to the server.

  2. To build the artifacts from the Fabric Server, run the buildArtifacts.sh deployment script.

  3. To do the deployment, run the Deploy command using the following syntax :

    DEPLOY WITH JAR <'jar_path'> ZIP_FILE <'zip path'> [WS_METHODS <'string'>] NOSYNC .

    Note that if the LUT parameter is populated by a k2_ws (Web Service LU Type), you can populate the WS_METHODS using the list of Web Services to be deployed. If this parameter is not populated or is empty, all the WS are deployed into the Fabric Server.

    Example:

    DEPLOY k2_ws WITH JAR '/home/k2view/AutoTests/Data/StudioProject/QA/Implementation/LogicalUnits/k2_ws/ludb.jar' ZIP_FILE '/home/k2view/AutoTests/Data/StudioProject/QA/Implementation/LogicalUnits/k2_ws/ludbXMLs.zip' WS_METHODS 'dbQueryOnAnyDB' NOSYNC true;

Build and Deploy in One Step

To build the artifacts and the deployment together in one step from the server, run the buildAndDeployArtifacts.sh deployment script.

Deployment Scripts Syntax and Options

The following table describes the syntax and the mandatory/optional parameters for calling the deployment scripts. The scripts are located under $K2_HOME/fabric/scripts in the Fabric Server.

buildArtifacts.sh for Linux or

buildArtifacts.bat for windows

Description: Build the artifact files.

Usage: ./buildArtifacts.sh [-h --help] -pd [PATH_TO_PROJECT] -l [LUTNAME] -d [OUTPUT DIRECTION]

Options:

  • -h/--help displays the usage of the script.
  • -pd [PROJ_NAME] - mandatory parameter. Sets the path to the project.
  • -l [LUTNAME] - optional parameter. If not set, the artifacts are created for the entire project.
  • -d [OUTPUT DIRECTION] - optional parameter. If not set, the artifacts are created in the given/each LU folder.

buildAndDeployArtifacts.sh for Linux or buildAndDeployArtifacts.bat for Windows

Description: Build and deploy the artifact files.

Usage: ./buildAndDeployArtifacts.sh -pd [PATH_TO_PROJECT] -s [NOSYNC] -l [LUT_NAME] -u [USER] -p [PASSWORD] -d [DEPLOYONLY]

Options:

  • -h/--help - displays the usage of the script.
  • -pd [PROJ_NAME] - mandatory parameter. Sets the path to the project.
  • -s [NOSYNC] - optional parameter. Default is True.
  • -l [LUTNAME] - optional parameter. If not set, the deploy runs for the entire project.
  • -u [USER] - optional parameter. Default is admin.
  • -p [PASSWORD] - optional parameter. Default is admin.
  • -d [DEPLOYONLY] - optional parameter. If True, the script only runs a deploy command without creating and deleting the artifacts.

Deploy Command Syntax and Options

The following table describes the syntax and the mandatory/optional parameters when invoking the deploy command on the Fabric Server.

DEPLOY

Usage: DEPLOY <LUT> WITH JAR <'jar_path'> ZIP_FILE <'zip path'> [WS_METHODS <'string'>] NOSYNC <Boolean>.

Options:

  • LUT - Logical Unit Type name.
  • JAR - mandatory parameter. Path to JAR file, relative to USER_DIR.
  • ZIP_FILE - optional parameter. Path to ZIP file, relative to USER_DIR.
  • NOSYNC - gets Boolean value:
    • NOSYNC TRUE: any deployment triggers a sync the first time the instance is accessed.
    • NOSYNC FALSE: only Schema updates trigger the sync after the deployment.
    Note that NOSYNC TRUE is the same as checking Force Upgrade Post Deploy in the Server Configuration window in the Fabric Studio.
  • WS_METHODS - For LU Type = Web Services (k2_ws), specify which methods are selected, separated by “,”. Empty for all.

Previous