User Preferences

What Are User Preferences Used For?

User Preferences are used to define key operational functionalities for development, debugging, deployment and runtime execution activities.\ To open the User Preferences options, click the Tools icon in the Fabric Studio to display the default General Preferences folder and its configuration items.

image

User Preferences are saved in: [Fabric Studio Installation Dir]\Preferences.

What Is the Purpose of the Server Configuration Tab?

The Server Configuration tab is used to define Fabric server deployment URLs. Each Fabric server can be accessed to deploy an implementation, to debug and to validate Web Services.

image

The following is a list of server configuration items:

Title

K2View Fabric logical name of the server.

Deployment Web Service URL

Displays a generic URL for the deployment in the following format: http://<host>:3213/deploy.

Edit the Hostname or Host IP Address in the <host> field to deploy your project or its components such as a Logical Unit or Web Services to the configured server.

Driver Port

The JDBC driver port to connect to the Fabric in this environment.

Force Upgrade Post Deploy

Checked: performs a forced sync after deployment whereby the LU is always synchronized regardless of the Sync Method defined for the LU.
Note that when a Decision Function is defined for a Sync Method, the function takes precedence.

Unchecked: performs a sync on schema changes only.

Note that each LU undergoes one forced sync the first time it is retrieved, regardless whether this option is checked / unchecked.

Soft Deploy

Checked: performs the deployment without automatic processes: user jobs, parsers and interface listener

Username

Username for database access authentication.

Password

Password for database access authentication.

Debug Env

Indicates the debug environment. Only one environment can be marked as debug.

Test URL

Click to test the connection to the server and to validate the URL.

Fabric Console

Click to open the Fabric Console using the selected server info: host, JDBC port, user and password.

Web Admin

Click to open the Web Admin using the selected server info: host and web server port.

Web Service Invoke Path Template

By default, Web Services are invoked using Swagger. For example: static/swaggerUI/dist/index.html#/<CATEGORY>/<WS_VERB>_<WS_PATH>

Add WS Parameters to URL Query

When checked, enables adding parameters to the Web Service (WS) URL body.

For example: ws?format=html&methodName=<WS_NAME>&token=     

Note that the Delete button of the special debug environment is disabled to support running a debug on a remote server.

Click for more information about Deployment from the Fabric Studio.

Click for more information about the Sync Method.

Click for more information about Invoking a Web Service from the Studio.

Note that once defined, both General Preferences and Server Configurations continue to apply after the Fabric Studio is upgraded.

What Is the Purpose of the General Preferences Tab?

The General Preferences tab is used to define the system’s Projects Directory folder which is by default saved in:

C:\users\[username]\documents\K2View Fabric Studio\Projects.

To update the location of the folder or to edit it, click Browse.

How Do I Add Application Shortcuts?

Application shortcuts enable you to define shortcuts to other applications directly from the Fabric Studio without exiting the application. Once defined, the new shortcut is displayed in the upper left corner of the window.

  1. Go to Application Shortcuts and click Add New Shortcut.
  2. Enter the Application Name in the Title field.
  3. Enter the Path to the application file in the Target Path field.
  4. Enter any Settings for the application in the Parameters field.
  5. Click OK and then click Save or press CTRL+S to save the updated shortcuts.

image

How Do I Configure GIT Preferences?

GIT preferences can be used to enable the following:

  • Creating new projects in GIT.
  • Checking projects out of GIT:
    • Auto Update Gif Status, automatically refreshes the Git’s status in the Project Tree, for example, to show if a file is modified. By default, this option is checked. If this is not checked, the Project Tree will not fetch the status of each file.
    • Auto Add Files to Git, when checked adds the project’s new files to Git which can then be committed. If this is not checked, you can add the files manually using the Git add command and then commit them. By default, this option is not set.

Note that TortoiseGit enables adding un-versioned files when performing the Commit process. These files do not need to be added beforehand.

Click for more information about SVN and GIT Best Practices.

How Do I Configure SVN Preferences?

The following SVN preferences can be configured:

Auto-update SVN status

Check to display the SVN Status icon for each component in the Project Tree.

Auto add files to SVN

Check to disable adding files automatically to the SVN in the User Preferences window.

Auto Check SVN out-of-date files

Fabric Studio checks this option each time an open window is saved or closed. A message is also displayed to indicate that there is a newer revision of the Project in the SVN repository whereby an update is required.

Previous

User Preferences

What Are User Preferences Used For?

User Preferences are used to define key operational functionalities for development, debugging, deployment and runtime execution activities.\ To open the User Preferences options, click the Tools icon in the Fabric Studio to display the default General Preferences folder and its configuration items.

image

User Preferences are saved in: [Fabric Studio Installation Dir]\Preferences.

What Is the Purpose of the Server Configuration Tab?

The Server Configuration tab is used to define Fabric server deployment URLs. Each Fabric server can be accessed to deploy an implementation, to debug and to validate Web Services.

image

The following is a list of server configuration items:

Title

K2View Fabric logical name of the server.

Deployment Web Service URL

Displays a generic URL for the deployment in the following format: http://<host>:3213/deploy.

Edit the Hostname or Host IP Address in the <host> field to deploy your project or its components such as a Logical Unit or Web Services to the configured server.

Driver Port

The JDBC driver port to connect to the Fabric in this environment.

Force Upgrade Post Deploy

Checked: performs a forced sync after deployment whereby the LU is always synchronized regardless of the Sync Method defined for the LU.
Note that when a Decision Function is defined for a Sync Method, the function takes precedence.

Unchecked: performs a sync on schema changes only.

Note that each LU undergoes one forced sync the first time it is retrieved, regardless whether this option is checked / unchecked.

Soft Deploy

Checked: performs the deployment without automatic processes: user jobs, parsers and interface listener

Username

Username for database access authentication.

Password

Password for database access authentication.

Debug Env

Indicates the debug environment. Only one environment can be marked as debug.

Test URL

Click to test the connection to the server and to validate the URL.

Fabric Console

Click to open the Fabric Console using the selected server info: host, JDBC port, user and password.

Web Admin

Click to open the Web Admin using the selected server info: host and web server port.

Web Service Invoke Path Template

By default, Web Services are invoked using Swagger. For example: static/swaggerUI/dist/index.html#/<CATEGORY>/<WS_VERB>_<WS_PATH>

Add WS Parameters to URL Query

When checked, enables adding parameters to the Web Service (WS) URL body.

For example: ws?format=html&methodName=<WS_NAME>&token=     

Note that the Delete button of the special debug environment is disabled to support running a debug on a remote server.

Click for more information about Deployment from the Fabric Studio.

Click for more information about the Sync Method.

Click for more information about Invoking a Web Service from the Studio.

Note that once defined, both General Preferences and Server Configurations continue to apply after the Fabric Studio is upgraded.

What Is the Purpose of the General Preferences Tab?

The General Preferences tab is used to define the system’s Projects Directory folder which is by default saved in:

C:\users\[username]\documents\K2View Fabric Studio\Projects.

To update the location of the folder or to edit it, click Browse.

How Do I Add Application Shortcuts?

Application shortcuts enable you to define shortcuts to other applications directly from the Fabric Studio without exiting the application. Once defined, the new shortcut is displayed in the upper left corner of the window.

  1. Go to Application Shortcuts and click Add New Shortcut.
  2. Enter the Application Name in the Title field.
  3. Enter the Path to the application file in the Target Path field.
  4. Enter any Settings for the application in the Parameters field.
  5. Click OK and then click Save or press CTRL+S to save the updated shortcuts.

image

How Do I Configure GIT Preferences?

GIT preferences can be used to enable the following:

  • Creating new projects in GIT.
  • Checking projects out of GIT:
    • Auto Update Gif Status, automatically refreshes the Git’s status in the Project Tree, for example, to show if a file is modified. By default, this option is checked. If this is not checked, the Project Tree will not fetch the status of each file.
    • Auto Add Files to Git, when checked adds the project’s new files to Git which can then be committed. If this is not checked, you can add the files manually using the Git add command and then commit them. By default, this option is not set.

Note that TortoiseGit enables adding un-versioned files when performing the Commit process. These files do not need to be added beforehand.

Click for more information about SVN and GIT Best Practices.

How Do I Configure SVN Preferences?

The following SVN preferences can be configured:

Auto-update SVN status

Check to display the SVN Status icon for each component in the Project Tree.

Auto add files to SVN

Check to disable adding files automatically to the SVN in the User Preferences window.

Auto Check SVN out-of-date files

Fabric Studio checks this option each time an open window is saved or closed. A message is also displayed to indicate that there is a newer revision of the Project in the SVN repository whereby an update is required.

Previous