Adding Business Hosts (Legacy UI)
This topic describes how to use the legacy Production Configuration page to add business hosts to a production.
For information on performing these tasks with the new UI, see Adding Business Hosts.
Introduction
A business host is any business service, business process, or business operation within a production. These are also referred to generically as configuration items.
A configuration item is always associated with a specific production. It may resemble or duplicate items in other productions. Each production is an entirely closed universe that does not use configuration items from other productions.
Configuration Names
By default, the name of a configuration item is the name of its underlying host class. However, you can assign a different name, to describe the purpose of the item, for example.
For example, if you have a business service class that communicates with a specific type of server, and you use it to communicate with the same type of server in different enterprise locations, you must configure the business service with different settings to communicate with each enterprise location, even though the type of server is the same. Each different configuration of the business service must have a different Name in the diagram (except see Working with Multiple Versions of a Business Host).
The following rules govern configuration names:
-
The name must consist of at least one character.
-
The name can contain letters, numbers, and any printable character except for the following:
| ; , : [ < > \ / & "
-
Neither the first nor the last character can be any of the following: ! $ .
-
The first character cannot be _
-
The name (if is it one character long) cannot be *
Adding Business Hosts to a Production
To add a business host to a production:
-
Identify (or create and compile) the appropriate business host class.
-
Open the production on the Interoperability > Configure > Production page.
-
Click plus-sign icon next to the Services, Processes, or Operations column heading.
-
Use the wizard; the details are different for the Business Service Wizard, the Business Process Wizard, and the Business Operation Wizard.
-
Click OK to add the process to the production.
-
Configure the business process as needed.
This process does not generate any new classes. It updates the production class.
Business Service Wizard
The Business Service Wizard provides multiple tabs, which correspond to different types of business service classes to use. Click a tab and then specify values as follows:
-
If you click the All Services tab, specify the following values:
-
Choose a host class from the Service Class list. If the class you need is not listed, create and compile the class in an IDE, and then return here to choose it.
-
Specify a configuration Service Name. For rules, see Configuration Names.
-
Enter a text label in the Display Category field to sort and organize items within the production. Display Category names are case-sensitive, and space characters are allowed. To place an item in multiple categories, list them in the Display Category field separated by commas (with no spaces around these commas).
-
Comment is an optional text description.
-
-
If you click the X12 Input tab or HL7 Input tab (if available), specify the following values:
-
Choose a messaging protocol to select an existing specialized host class.
-
Specify a configuration Name. For rules, see Configuration Names.
-
Use the Target Name field to identify the business process or business operation to which this business service will send the messages that it receives.
If you select the Create New Router option, you can use the New Rule Package field to specify a package name that will be added to the name of the rule created for the new router. If you do not specify a New Rule Package value, the production’s package is used.
-
Select the Default applies if no value check box if you want blank settings to be replaced with the system default settings when the business service is created. Fields identified by an asterisk (*) will be replaced with the system default values. Click
to view the possible default values.
-
-
If you click the Business Metric tab, specify the following values:
-
Choose a host class from the MetricClass drop-down list. If the class you need does not appear on this list, create the class in an IDE, then return to choose it.
-
Specify a configuration Name. For rules, see Configuration Names.
-
Enter a text label in the Category field to sort and organize items within the production. Category names are case-sensitive, and space characters are allowed. To place an item in multiple categories, list them in the Category field separated by commas (do not allow spaces around these commas).
-
Comment is an optional text description.
-
Call Interval determines how often the business metric will recalculate the values of its properties. The Call Interval is in seconds, starting from a minimum of 0.1 seconds. The default is 5 seconds.
-
Business Process Wizard
The Business Process Wizard provides multiple tabs, which correspond to different types of business process classes to use. Click a tab and then specify values as follows:
-
If you click the All Processes tab, specify the following values:
-
Business Process Class—Choose a base class from the list of valid business process classes. If the class you need does not appear on this list, create and compile the class and then return here to choose it.
-
Specify a configuration Name. For rules, see Configuration Names.
The wizard defaults to the business process class name if you leave this blank.
-
Specify other values as given after this list.
-
-
If you click the X12 Router tab or HL7 Router tab (if available), specify the following values:
-
Auto-create Rule—Select this check box to create a rule definition name based on the business process class name. When Auto-create rule is selected, you can use the New Rule Package field to specify a package name that will be added to the name of the rule created for the new router. If you do not specify a New Rule Package value, the production’s package is used. In most cases, the New Rule Package field is ignored if the Routing Process Name field begins with a package name. However, if the package specified by the Routing Process Name field is the system package name Ens or Enslib, a rule that is auto-created will have a different package name added to the beginning of the rule name. This additional package is determined by the contents of the New Rule Package field. If the package of the production or routing process is used instead of a specified value, the generated rule class name ends with 'RoutingRule'.
-
Routing Rule Name—Use the field to identify the name of the routing rule set to which this business process sends the messages that it receives. Only appears if the previous check box is cleared.
Once you select a rule name, you can click the magnifying glass to open the Rule Editor.
-
Specify a Routing Process Name. For rules, see Configuration Names. To specify a package for the new routing process, use the format package.name in the field.
The underlying business process class is EnsLib.MsgRouter.VDocRoutingEngineOpens in a new tab depending on which type of router you choose.
-
Specify other values as given after this list.
-
-
If you click the Component tab, specify the following values:
-
Component Class—Choose a base class from the list of valid business process classes designated as components.
-
Component Name—Enter a configuration name for this item. For rules, see Configuration Names. The wizard defaults to the component class name if you leave this blank.
-
Specify other values as given after this list.
-
Note that all types of business process share the following optional fields:
-
Display Category—Enter a text label in the field to sort and organize items within the production. Category names are case-sensitive and space characters are allowed. To place an item in multiple categories, enter a comma-separated list.
-
Comment—Enter a brief comment about the business process to appear in the informational settings.
-
Enable Now—Select this check box if you want this business process to begin processing messages immediately when the production runs; clear it for the process to be initially disabled.
Business Operation Wizard
The Business Operation Wizard provides multiple tabs, which correspond to different types of business operation classes to use. Click a tab and then specify values as follows:
-
If you click the All Operations tab, specify the following values:
-
Choose a host class from the Operation Class list. If the class you need does not appear on this list, create the class in an IDE, then return here to choose it.
-
Specify a configuration Name. For rules, see Configuration Names.
-
Enter a text label in the Display Category field to sort and organize items within the production. Display Category names are case-sensitive, and space characters are allowed. To place an item in multiple categories, list them in the Display Category field separated by commas (do not allow spaces around these commas).
-
Comment is an optional text description.
-
Specify other values as given after this list.
-
-
If you click the X12 Output tab, specify the following values:
-
Choose TCP, File, or FTP to determine the host class. Each class already exists and requires no programming. Simply choose one.
-
Give the item a configuration X12 Operation Name. For rules, see Configuration Names.
-
Specify other values as given after this list.
-
Select the Default applies if no value check box if you want blank settings to be replaced with the system default settings when the business operation is created. Fields identified by an asterisk (*) will be replaced with the system default values. Click
to view the possible default values.
-
-
If you click the Workflow tab, specify the following values:
-
Choose a host class from the Operation Class drop-down list. If the class you need does not appear on this list, create the class in an IDE, then return here to choose it.
-
Give the item a configuration Operation Name. For rules, see Configuration Names.
-
Choose whether or not to auto-create a workflow role.
-
Specify other values as given after this list.
-
All types of business operation share the following optional fields:
-
Display Category—Enter a text label in the field to sort and organize items within the production. Category names are case-sensitive and space characters are allowed. To place an item in multiple categories, enter a comma-separated list.
-
Comment—Enter a brief comment about the business operation to appear in the informational settings.
-
Enable Now—Select this check box if you want this business operation to begin processing messages immediately when the production runs; clear it for the operation to be initially disabled.
