Server field descriptions
Server fields are used to specify information about individual servers when you are creating and updating server definitions. Fields that are displayed depend on the server type you are configuring.
| Field | Description |
|---|---|
| API Port | The API port number used to access a Sterling Connect:Direct®, Sterling Connect:Enterprise® for UNIX, Sterling Connect:Express for Microsoft Windows, Sterling Connect:Express for UNIX or FTP server. For Sterling Connect:Enterprise, API port is the listening port for cmusvid. Sterling Connect:Direct default is 1363; must be 1024-65535. FTP default is 21; must be 1-65535. |
| Account List | The accounts on which to retrieve information. If you leave this field blank, information for all accounts is retrieved. Separate accounts with commas. |
| Adapter List | Click Adapter List to
display a list of all available Sterling B2B Integrator adapters. Tip: Complete the entire procedure to create the server. Then,
access the Settings tab on the Server
Properties page to see this button.
|
| Adapter Selection | A list of all available Sterling B2B Integrator adapters. You can select the adapters that you want to monitor from this list. By default, all adapters are selected. When you exclude an adapter from monitoring, its status is not reflected in the Environmental Health widget or the Adapter Status List. |
| Adapter Status Monitor Rest Time | The amount of time IBM Sterling Control Center Monitor waits between polls of adapter status from Sterling B2B Integrator servers. Values are 1-60 minutes. The default is 1 minute. |
| Agent Address | The server address of the FTP agent. |
| Agent Port Number | The port number for the FTP agent. |
| Alerts | The number of alerts issued for this server, broken into high, medium, and low severity. Display only. |
| Available Fields | Fields that can be used to describe your IIS or xferlog record layout. If your FTP server log contains these fields, move them to Selected Fields. Use the Move Up and Move Down buttons to position a particular field in its proper position. Use the <ignored-placeholder> field if your FTP log contains a field that is not listed in Available or Selected Fields. |
| BP List | Click BP List to display a list of all available Sterling B2B Integrator business processes. You can select from this list the business processes that you want to monitor. Tip: Complete the entire procedure
to create the server. Then, return to the Settings tab
on the Server Properties page to see this button.
|
| Business Process | A list of all available Sterling B2B Integrator business processes. Click Find to type a string of characters to quickly look up a particular business process. Then, click the down and up arrows to move from instance to instance. Click Refresh to ensure that the list is up-to-date. |
| Channel Name | The name of the JMS channel that IBM Sterling Control Center Monitor communicates with to receive messages. |
| Check for configuration changes | When to check for configuration changes in servers centrally managed by IBM Sterling Control Center Monitor. You can choose to use the system settings, never check for changes, or check daily at a specific time. |
| Comments | Optional contact information for the server.
Up to 255 characters. To include a link you can click, use one of
the following prefixes, and then type the remaining information: http://
ftp:// mailto:// file:// |
| Component Licenses | This display-only listing shows license information for each component licensed in Sterling B2B Integrator. The components include the following: Sequence #, Product Version, Component, Product ID, IP, Start Date, and Expiration Date. |
| Connection | The protocol (TCP/IP, SSL, or TLS) used for communication with a Sterling Connect:Direct TCP/IP API server. |
| Connection Timeout | The amount of time the IBM Sterling Control Center Monitor engine waits for a response from a server it has attempted to contact. Do not change this value unless you are receiving timeout errors in the engine log for the server in question. The default and minimum is 30 seconds; 120 seconds for Sterling B2B Integrator servers. Maximum value is 600 seconds. |
| Customer Name | The name of the customer to whom the license was issued. Display only. |
| Dashboard Port | The port for accessing the Sterling B2B Integrator dashboard. |
| Date/Time in Last Record Retrieved | Date and time the last record was retrieved from the server. |
| Description | A description of the server. To include a link
you can click, use one of the following prefixes, and then type the
remaining information: http://
ftp:// mailto:// file:// |
| Details | Click to view license details for this server. Display only. |
| Do not allow configuration management on this server | Check to prevent configuration management from being performed on this server. Optional. |
| Do not collect process step statistics | Check this box to prevent server management from collecting
statistics generated by a Process step. Optional. Important: If you want to view FASP
statistics from a Sterling Connect:Direct server that
uses FASP, do not check this box.
|
| Do not monitor this server | Check to prevent server management from monitoring the server. Optional. |
| Server contact email address. Optional. Special characters allowed. Spaces are not allowed. | |
| Expiration Date | Date that the managed servers license expires. Display only. |
| Field | This column contains the names of variables that pertain to the Sterling B2B Integrator environment. |
| Graphical Activity Monitor expected maximum processes: Use High Water Mark | Use High Water Mark as the maximum number of processes this server is expected to have active at one time. High Water Mark is a system-generated statistic that indicates the maximum processes active on a server since the value was last reset. Used in graphical depictions of server activity. |
| Graphical Activity Monitor expected maximum processes: Use other value | Click to use a value other than the High Water Mark or System Settings-Visualization. Enter a value to set the maximum number of processes the server is likely to have active at one time. The range is 0-2,147,483,647. Used in graphical depictions of server activity. |
| Graphical Activity Monitor expected maximum processes: Use System Settings | Click to set the maximum number of processes that the server is likely to have active at one time to the default value on the System Settings panel, Visualization tab. Used in graphical depictions of server activity. |
| Groups | The server groups to choose from. Move by selecting a server group and clicking the Right Arrow button. Optional. |
| Heartbeat Interval | For Sterling Connect:Enterprise for z/OS® and Sterling Connect:Express for z/OS, the amount of time IBM Sterling Control Center
Monitor waits for an SNMP trap. ForSterling Secure Proxy, the amount of time IBM Sterling Control Center
Monitor waits for messages. Values are:
|
| Hostname | The host address the JMS provider listens on. |
| i5/OS Host Name | The host name for the Sterling Connect:Direct for i5/OS server. |
| JMS Provider | The type of JMS provider: IBM WebSphere® MQ. |
| Last Contact At | Date and time of last contact with the server. |
| Last Retrieved | The date and time that the license was last retrieved and validated. Display only. |
| Last System Message | Last status message or messages received from the node service monitoring the server. Display only. |
| Library Name | The host name for the Sterling Connect:Direct for i5/OS server. |
| License Key | Server license key. Display only. |
| License Push Supported/Not Supported | The IBM product specified in the license key. Display only. |
| License Type | Type of license in place for the server. Display only. |
| Limit | The maximum number of queued processes allowed for this server before IBM Sterling Control Center Monitor generates an event. If the limit is exceeded, IBM Sterling Control Center Monitor generates an event of type Server Status with a message ID of CCNS020E. When the actual number of processes (depth) falls at or below the limit, IBM Sterling Control Center Monitor generates a Server Status event with a message ID of CCNS030I. You can write a rule to trigger an alert on either of these server status events. |
| Location | Location of Sterling B2B Integrator installation files. |
| Log File Name/Directory | Name of the FTP log file and its directory path or both. If the FTP server log has a static name, specify the directory and file name, for example, C:\FtpServer\Logs\server.txt. If the FTP server log is dynamic, such that it changes every day or hour, specify only the directory without a file name, for example, C:\FtpServer\Logs. If the directory contains files other than the managed FTP server log files, qualify what you enter. When you do this, IBM Sterling Control Center Monitor monitors only information from the appropriate log files. Otherwise, errors occur. For example, if all your log files start with ABC, you could enter ABC*.txt as a wildcard log name template. Or if your log files have a naming standard, such as, serverYYYY-MM-DD.log for a daily rotating log, set Log File Name to C:\FtpServer\Logs\server*.log. With this option, you can select the changing daily log name and ensure that only the FTP Server logs are processed. |
| Max File Agent Activity | Attention: This field is only available for IBM Sterling Connect:Direct servers.
The maximum number of file agent activities that the engine keeps in memory and displays in the Completed File Agent Activity Monitor. Range is 1-200. Default is 100. For the server, the Completed File Agent Activity Monitor never shows more rows than this number. |
| Max Concurrent Processes | The maximum number of concurrent sessions that have occurred on the server, the number of times that this maximum was reached, and the last date and time that the maximum was reached. This information is display only, although it can be reset to zero. |
| Metadata Rule handling: Apply Metadata Rules to statistics | Select to apply metadata rules to statistics for this server. |
| Minimum age of version | The minimum number of days that IBM Sterling Control Center Monitor retains a configuration object version. You can specify that this value default to the one in System Settings or override it with a different value. |
| Minimum number of versions | The minimum number of versions retained by IBM Sterling Control Center Monitor for each configuration object type. You can specify that this value default to the one in System Settings or override it with a different value. |
| Monitor | Check to monitor the queue. |
| Monitor Business Processes | Check to monitor Sterling B2B Integrator business processes. |
| Monitored | Business processes being monitored by IBM Sterling Control Center Monitor. Clear to exclude. |
| Monitor File Gateway Activity | Check to monitor Sterling B2B Integrator events and activities. |
| Monitor Rest Time | The amount of time IBM Sterling Control Center
Monitor waits
before polling the server to check status and collect statistics.
Values are:
|
| Name | A contact name for the server. Optional. Up to 50 characters. |
| Name or Alias | The name or alias that identifies a server in the IBM Sterling Control Center Monitor window, up to 25 characters. The name/alias must be unique within IBM Sterling Control Center Monitor. Typically, the name or alias is the Sterling Connect:Enterprise, Sterling Connect:Direct, Sterling B2B Integrator, or FTP server name. |
| Node Type | Type of Sterling B2B Integrator, Sterling Secure Proxy, or MQ MFT node. For Sterling B2B Integrator, possible values include a single instance or cluster not through a load balancer. For Sterling Secure Proxy and MQ MFT, possible values include a single Queue Manager instance not through a load balance, or a multi-instance Queue Manager. |
| Operating System | The server operating system. Display only. |
| Password | The 1-64-character password (1-8 characters for z/OS) associated with the user ID. This field is required and is case sensitive. For MQ MFT, and Sterling Secure Proxy, this is the password to access the message queue. |
| Phone | Server contact phone number. Optional. Up to
50 characters. Optional contact information for the server. Up to 255 characters. To include a link you can click, use one of the following prefixes, and then type the remaining information: http://
ftp:// mailto:// file:// |
| Port | The port the JMS provider listens on. |
| Process Data XPath | A path used to access information in a process data XML document. Must begin with the prefix, /ProcessData, for example, /Process Data/FTPClientBeginSessionServiceResults/ServerRepose/Text. |
| Processes | The number of executing and nonexecuting processes found for the server. Display only. |
| Product | The IBM product specified in the license key. Display only. |
| Protocol | The web protocol (HTTP or HTTPS) for Sterling B2B Integrator. |
| Protocols to Monitor | Protocols you want to monitor with IBM Sterling Control Center Monitor: AS2, Connect:Direct, FTP, HTTP, MailboxService, MBI, OFTP, SAP, SFTP, SWIFTNet, webDAV, WMQFTE. |
| Queue | ID of the queue to monitor. For Sterling Connect:Direct servers, you can choose to monitor the EXEC, HOLD, TIMER, or WAIT queues. For Sterling B2B Integrator servers, you can choose to monitor Queues 0 through 9. |
| Queue Manager Name | The name of the JMS Queue Manager that holds the messages IBM Sterling Control Center Monitor receives. |
| Reset Watermark | Click to reset the values in Max Concurrent Processes to zero. The watermarks that are reset include the maximum number of concurrent sessions, number of times that this maximum was reached, and last date and time the maximum was reached. |
| Retrieve | Click this button to retrieve a new version of the license for this server. |
| SCI Extensions | Sterling B2B Integrator system-related license and version information. |
| SNMP Listener Address | If your IBM Sterling Control Center Monitor engine has a dual-homed IP stack (for example, multiple adapters), specify the IP address (up to 255 characters) to which to bind. Otherwise, IBM Sterling Control Center Monitor binds to any available address. |
| SNMP Listener Port Number | The port number (1-65535 ) on which IBM Sterling Control Center Monitor is to listen to receive traps from the server. |
| Selected Fields | Fields included in the FTP xferlog or IIS log
file record to be monitored. Important: Some fields listed
in the Selected Fields list are required. You cannot move required
fields to the Available Fields list. They must remain in the Selected
Fields list.
|
| Selected Groups | The server groups to which the server belongs. Move a server out of Selected Groups by selecting it and clicking the Left Arrow button. Optional. |
| Server Address | The API address used to establish a session with the Sterling Connect:Direct, Sterling Connect:Enterprise, Sterling Connect:Express for Microsoft Windows, or Sterling Connect:Express for UNIX server. |
| SERVER_DATA_1 | Server Metadata 1. The server metadata fields are user-definable fields for writing metadata rules and actions, and for reporting purposes Optional. |
| SERVER_DATA_2 | Server Metadata 2. Optional. |
| SERVER_DATA_3 | Server Metadata 3. Optional. |
| SERVER_DATA_4 | Server Metadata 4. Optional. |
| SERVER_DATA_5 | Server Metadata 5. Optional. |
| SERVER_DATA_6 | Server Metadata 6. Optional. |
| SERVER_DATA_7 | Server Metadata 7. Optional. |
| SERVER_DATA_8 | Server Metadata 8. Optional. |
| SERVER_DATA_9 | Server Metadata 9. Optional. |
| SERVER_DATA_10 | Server Metadata 10. Optional. |
| Server is Being Monitored/Server is Paused | Allows authorized user to pause monitoring of the selected server. If the button displays “Pause,” click it to stop monitoring. If the button displays “Resume,” click it to resume monitoring. |
| Server Type | The type of server:
|
| Server Version | The version of the managed server. Display only. |
| Source Port Numbers | The optional port numbers used to traverse a firewall, if the managed server is behind a firewall. Each port number is 1-5 digits. Acceptable formats are nnnnn-nnnnn, or nnnnn, nnnnn, nnnnn-nnnnn. Example entries are 5555-5580, 48888-48890, and 5888, 5900-5920. The IBM Sterling Control Center Monitor engine uses the first available source port specified when connecting to the server. If none is available, a connection cannot be made. If source ports are used, give each server at least two unique ports to choose from. |
| Start Certificate Expiry Notification | Select an option for the number of days before expiry of trusted or key certificates when IBM Sterling Control Center Monitor begins generating events: 1) use the current IBM Sterling Control Center Monitor system setting for the number of days or 2) specify the number of days for this server. Important: This option can be set only
for servers that allow configuration management.
Certificate expiry checking works only for certificates in the IBM Sterling Control Center Monitor object repository. To ensure that your certificates are in the repository, you can manually check and add them using or . Or, you can automatically check for configuration changes on a daily basis by using the Check for configuration changes on servers system setting on the Services tab . When a certificate reaches the point when expiry notifications are to be generated, notifications are generated once a day until the certificates expiration time changes. To act upon certificate expiry events, or notifications, use the Certificate Expiry Warning predefined rule. You can use this rule to define the number of days before expiry that action is taken. To act upon certificate expiry events, or notifications, you can use the Certificate Expiry Warning predefined rule to define the number of days before expiry that action will be taken. |
| Start License Notification | The number of days before a server license expiration date to begin generating license expiration events. The range is 1-30 days. The license status is checked daily at midnight engine time. A license expiration event (event type of Server License, message ID of CCNS004E) is generated if the license expires within the specified number of days. Set this value high enough to allow time to obtain and install a new license key. |
| Subscriber Name | Unique name of the client that receives messages. Subscribers receive
all messages published on a topic. For Sterling Secure Proxy, MQ MFT, this is a user-defined name and must be a
syntactically valid JMS Client ID. Attention: For Sterling Secure Proxy, and MQ MFT users: If more than one client is
subscribing to the same topic on a message queue, they must use unique Subscriber Names to prevent
conflicts.
|
| System Version | The Sterling Connect:Direct, Sterling Connect:Enterprise, Sterling Connect:Express,Sterling B2B Integrator, Sterling Secure Proxy, MQ MFT, or FTP software version. Display only. |
| Time Zone | The time zone where the managed server is located. Use this option when the server’s date and time settings are wrong, or a region's changeover to daylight saving time differs from the national norm. This field also shows the difference between the time zone and Coordinated Universal Time (UTC). |
| Topic Name | Name of the JMS topic to subscribe to where messages are published. For MQ MFT, the value is set as SYSTEM.FTE/# and cannot be changed. |
| Tracing | Enable or disable tracing for this server. Enabling tracing sends additional debug logging to the CCEngine log for the server. Due to the amount of data sent to the engine log, use tracing only when requested by IBM Customer Support. |
| User ID | The user ID used to log on to the server or message provider. |
| Use the Time Zone in the table and ignore server-provided UTC Offset | Select this option when the time zone is not provided by the server, or when it is incorrect. |
| UTC Offset | Difference between Time Zone and Coordinated Universal Time (UTC). Display only. |
| (Value) | The data values for Sterling B2B Integrator environment variables. |
| View License Key | Click this button to view the raw Sterling B2B Integrator license key data. Display only. |
| Web Service Address | Address of the Sterling B2B Integrator web
service. Restriction: IBM Sterling Control Center
Monitor cannot
monitor Sterling B2B Integrator servers
using IPv6. You must specify an IPv4 address or a DNS name for the
connection.
|
| Web Service Port | The port for the Sterling B2B Integrator web service. |
| Welcome Message | An informational message set by the FTP administrator for users of an FTP server. The message might contain directory information, usage guidelines, unauthorized access warnings, server news, or other information. |