CLI - Xyna-Factory/xyna GitHub Wiki
The Command Line Interface (CLI) of the Xyna Factory is a text-based scriptable management interface. It is invoked by executing the script xynafactory.sh from the server directory (e.g. /opt/xyna/xyna_001/server).
The list of all commands and corresponding parameter description is available with the command
cd /opt/xyna/xyna_001/server ./xynafactory.sh '''help'''
The descriptions for each command are available in more detail with
./xynafactory.sh '''help''' <command>
All commands can be preceded by -p <port> to address a specified CLI port, e.g. ./xynafactory.sh -p 12345 start.
The following sections list the available CLI commands by cathegory.
''# Starts the Xyna Factory Server'' ./xynafactory.sh [-d [port]] '''start'''
''# Stops the Xyna Factory Server'' ./xynafactory.sh '''stop'''
''# Restarts the Xyna Factory Server'' ./xynafactory.sh [-d [port]] '''restart'''
''# Build a new version of an [[Application]]''
./xynafactory.sh '''buildapplicationversion''' -applicationName <arg> [-comment <arg>]
[-excludeSubtypesOf <args>] [-parentWorkspace <arg>] [-s] [-v] -versionName <arg>
''# Clear a [[Workspace]]''
./xynafactory.sh '''clearworkspace''' [-f] [-removeSubtypesOf <args>] -workspaceName <arg>
''# Copy all objects from an Application to a Workspace''
./xynafactory.sh '''copyapplicationintoworkspace''' -applicationName <arg> -versionName <arg>
[-workspaceName <arg>] [-comment <arg>] [-v]
''# Copy all (or some) [[Cron-like Order|Cron-like Orders]] from one Application to another''
./xynafactory.sh '''copycronlikeorders''' -applicationName <arg> [-g] [-id <arg>] [-m] [-ordertype <args>]
-sourceVersion <arg> -targetVersion <arg> [-v]
''# Copy [[Order Type|Order Types]] and their configuration from one Application to another''
./xynafactory.sh '''copyordertypes''' -applicationName <arg> -sourceVersion <arg> -targetVersion <arg>
''# Create a new Workspace''
./xynafactory.sh '''createworkspace''' -workspaceName <arg>
''# Define a new Application Definition''
./xynafactory.sh '''defineapplication''' -applicationName <arg> [-comment <arg>] [-parentWorkspace <arg>]
''# Disable a custom order entry type''
./xynafactory.sh '''disablecustomorderentry''' -applicationName <arg> -definingApplicationName <arg>
-definingApplicationVersion <arg> -orderEntryName <arg> -versionName <arg>
''# Enable a custom order entry type''
./xynafactory.sh '''enablecustomorderentry''' -applicationName <arg> -definingApplicationName <arg>
-definingApplicationVersion <arg> -orderEntryName <arg> -versionName <arg>
''# Export an Application''
./xynafactory.sh '''exportapplication''' -applicationName <arg> -versionName <arg> -filename <arg> [-cs]
[-l] [-lb] [-newVersion <arg>] [-v]
''# Import an Application from file''
./xynafactory.sh '''importapplication''' -filename <arg> [-f] [-g] [-ic] [-ip] [-iq] [-oc] [-op] [-r] [-s] [-v]
[-storableNameGeneration <arg>] [-xc] [-xp]
''# List all objects linked to an Application or Application Definition''
./xynafactory.sh '''listapplicationdetails''' [-applicationName <arg>] [-excludeEntryTypes <args>]
[-excludeSubtypesOf <args>] [-fileName <arg>] [-parentWorkspace <arg>] [-r] [-v] [-versionName <arg>]
''# List all registered Applications and their state''
./xynafactory.sh '''listapplications''' [-applicationName <arg>] [-h] [-t] [-v] [-workspaceName <arg>]
''# Show detailed information on a Workspace''
./xynafactory.sh '''listworkspacedetails''' -workspaceName <arg>
''# Lists registered custom order entries''
./xynafactory.sh '''listcustomorderentries'''
''# List all Workspaces''
./xynafactory.sh '''listworkspaces''' [-t]
''# Remove an Application. The Application has to be in state'' STOPPED
./xynafactory.sh '''removeapplication''' -applicationName <arg> [-c] [-f] [-ff] [-g] [-parentWorkspace <arg>]
[-v] [-versionName <arg>]
''# Remove an object and optionally all dependencies from an Application''
./xynafactory.sh '''removeobjectfromapplication''' -applicationName <arg> [-d] [-f] -objectName <arg>
[-parentWorkspace <arg>] [-type <arg>] [-v]
''# Remove a Workspace''
./xynafactory.sh '''removeworkspace''' [-c] [-f] -workspaceName <arg>
''# Start an Application and enable all [[Trigger]] and [[Filter]] instances''
./xynafactory.sh '''startapplication''' -applicationName <arg> -versionName <arg> [-c]
[-enableOrderEntrance <args>] [-f] [-g]
''# Stop an Application and disable all Trigger and Filter instances''
./xynafactory.sh '''stopapplication''' -applicationName <arg> -versionName <arg>
[-disableOrderEntrance <args>] [-g]
''# Define a new [[Capacity]]''
./xynafactory.sh '''addcapacity''' -name <arg> -cardinality <arg> [-state <arg>]
''# Change the cardinality of an existing Capacity''
./xynafactory.sh '''changecapacitycardinality''' -name <arg> -newCardinality <arg>
''# Change the name of an existing Capacity''
./xynafactory.sh '''changecapacityname''' -name <arg> -newName <arg>
''# Change the state of an existing Capacity''
./xynafactory.sh '''changecapacitystate''' -name <arg> -state <arg>
''# List all defined Capacities and their status''
./xynafactory.sh '''listcapacities''' [-v]
''# List the Capacities that are currently required by the given Order Type''
./xynafactory.sh '''listcapacitiesforordertype''' -orderType <arg> [-applicationName <arg>]
[-versionName <arg>] [-workspaceName <arg>]
''# List all defined Capacities and the Order Types that depend on them''
./xynafactory.sh '''listcapacitydependencies'''
''# List all [[Veto|Vetoes]] currently occupied by any [[Xyna Order|Xyna Orders]]''
./xynafactory.sh '''listvetos'''
''# Remove an Administative Veto''
./xynafactory.sh '''removeadminveto''' -name <arg>
''# Remove an existing Capacity''
./xynafactory.sh '''removecapacity''' -name <arg>
''# Stop requiring the specified Capacity for the given Order Type''
./xynafactory.sh '''removecapacityforordertype''' -capacityName <arg> -orderType <arg>
[-applicationName <arg>] [-u] [-versionName <arg>] [-workspaceName <arg>]
''# Require the specified Capacity for the given Order Type''
./xynafactory.sh '''requirecapacityforordertype''' -capacityName <arg> -cardinality <arg> -orderType <arg>
[-applicationName <arg>] [-u] [-versionName <arg>] [-workspaceName <arg>]
''# Require the specified Capacity for the given Workflow''
./xynafactory.sh '''requirecapacityforwf''' -capacityName <arg> -cardinality <arg> -workflowName <arg>
''# Connect to an existing cluster'' ./xynafactory.sh '''joincluster''' -clusterType <arg> -connectionParameters <args> -instanceDescription <arg> ''# Leave a cluster that the local node is currently part of'' ./xynafactory.sh '''leavecluster''' -id <arg> ''# Shows components which may be configured for use in cluster'' ./xynafactory.sh '''listclusterablecomponents''' ''# Show all clusters that the local node is currently part of'' ./xynafactory.sh '''listclusterinstances''' [-v] ''# Shows information for all available cluster types'' ./xynafactory.sh '''listclustertypes''' ''# Registers an additional cluster provider'' ./xynafactory.sh '''registerclusterprovider''' -name <arg> ''# Setup a new cluster'' ./xynafactory.sh '''setupnewcluster''' -clusterType <arg> -initParameters <args> -instanceDescription <arg>
''# Lists information about all code access instances'' ./xynafactory.sh '''listcodeaccessinstances''' ''# Instructs the code access to retry a previously failed build'' ./xynafactory.sh '''rebuildfailedcomponent''' [-componentname <arg>] [-d] [-workspaceName <arg>] ''# Show the current status of a code access instance'' ./xynafactory.sh '''showcodeaccessstatus''' [-r] [-v] [-workspaceName <arg>]
''# Shows statistics about connection pools''
./xynafactory.sh '''listconnectionpoolinfo''' [-v] [-vv]
''# Shows statistics about connection pools''
./xynafactory.sh '''listconnectionpools''' [-t]
''# Shows statistics about connection pools''
./xynafactory.sh '''listconnectionpoolstatistics''' [-name <arg>] [-s] [-t]
''# Lists all known connection pool types''
./xynafactory.sh '''listconnectionpooltypes'''
''# Modify a connection pool''
./xynafactory.sh '''modifyconnectionpool''' [-connectstring <arg>] [-f] -name <arg> [-password <arg>]
[-pooltypespecifics <args>] [-retries <arg>] [-size <arg>] -type <arg> [-user <arg>]
''# Removes a connection pool''
./xynafactory.sh '''removeconnectionpool''' [-n] -name <arg>
''# Shutdown a connection pool''
./xynafactory.sh '''shutdownconnectionpool''' [-n] -name <arg>
''# Restart a previously shutdown connection pool''
./xynafactory.sh '''startconnectionpool''' -name <arg>
''# Enable all (or some) Cron-like Orders''
./xynafactory.sh '''enablecrons''' [-applicationName <arg>] [-orderType <args>] [-versionName <arg>]
[-workspaceName <arg>]
''# List time zones for use with Cron-like Orders''
./xynafactory.sh '''listTimeZones''' [-v] [-w]
''# List all registered Cron-like Orders''
./xynafactory.sh '''listcron''' [-o] [-t]
''# Modify an existing Cron-like Order''
./xynafactory.sh '''modifycron''' [-custom0 <arg>] [-custom1 <arg>] [-custom2 <arg>] [-custom3 <arg>]
[-dst <arg>] [-enabled <arg>] [-firstExecutionTime <arg>] -id <arg> [-interval <arg>] [-label <arg>]
[-onError <arg>] [-orderType <arg>] [-timeZone <arg>]
''# Stop and remove a Cron-like Order''
./xynafactory.sh '''removecron''' -id <arg>
''# Register and start a new Cron-like Order''
./xynafactory.sh '''startcron''' [-applicationName <arg>] [-custom0 <arg>] [-custom1 <arg>] [-custom2 <arg>]
[-custom3 <arg>] [-d] [-dst] -firstExecutionTime <arg> [-inputPayloadFile <arg>] -interval <arg>
[-label <arg>] [-onError <arg>] -orderType <arg> [-r] [-timeZone <arg>] [-versionName <arg>]
[-workspaceName <arg>]
''# Deregister an additional Data Model type implementation''
./xynafactory.sh '''deregisterdatamodeltype''' -name <arg>
''# Export Data Models''
./xynafactory.sh '''exportdatamodels''' [-datamodelfqname <args>] -filename <arg>
''# Import a new Data Model''
./xynafactory.sh '''importdatamodel''' -datamodeltype <arg> [-files <args>] [-importParameters <args>]
''# Import previously exported Data Models''
./xynafactory.sh '''importdatamodelarchive''' -filename <arg> [-o]
''# List registered Data Models''
./xynafactory.sh '''listdatamodels''' [-datamodeltype <arg>] [-v]
''# List registered Data Model type implementations''
./xynafactory.sh '''listdatamodeltypes''' [-lang <arg>]
''# Modify an existing Data Model''
./xynafactory.sh '''modifydatamodel''' -datamodelname <arg> -datamodeltype <arg> -datamodelversion <arg>
[-parameters <args>]
''# Register an additional Data Model type implementation''
./xynafactory.sh '''registerdatamodeltype''' -fqClassName <arg> -name <arg>
''# Remove a Data Model''
./xynafactory.sh '''removedatamodel''' -datamodelname <arg> -datamodeltype <arg> -datamodelversion <arg>
[-parameters <args>]
''# Register a Trigger''
./xynafactory.sh '''addtrigger''' -fqClassName <arg> -jarFiles <args> -sharedLibs <arg> -triggerName <arg>
[-v] [-workspaceName <arg>]
''# Deploy a saved Workflow with an optional Workflow protection mode''
./xynafactory.sh '''deploy''' [-applicationName <arg>] -fqWorkflowName <arg> [-protectionMode <arg>]
[-versionName <arg>] [-workspaceName <arg>] [-xmlFile <arg>]
''# Deploy a saved [[Data Type]]''
./xynafactory.sh '''deploydatatype''' [-applicationName <arg>] -fqDatatypeName <arg> [-libraries <arg>]
[-protectionMode <arg>] [-registerWithXMOM <arg>] [-versionName <arg>] [-workspaceName <arg>]
[-xmlFile <arg>]
''# Deploy a saved [[Exception Type]]''
./xynafactory.sh '''deployexception''' [-applicationName <arg>] -fqExceptionName <arg> [-protectionMode <arg>]
[-versionName <arg>] [-workspaceName <arg>] [-xmlFile <arg>]
''# Instantiate the Filter with the given name and attach to specified Trigger''
./xynafactory.sh '''deployfilter''' [-applicationName <arg>] -filterInstanceName <arg> -filterName <arg> [-o]
-triggerInstanceName <arg> [-configurationParameter <args>] [-documentation <arg>] [-v] [-versionName <arg>] [-workspaceName <arg>]
''# Deploy multiple objects''
./xynafactory.sh '''deploymultiple''' [-applicationName <arg>] [-fqDatatypeNames <args>]
[-fqExceptionNames <args>] [-fqWorkflowNames <args>] [-protectionMode <arg>] [-versionName <arg>]
[-workspaceName <arg>]
''# Deploy a saved Shared Libraries''
./xynafactory.sh '''deploysharedlib''' [-applicationName <arg>] -sharedLibName <arg> [-versionName <arg>]
[-workspaceName <arg>]
''# Instantiate the Trigger with the specified name''
./xynafactory.sh '''deploytrigger''' [-applicationName <arg>] [-startParameters <args>]
-triggerInstanceName <arg> -triggerName <arg> [-v] [-versionName <arg>] [-workspaceName <arg>]
''# Disable the Filter instantiated with the specified name''
./xynafactory.sh '''disablefilterinstance''' [-applicationName <arg>] -filterinstancename <arg> [-v]
[-versionName <arg>] [-workspaceName <arg>]
''# Disable the Trigger instantiated with the specified name''
./xynafactory.sh '''disabletriggerinstance''' [-applicationName <arg>] [-d] -triggerinstancename <arg> [-v]
[-versionName <arg>] [-workspaceName <arg>]
''# Re-enable a previously disabled Filter instance''
./xynafactory.sh '''enablefilterinstance''' [-applicationName <arg>] -filterinstancename <arg> [-v]
[-versionName <arg>] [-workspaceName <arg>]
''# Re-enable a previous disabled Trigger instance''
./xynafactory.sh '''enabletriggerinstance''' [-applicationName <arg>] [-d] [-orderentrancelimit <arg>]
-triggerinstancename <arg> [-v] [-versionName <arg>] [-workspaceName <arg>]
''# Undeploy a Data Type and all Data Types and Workflows that depend on it''
./xynafactory.sh '''forceundeploydatatype''' -fqDatatypeName <arg> [-i]
''# Refresh all XMOM objects in a Workspace''
./xynafactory.sh '''refreshworkspace''' [-applicationName <arg>] [-d] [-f] [-protectionMode <arg>]
[-workspace <arg>]
''# Unregister a Filter''
./xynafactory.sh '''removefilter''' -filterName <arg> [-v] [-workspaceName <arg>]
''# Unregister a Trigger''
./xynafactory.sh '''removetrigger''' -triggerName <arg> [-workspaceName <arg>]
''# Show the detailed information of a [[Deployment Item]]''
./xynafactory.sh '''showdeploymentitemdetails''' [-applicationName <arg>] -objectName <arg> [-v]
[-versionName <arg>] [-workspaceName <arg>]
''# Undeploy a Workflow''
./xynafactory.sh '''undeploy''' [-applicationName <arg>] -fqWorkflowName <arg> [-i] [-versionName <arg>]
[-workspaceName <arg>]
''# Undeploy a Data Type''
./xynafactory.sh '''undeploydatatype''' [-applicationName <arg>] -fqDatatypeName <arg> [-i]
[-versionName <arg>] [-workspaceName <arg>]
''# Undeploy a deployed Exception Type''
./xynafactory.sh '''undeployexception''' [-applicationName <arg>] -fqExceptionName <arg> [-i]
[-versionName <arg>] [-workspaceName <arg>]
''# Remove a Filter instance from its associated Trigger instance''
./xynafactory.sh '''undeployfilter''' [-applicationName <arg>] -filterInstanceName <arg> [-v]
[-versionName <arg>] [-workspaceName <arg>]
''# Disable and stop a Trigger instance, thereby undeploying eventually associated Filter instances''
./xynafactory.sh '''undeploytrigger''' [-applicationName <arg>] -triggerInstanceName <arg> -triggerName <arg>
[-v] [-versionName <arg>] [-workspaceName <arg>]
''# Remove a Remote Destination from the specified dispatcher''
./xynafactory.sh '''removedestination''' [-applicationName <arg>] -destinationKey <arg> -dispatcherName <arg>
[-versionName <arg>] [-workspaceName <arg>]
''# Set a new Remote Destination on the specified dispatcher''
./xynafactory.sh '''setdestination''' [-applicationName <arg>] -destinationKey <arg> -destinationValue <arg>
-dispatcherName <arg> [-versionName <arg>] [-workspaceName <arg>]
''# Add a new code pattern''
./xynafactory.sh '''addcodepattern''' -codeGroupName <arg> -endIndex <arg> -padding <arg> -pattern <arg>
-startIndex <arg>
''# Lists all registered code groups''
./xynafactory.sh '''listcodegroups'''
''# Remove a code group''
./xynafactory.sh '''removecodegroup''' -name <arg>
''# Remove a code pattern''
./xynafactory.sh '''removecodepattern''' -codeGroupName <arg> -index <arg>
''# Lists key stores'' ./xynafactory.sh '''listkeystores''' ''# Lists registered key store type implementations'' ./xynafactory.sh '''listkeystoretypes''' [-lang <arg>] ''# Removes a key store'' ./xynafactory.sh '''removekeystore''' -name <arg>
''# Lists all datatypes generated from LDAP Schemas'' ./xynafactory.sh '''listldapgeneration''' [-v] ''# Removes all datatypes generated from LDAP Schemas'' ./xynafactory.sh '''removeldapgeneration'''
''# Lists all registered mail accounts''
./xynafactory.sh '''listregisteredmailaccounts''' [-p]
''# Register the mail account''
./xynafactory.sh '''registermailaccount''' [-accountPort <arg>] [-accountSecurity <arg>] -address <arg> [-host <arg>]
[-keyStore <arg>] -name <arg> [-password <arg>] [-r] [-transportPort <arg>]
[-transportSecurity <arg>] [-transportType <arg>] [-trustStore <arg>] [-type <arg>] [-user <arg>]
''# Remove a special property from the mail account''
./xynafactory.sh '''removemailaccountproperty''' -key <arg> -name <arg>
''# Remove the specified mail account''
./xynafactory.sh '''unregistermailaccount''' -name <arg>
''# Process a pending Manual Interaction'' ./xynafactory.sh '''processmanualinteraction''' -id <arg> -response <arg> ''# Show the order trace of a waiting Manual Interaction, i.e. list all known Parent Orders'' ./xynafactory.sh '''showwftrace''' -id <arg>
''# Insert a given number of Orders and calculates the resulting performance in Hz''
./xynafactory.sh '''benchmark''' [-maxParallel <arg>] -numberOfCalls <arg> -numberOfRuns <arg> -orderType <arg>
''# Directly call a Service (encapsulated by a trivial Workflow)''
./xynafactory.sh '''callservice''' [-applicationName <arg>] -pathToParameterFile <arg> [-versionName <arg>]
''# Cancel the Xyna Order with the provided [[Order ID]]''
./xynafactory.sh '''cancelorder''' -orderId <arg> [-timeout <arg>]
''# Change a scheduling time window for scheduling''
./xynafactory.sh '''changeschedulertimewindow''' [-comment <arg>] -definition <args> -name <arg>
''# Change the scheduling parameters of an Order already in the scheduler''
./xynafactory.sh '''changeschedulingparameter''' -orderId <arg> [-timeconstraint <arg>]
''# Try to authenticate a user in the specified domain''
./xynafactory.sh '''checkauthentication''' -domain <arg> -password <arg> -user <arg>
''# Removes old entries from xmomrepository (used to view old order audits)''
./xynafactory.sh '''cleanupxmomrepository''' -ageInDays <arg> [-F]
''# Configure an Order Type to be enabled to use the internal order context''
./xynafactory.sh '''configureordercontextmapping''' [-applicationName <arg>] -enable <arg> -orderType <arg>
[-versionName <arg>] [-workspaceName <arg>]
''# Set maximum number of events processed concurrently by one Trigger instance''
./xynafactory.sh '''configuretriggermaxevents''' [-a] [-applicationName <arg>] -maxEvents <arg>
-triggerInstanceName <arg> [-versionName <arg>] [-workspaceName <arg>]
''# Search for Orders or parts of Orders that are potentially broken''
./xynafactory.sh '''discoverabandonedorders''' [-d]
''# Encrypt a value using a given key used in secure storage table and prints the encrypted value''
./xynafactory.sh '''encrypt''' -key <arg> [-method <arg>] -value <arg>
''# Remove all evidence for the abandoned Order''
./xynafactory.sh '''forcecleanabandonedorder''' [-a] [-entryID <arg>] [-f] [-r]
''# Force a system exit on the Xyna Factory instance''
./xynafactory.sh '''forceexit'''
''# Import a file with localization data''
./xynafactory.sh '''importlocalization''' -filename <arg> [-o]
''# Try to abort a given Order (and all Orders belonging to its family) and especially frees the Capacities
''# that it uses''
./xynafactory.sh '''killprocess''' [-f] [-i] -orderId <arg>
''# List all detected abandoned orders''
./xynafactory.sh '''listabandonedorders''' [-v]
''# Show configurations set by command'' configuretriggermaxevents
./xynafactory.sh '''listconfigtriggermaxevents'''
''# List all Order Types for which a mapping to the corresponding order context object is created''
./xynafactory.sh '''listordercontextmappings'''
''# Show all configured [[Priority|Priorities]]''
./xynafactory.sh '''listpriorities'''
''# Pause the [[Scheduler]]. New orders can be placed but will not be executed. Running orders are allowed
''# to finish normally.''
./xynafactory.sh '''pausescheduler'''
''# Print the dependencies of the specified object''
./xynafactory.sh '''printdependencies''' [-applicationName <arg>] -object <arg> -objectType <arg> [-r]
[-versionName <arg>] [-workspaceName <arg>]
''# Print the used objects of the specified object''
./xynafactory.sh '''printusedobjects''' [-applicationName <arg>] -object <arg> -objectType <arg> [-r]
[-versionName <arg>] [-workspaceName <arg>]
''# Close and then recreates all connections in the specified connectionpool''
./xynafactory.sh '''refreshconnectionpool''' -connectionPoolName <arg> [-f]
''# Remove the Priority setting for an Order Type''
./xynafactory.sh '''removepriority''' [-applicationName <arg>] -orderType <arg> [-versionName <arg>]
[-workspaceName <arg>]
''# Remove a scheduling time window''
./xynafactory.sh '''removeschedulertimewindow''' [-f] -name <arg>
''# Try to schedule a waiting series order (force: regardless of predecessors) again''
./xynafactory.sh '''rescheduleseriesorder''' [-f] -orderId <arg>
''# Try to resolve the issue of an abandoned Order and start it to finish its execution''
./xynafactory.sh '''resolveabandonedorder''' [-a] [-entryID <arg>]
''# Resume normal operation of the Scheduler''
./xynafactory.sh '''resumescheduler'''
''# Store a key value pair in the secure storage''
./xynafactory.sh '''securestore''' -key <arg> -keytype <arg> -value <arg>
''# Set a Priority for an Order Type''
./xynafactory.sh '''setpriority''' [-applicationName <arg>] -orderType <arg> -priority <arg>
[-versionName <arg>] [-workspaceName <arg>]
''# Start a new Scheduler thread for Cron-like Orders if the Scheduler has stopped due to a severe exception''
./xynafactory.sh '''startcronlikeschedulerthread'''
''# Start an order without [[Input Parameter|Input Parameters]] asynchronously''
./xynafactory.sh '''startorder''' -orderType <arg> [-a] [-applicationName <arg>] [-inputPayloadFile <arg>]
[-p] [-priority <arg>] [-s] [-timeconstraint <arg>] [-timeout <arg>] [-versionName <arg>]
[-workspaceName <arg>]
''# Start a new Scheduler thread if the Scheduler has stopped due to a severe exception''
./xynafactory.sh '''startschedulerthread''' [-c] [-r]
''# Enable Service profiling for the specified entity''
./xynafactory.sh '''enableserviceprofiling''' [-application <arg>] [-ordertype <arg>] [-workspace <arg>]
''# Get the currently configured [[Monitoring Level]] for a given Order Type''
./xynafactory.sh '''getmonitoringlevel''' [-applicationName <arg>] [-orderType <arg>] [-versionName <arg>]
[-workspaceName <arg>]
''# List all active Orders, which are linked to a Workspace or an Application''
./xynafactory.sh '''listactiveorders''' [-applicationName <arg>] [-g] [-versionName <arg>] [-vf] [-vo] [-vt]
[-workspaceName <arg>]
''# List all available call and error statistics''
./xynafactory.sh '''listcallstats''' [-v]
''# List all deployed Data Types''
./xynafactory.sh '''listdoms''' [-applicationName <arg>] [-versionName <arg>] [-workspaceName <arg>]
''# List all deployed Exception Types''
./xynafactory.sh '''listexceptions''' [-applicationName <arg>] [-versionName <arg>] [-workspaceName <arg>]
''# List all Filters, their deployment status and the Trigger they are deployed on''
./xynafactory.sh '''listfilters''' [-c] [-e] [-i] [-o] [-r] [-v]
''# List all currently configured loggers''
./xynafactory.sh '''listlogger''' [-v]
''# List the last updated Orders. Use'' showorderdetails ''to find out more about a specific order.''
./xynafactory.sh '''listorders''' [-count <arg>] [-offset <arg>]
''# Show detailed information about the state of the Xyna [[Order Series]] Management''
./xynafactory.sh '''listorderseriesinfo''' [-v] [-vv]
''# List all Order Types and the correspondending Capacity status''
./xynafactory.sh '''listordertypescapacitystatus'''
''# List all Filter instances in Applications with their outdated versions''
./xynafactory.sh '''listoutdatedfilterinstances'''
''# Show detailed information about the state of the Scheduler''
./xynafactory.sh '''listschedulerinfo''' [-h] [-v] [-vv]
''# List all Shared Libraries''
./xynafactory.sh '''listsharedlibs''' [-applicationName <arg>] [-versionName <arg>] [-workspaceName <arg>]
''# List all available statistics''
./xynafactory.sh '''liststatistics''' [-c] [-path <arg>] [-v] [-vv]
''# List all suspended Orders''
./xynafactory.sh '''listsuspendedorders'''
''# Return information on the system''
./xynafactory.sh '''listsysteminfo''' [-r]
''# List information on the current and previous thread pool exhaustion''
./xynafactory.sh '''listthreadpoolinfo'''
''# List all Triggers and Trigger instances, their deployment status and start parameters''
./xynafactory.sh '''listtriggers''' [-e] [-i] [-o] [-r] [-s] [-v]
''# List all Workflows and the corresponding deployment state''
./xynafactory.sh '''listwfs''' [-applicationName <arg>] [-versionName <arg>] [-workspaceName <arg>]
''# Load the log properties from file''
./xynafactory.sh '''loadlogproperties''' [-filename <arg>]
''# Remove a previously configured Monitoring Level''
./xynafactory.sh '''removemonitoringlevel''' [-applicationName <arg>] -orderType <arg> [-versionName <arg>]
[-workspaceName <arg>]
''# Set the default Monitoring Level''
./xynafactory.sh '''setdefmonlvl''' -monitoringLevel <arg>
''# Set the log level for a logger''
./xynafactory.sh '''setloglevel''' -level <arg> -logger <arg>
''# Set the Monitoring Level for one Order Type, thereby overwriting the default value''
./xynafactory.sh '''setmonlvl''' [-applicationName <arg>] -code <arg> -orderType <arg> [-versionName <arg>]
[-workspaceName <arg>]
''# Show detailed information on a specific Order''
./xynafactory.sh '''showorderdetails''' -id <arg> [-v]
''# Evaluate'' SELECT/DESCRIBE ''statements on warehouse tables''
./xynafactory.sh '''sql''' [-ConnectionType <arg>] -Statement <arg>
''# Return the current Xyna Factory status''
./xynafactory.sh '''status''' [-v]
''# Return how long the Xyna Factory instance has been running''
./xynafactory.sh '''uptime'''
''# Show the Xyna Factory and [[XMOM]] versions''
./xynafactory.sh '''version'''
''# List all defined IP addresses'' ./xynafactory.sh '''listips''' [-v] ''# Remove the definition of an IP address'' ./xynafactory.sh '''removeip''' -name <arg>
''# Creates a new Remote Destination from a given Remote Destination type''
./xynafactory.sh '''createremotedestinationinstance''' [-instancedescription <arg>] -instancename <arg>
[-parameters <args>] -remotedestinationtype <arg>
''# Define a new cluster of Xyna Factory nodes''
./xynafactory.sh '''definefactorynodecluster''' [-comment <arg>] -factorynodes <args> -name <arg>
''# List information about all Xyna Factory node cluster''
./xynafactory.sh '''listfactorynodecluster''' [-v]
''# List information about all Xyna Factory nodes''
./xynafactory.sh '''listfactorynodes''' [-v]
''# List information about all Remote Destinations''
./xynafactory.sh '''listremotedestinationinstances'''
''# List information about all Remote Destination type ''
./xynafactory.sh '''listremotedestinationtypes''' [-lang <arg>]
''# Remove a Xyna Factory node''
./xynafactory.sh '''removefactorynode''' -name <arg>
''# Remove a Xyna Factory node cluster''
./xynafactory.sh '''removefactorynodecluster''' -name <arg>
''# List Order Input Sources''
./xynafactory.sh '''listorderinputsources''' [-applicationName <arg>] [-v] [-versionName <arg>]
[-workspaceName <arg>]
''# List registered Order Input Source type implementations''
./xynafactory.sh '''listorderinputsourcetypes''' [-lang <arg>]
''# Register an additional Order Input Source type implementation''
./xynafactory.sh '''registerorderinputsourcetype''' -fqClassName <arg> -name <arg>
''# Lists parameter inheritance rules of an ordertype''
./xynafactory.sh '''listinheritancerules''' [-applicationName <arg>] -orderType <arg> -parameterType <arg>
[-versionName <arg>] [-workspaceName <arg>]
''# Removes a parameter inheritance rule from an ordertype''
./xynafactory.sh '''removeinheritancerule''' [-applicationName <arg>] [-childFilter <arg>] -orderType <arg>
-parameterType <arg> [-versionName <arg>] [-workspaceName <arg>]
''# Create a job that periodically deletes data from one or more persistence layer instance''
./xynafactory.sh '''addwarehousedeletejob''' [-c] -connectionType <args> [-constraints <arg>] -interval <arg>
-tableName <arg>
''# Create a job that periodically replaces all data in one persistence layer with data from another''
./xynafactory.sh '''addwarehousereplacejob''' [-c] [-constraints <arg>] -interval <arg>
-sourceConnectionType <arg> -tableName <arg> -targetConnectionType <arg>
''# Apply index modifications that were previously discovered''
./xynafactory.sh '''applyindexchanges''' [-indexmodification <args>] [-plname <args>]
''# Deploy a new persistence layer''
./xynafactory.sh '''deploypersistencelayer''' -fqPersistenceLayerName <arg> [-persistenceLayerName <arg>]
''# Instantiate a persistence layer''
./xynafactory.sh '''instantiatepersistencelayer''' -connectionType <arg> -department <arg>
[-persistenceLayerID <arg>] [-persistenceLayerInstanceName <arg>] [-persistenceLayerName <arg>]
[-persistenceLayerSpecifics <args>]
''# List collisions between programmatic defined and backing store indices''
./xynafactory.sh '''listindexcollisions'''
''# List all persistence layers instances and the parameters to be used for instantiating one''
./xynafactory.sh '''listpersistencelayerinstances'''
''# List all registered persistence layers''
./xynafactory.sh '''listpersistencelayers'''
''# List all tables which are assigned to a specific persistence layer instance''
./xynafactory.sh '''listtableconfig'''
''# List all warehouse jobs that are currently registered''
./xynafactory.sh '''listwarehousejobs'''
''# Show the mapping of [[Storable|XMOM Storables]] to corresponding ODS storables including extensions''
./xynafactory.sh '''listxmomodsnames''' [-applicationName <arg>] [-c] [-fqDatatypeName <arg>] [-v] [-versionName
<arg>] [-workspaceName <arg>]
''# All operations on that table use the specified persistence layer instance''
./xynafactory.sh '''registertable''' [-c] [-persistenceLayerInstanceID <arg>]
[-persistenceLayerInstanceName <arg>] [-properties <arg>] -tableName <arg>
''# Reload XMLs of XML-based persistence layers''
./xynafactory.sh '''reloadxml'''
''# Remove an existing persistence layer instance''
./xynafactory.sh '''removepersistencelayerinstance''' [-persistenceLayerInstanceID <arg>]
[-persistenceLayerInstanceName <arg>]
''# Remove a registered warehouse job''
./xynafactory.sh '''removewarehousejob''' -jobID <arg>
''# Mark a persistence layer instance as default for one connection type''
./xynafactory.sh '''setdefaultpersistencelayer''' -connectionType <arg> [-persistenceLayerInstanceID <arg>]
[-persistenceLayerInstanceName <arg>]
''# Redefine the ODS storable name corresponding to an XMOM Storable or its extensions''
./xynafactory.sh '''setxmomodsname''' [-applicationName <arg>] -fqDatatypeName <arg> [-fqPath <arg>] [-odsName <arg>]
[-path <arg>] [-versionName <arg>] [-workspaceName <arg>]
''# Undeploy a persistence layer''
./xynafactory.sh '''undeploypersistencelayer''' -fqPersistenceLayerName <arg>
''#Remove a registered table configuration''
./xynafactory.sh '''unregistertable''' -connectionType <arg> [-d] -tableName <arg>
''# List all registered queues''
./xynafactory.sh '''listqueues''' [-o]
''# Register a queue''
./xynafactory.sh '''registerqueue''' -connectParameters <args> -externalName <arg> -queueType <arg>
-uniqueName <arg>
''# Rename an [[XMOM Object]]''
./xynafactory.sh '''refactorxmomname''' [-c] [-label <arg>] [-password <arg>] [-s] -sourcefqname <arg>
-targetfqname <arg> [-targettype <arg>] [-username <arg>] [-workspaceName <arg>]
''# List information about all registered repository access implementations'' ./xynafactory.sh '''listrepositoryaccessimpls''' ''# List information about all repository access instances'' ./xynafactory.sh '''listrepositoryaccessinstances''' ''# Register an additional repository access implementation'' ./xynafactory.sh '''registerrepositoryaccess''' -fqClassName <arg> -name <arg>
''# Changes runtime context dependencies''
./xynafactory.sh '''changeruntimecontextdependencies''' -changes <args> [-f] [-ownerApplicationName <arg>]
[-ownerVersionName <arg>] [-ownerWorkspaceName <arg>]
''# List all Requirements of the specified Runtime Context. If no Runtime Context is specified all''
''# Runtime Context Requirements will be listed''
./xynafactory.sh '''listruntimecontextdependencies''' [-applicationName <arg>] [-t] [-versionName <arg>]
[-workspaceName <arg>]
''# Define a new Runtime Context Requirement''
./xynafactory.sh '''migrateruntimecontext''' [-f] [-fromApplicationName <arg>] [-fromVersionName <arg>]
[-fromWorkspaceName <arg>] [-migrationTargets <arg>] [-toApplicationName <arg>] [-toVersionName <arg>]
[-toWorkspaceName <arg>]
''# Remove an existing Runtime Context Requirement''
./xynafactory.sh '''removeruntimecontextdependency''' [-ownerApplicationName <arg>] [-ownerVersionName <arg>]
[-ownerWorkspaceName <arg>] [-requirementApplicationName <arg>] [-requirementVersionName <arg>]
[-requirementWorkspaceName <arg>]
''# Add the specified key pair to the own identities'' ./xynafactory.sh '''addkeypair''' [-passphrase <arg>] -privatekey <arg> -publickey <arg> ''# Register a public key for a host'' ./xynafactory.sh '''addknownhost''' -hostname <arg> -publickey <arg> [-comment <arg>] ''# Export host entries to a file'' ./xynafactory.sh '''exportknownhost''' [-encryptiontype <arg>] -filename <arg> [-hostname <arg>] ''# Generate a new private-public key pair and add it as own identity'' ./xynafactory.sh '''generatekeypair''' -encryptiontype <arg> [-keysize <arg>] [-o] [-passphrase <arg>] ''# Return the own public identities'' ./xynafactory.sh '''getpublickey''' [-encryptiontype <arg>] ''# Import host entries from a file'' ./xynafactory.sh '''importknownhost''' -filename <arg> ''# Remove the specified identities'' ./xynafactory.sh '''removeidentities''' [-encryptiontype <arg>] [-publickey <arg>] ''# Remove the entries for a registered host'' ./xynafactory.sh '''removeknownhost''' [-encryptiontype <arg>] -hostname <arg> [-publickey <arg>]
''# Create JAR file containing all mdm class files for development purposes''
./xynafactory.sh '''buildmdmjar''' [-applicationName <arg>] [-r] [-targetDirectory <arg>] [-versionName <arg>]
[-workspaceName <arg>]
''# Create JAR file containing the currently saved Service contracts''
./xynafactory.sh '''buildservicedefinitionjar''' -fqDatatypeName <arg> [-targetDirectory <arg>]
[-workspaceName <arg>]
''# Create a Service template to import in Eclipse''
./xynafactory.sh '''buildserviceproject''' -fqDatatypeName <arg> -targetDirectory <arg> [-workspaceName <arg>]
''# Create a Trigger template to import in Eclipse''
./xynafactory.sh '''buildtriggerproject''' [-targetDirectory <arg>] -triggerName <arg> [-workspaceName <arg>]
''# Refresh loading of JAR files in Shared Library. All Triggers depending on this library will be restarted.''
./xynafactory.sh '''reloadsharedlib''' [-applicationName <arg>] -sharedLibName <arg> [-versionName <arg>]
[-workspaceName <arg>]
''# List the libraries available for XMOM compiling''
./xynafactory.sh '''showlibs''' [-h]
''# (Re)Starts a registered infrastructure thread'' ./xynafactory.sh '''startinfrastructurethread''' -name <arg> [-parameter <args>] [-r] ''# Stop a registered infrastructure thread'' ./xynafactory.sh '''stopinfrastructurethread''' -name <arg>
''# Continue a paused Time-Controlled Order''
./xynafactory.sh '''continuebatchprocess''' [-f] -orderId <arg>
''# List all registered Time Controlled Orders''
./xynafactory.sh '''listtimecontrolledorders''' [-o] [-t]
''# Migrate a Time-Controlled Order to another Application''
./xynafactory.sh '''migratebatchprocess''' -applicationName <arg> -orderId <arg> -versionName <arg>
''# Modify an existing Time Controlled Order''
./xynafactory.sh '''modifytimecontrolledorder''' -id <arg> [-calendarDefinition <arg>] [-custom0 <arg>]
[-custom1 <arg>] [-custom2 <arg>] [-custom3 <arg>] [-dst <arg>] [-enabled <arg>]
[-firstExecutionTime <arg>] [-label <arg>] [-onError <arg>] [-orderType <arg>] [-timeZone <arg>]
''# Pause the Time-Controlled Order with the provided Order ID''
./xynafactory.sh '''pausebatchprocess''' -orderId <arg>
''# Refresh the slave scheduling data of the Time-Controlled Order with the provided Order ID''
./xynafactory.sh '''refreshbatchprocess''' -orderId <arg>
''# Register and start a new Time Controlled Order''
./xynafactory.sh '''starttimecontrolledorder''' [-applicationName <arg>] [-calendarDefinition <arg>]
[-custom0 <arg>] [-custom1 <arg>] [-custom2 <arg>] [-custom3 <arg>] [-d] [-dst]
-firstExecutionTime <arg> [-inputPayloadFile <arg>] [-label <arg>] [-onError <arg>]
-orderType <arg> [-r] [-timeZone <arg>] [-versionName <arg>] [-workspaceName <arg>]
''# Lists existing time series'' ./xynafactory.sh '''listtimeseries'''
''# Change the role of a user''
./xynafactory.sh '''changerole''' -roleName <arg> -userName <arg>
''# Create a new domain''
./xynafactory.sh '''createdomain''' -connectionTimeout <arg> -domainName <arg> -domainType <arg>
-maxRetries <arg>
''# Create a new [[right]], if its name satisfies the naming conventions''
./xynafactory.sh '''createright''' -rightName <arg> [-documentation <arg>] [-language <arg>]
''# Creates a new rmi proxy for given roles''
./xynafactory.sh '''creatermiproxy''' [-d] [-documentation <arg>] [-p] [-port <arg>] -proxyName <arg>
[-registryHost <arg>] [-registryPort <arg>] [-rights <args>] [-roles <args>]
''# Creates the rmi interface for the given proxyName or for given roles and rights''
./xynafactory.sh '''creatermiproxyinterface''' [-d] [-p] -proxyName <arg> [-rights <args>]
[-roles <args>] [-s] [-targetDirectory <arg>]
''# Create a role without any rights associated with the specified domain''
./xynafactory.sh '''createrole''' -domainName <arg> -roleName <arg>
''# Create a new user''
./xynafactory.sh '''createuser''' [-domainName <args>] [-e] -password <arg> -roleName <arg> -userName <arg>
''# Delete an existing domain if it's not assigned to a role or an user''
./xynafactory.sh '''deletedomain''' -domainName <arg>
''# Delete an existing right and revokes it from all roles''
./xynafactory.sh '''deleteright''' -rightName <arg>
''# Delete a role in the specified domain if it is not assigned to a user''
./xynafactory.sh '''deleterole''' -domainName <arg> -roleName <arg>
''# Delete a user''
./xynafactory.sh '''deleteuser''' -userName <arg>
''# Generate a shell script that will import all domains registered on this Xyna Factory''
./xynafactory.sh '''exportdomains''' -scriptName <arg>
''# Generate a shell script that will import all rights registered on this Xyna Factory''
./xynafactory.sh '''exportrights''' -scriptName <arg>
''# Generate a shell script that will import all roles, domains and rights registered on this Xyna Factory''
./xynafactory.sh '''exportroles''' -scriptName <arg>
''# Generate a shell script that will import all users, roles, domains and rights registered on this''
''# Xyna Factory''
./xynafactory.sh '''exportusers''' -scriptName <arg>
''# Set a list of domains that overwrite the local domain user settings''
./xynafactory.sh '''globaloverwritedomain''' -domainName <args>
''# Grant a right to an existing role''
./xynafactory.sh '''grantright''' -rightName <arg> -roleName <arg>
''# Import a user. If the user is already present it's role and password will be updated.''
./xynafactory.sh '''importuser''' -passwordHash <arg> -roleName <arg> -userName <arg>
''# List all registered domains''
./xynafactory.sh '''listdomains'''
''# List all available rights''
./xynafactory.sh '''listrights'''
''# List informations about all rmi proxies''
./xynafactory.sh '''listrmiproxies''' [-v]
''# List all registered roles''
./xynafactory.sh listroles [-roleName <arg>]
''# List all registered users''
./xynafactory.sh '''listusers'''
''# Remove an existing rmi proxy''
./xynafactory.sh '''removermiproxy''' -name <arg>
''# Reset the password of a blocked user''
./xynafactory.sh '''resetpassword''' -newPassword <arg> -userName <arg>
''# Revoke a right from an existing role''
./xynafactory.sh '''revokeright''' -rightName <arg> -roleName <arg>
''# Map an external role to the specified internal one''
./xynafactory.sh '''setalias''' -alias <arg> -domainName <arg> -roleName <arg>
''# Set the default domains that new users will authorize on''
./xynafactory.sh '''setdefaultdomains''' -domainName <args>
''# Set the domains the specified user should authorize on''
./xynafactory.sh '''setdomains''' [-domainNames <args>] -userName <arg>
''# Assign the type specific data to the specified domain''
./xynafactory.sh '''setdomaintypespecificdata''' -domainName <arg> -domainTypeSpecificData <args>
''# Set the password of a user, hashing it in the process''
./xynafactory.sh '''setpassword''' -newPassword <arg> -userName <arg>
''# Set the password of a user to the specified hash''
./xynafactory.sh '''setpasswordhash''' -newPasswordHash <arg> -userName <arg>
''# Assign the specified RadiusDomaintypeSpecificData to the specified domain''
./xynafactory.sh '''setradiusdomaintypespecificdata''' -associatedOrdertype <arg> -domainName <arg>
-servers <args>
''# Sets documentation of a right''
./xynafactory.sh '''setrightdocumentation''' -documentation <arg> [-language <arg>] -rightName <arg>
''# Instruct the XMOM Access to deploy the objects'' ./xynafactory.sh '''deployxmomaccesscomponent''' [-componentName <arg>] [-workspaceName <arg>] ''# List information about all XMOM Access instances'' ./xynafactory.sh '''listxmomaccessinstances'''
''# Lists all Xyna Properties and their readers'' ./xynafactory.sh '''listproperties''' [-lang <arg>] [-p] [-showdoc] [-v] [-vv] ''# Remove a Xyna Property'' ./xynafactory.sh '''removeproperty''' -key <arg> [-g] ''# Set a Xyna Property's value'' ./xynafactory.sh '''set''' -key <arg> -value <arg> [-g] [-n] ''# Set a Xyna Property's documentation'' ./xynafactory.sh '''setpropertydocumentation''' -key <arg> -documentation <arg> [-language <arg>]