Custom Form Deployment

Custom forms can be deployed in both Windows and Linux environments. From the CLI, you can deploy a single custom form or multiple custom forms to the MDM server. To deploy the custom forms use the following properties and syntax in the Command Line Interface:

Deploying a Single Custom Form

You can deploy a single custom form to the MDM server in a Windows or a Linux environment.

For Windows

To deploy a single custom form, enter the following command at the command prompt: 

<Install Dir>\studio-mdm\5.0\eclipse>TIBCOBusinessStudio.exe -application com.tibco.xpd.deploy.server.cim.DeployModel -data "D:/cim_Studio/Studio_Projects_Ws_1" -i "D:\cim_Studio\Studio_Projects_Ws_1\UiPageDeploy\UI Builder\UiCustomPage5.mub" -u cim90 -pwd cim90 -mode mub -baseURL http://localhost:8080/  -e cimdev90 -d cimdev90  -uiPageConfiguration ["menuAction":"Add to Menu","rootItem":"Custom Pages","menuItem":"UiCustomPage5","metadataOperation":"[Add Record, View Record, Modify Record]","directoryStructure":"Default","componentName":"UiCustomPage5"]
For Linux

To deploy a single custom form, enter the following command at the command prompt: 

./ TIBCOBusinessStudio.exe -application com.tibco.xpd.deploy.server.cim.DeployModel -data  “/home/apps/workspace/UiPageDeploy/UI Builder/UiCustomPage5.mub” -i “/home/apps/workspace” u cim90 -pwdcim90 -mode mub -baseURL http://localhost:8080/ -e cimdev90 -d cimdev90 -uiPageConfiguration ["menuAction":"Add to Menu","rootItem":"CustomPages","menuItem":"UiCustomPage5","metadataOperation":"[Add Record, View Record, Modify Record]","directoryStructure":"Default","componentName":"UiCustomPage5"]
To deploy a single custom form, use the following properties:
Properties Description
–mode The mode in which you want to deploy the custom form. For example, 
 –mode mub
-i A full path of the input UI builder file
–uiPageConfiguration Page configuration in square brackets followed by the –uiPageConfiguration flag.
For example, 
-uiPageConfiguration ["menuAction":"Add to Menu","rootItem":"Custom Pages","menuItem":"UiCustomPage5","metadataOperation":"[Add Record, View Record, Modify Record]","directoryStructure":"Default","componentName":"UiCustomPage5"]
-menuAction Add to Menu or Link to Metadata Operation
  • If you add the value of -menuAction as Add to Menu, then -metadataOperation is optional .
  • If you add the value of -menuAction as Link to Metadata Operation, then -rootItem and –menuItem are optional.
-directoryStructure The directory structure such as Default or Standalone
-metadataOperation The operations such as Add Record, View Record, and Modify Record
-rootItem Provide any of the following root items:
  • Custom Pages
  • Inbox
  • Administration
  • System Operations
  • Master Data
  • Browse and Search
  • Business Process
  • Event Log
  • Tools

Deploying Multiple Custom Forms at a Time

For Windows

To deploy multiple custom forms at a time, enter the following command on the command line: 

<Install Directory>\studio-mdm\4.0\eclipse>TIBCOBusinessStudio.exe -application com.tibco.xpd.deploy.server.cim.DeployModel -data " D:\cim_Studio\Studio_Projects_Ws_1" -project_name UiPageDeploy -u cim90 -pwd cim90 -mode project -baseURL http://localhost:8080 -e cimdev90 -d cimdev90 -abort_on_error -fileFilter "UI Builder\UiCustomPage1.mub,UI Builder\UiCustomPage2.mub,UI Builder\UiCustomPage3.mub" -uiPageConfiguration "C:\Users\amshinde\Desktop\uiconfig.json"
For Linux

To deploy multiple custom forms at a time, enter the following command on the command line: 

./TIBCOBusinessStudio -application com.tibco.xpd.deploy.server.cim.DeployModel -data "/home/apps/workspace" -project_name UiPageDeploy -u cim90 -pwd cim90 –mode project -baseURL http://localhost:8080 –e cimdev90 -d cimdev90 -fileFilter "UIBuilder\UiCustomPage1.mub,UI Builder\UiCustomPage2.mub,UI Builder\UiCustomPage3.mub” –uiPageConfiguration "/home/apps/workspace/uiconfig.json"
To deploy multiple custom forms at a time use the following properties:
Properties Description
–mode A mode in which you want to deploy the custom form. For example, 
 –mode project
-fileFilter A filter to specify files that you want to deploy. This is optional, all the files in a project are deployed by default. Use this filter only to deploy specific files. For example, "UI Builder\UiCustomPage1.mub,UI Builder\UiCustomPage2.mub"
–uiPageConfiguration

(file path)

UI Page configuration –uiPageConfiguration file path. For example, 
 -uiPageConfiguration "C:\Users\amshinde\Desktop\uiconfig.json"
–uiPageConfiguration

(file)

The format of –uiPageConfiguration written in the .json file: 
{"UiCustomPage1":{"menuAction":"Add to Menu","rootItem":"Custom Pages","menuItem":"UiCustomPage1","metadataOperation":"","directoryStructure":"Default","componentName":"UiCustomPage1"},"UiCustomPage2":{"menuAction":"Add to Menu","rootItem":"Custom Pages","menuItem":"UiCustomPage2","metadataOperation":"","directoryStructure":"Default","componentName":"UiCustomPage2"}}