Common

Login

You can log into the management console in the following ways:

• In the Flow Designer's tree pane, right-click a server and click Open FSMC.
• On Windows, you can use the Start menu.
• In a web browser, type the following URL: http://[server address of Flow Service]:28080/

Be sure to specify the full username, including the domain, if your user is not in the root domain. For example, "/testdomain/testuser". If you do not specify the domain, the user will be authenticated against the root domain.

Users and Roles

See the following sections to create a user and assign a role - administrator, developer, or operator.

• Creating a User
• Using the Flow Service Roles
• Accessing the Management Console

See Also

• See Tools > Account to configure user account settings, such as access to a VCS and FTP.

Creating a User

1. Go to the Tools > Account page.

2. Select a domain or click Create Subdomain.

   

3. Click Create User. Enter the username and password and select the role.

   

Back to Users and Roles.

Using the Flow Service Roles

A user's role defines the user's permissions to design and execute flows. The role also restricts access to the management console - see Accessing the Management Console, below.

The following roles are available.

• Administrator: Manages a subdomain. Grants read/write access to all user accounts in a domain.

  Note that only the root domain's administrator has write access to the whole system.

• Developer: Develops and executes flows. Grants read/write access to a user account on the domain.

• Operator: Checks flow execution status. Grants read-only access to a user account on the domain.

Back to Users and Roles.

Accessing the Management Console

A user's role determines a user's access level to the management console, as shown in the following table.

• ◯：Available
• △：Partially available.
• ×：Not available.
• *1：Only the users under the root domain can access this.
• *2：Only the administrator under the root domain can edit this.
• *3：Only the administrator under the root domain can edit the system log settings and deletion settings.

Back to Users and Roles.

Status

On the Status pages, you can monitor server-side services, flow execution, and version control status.

Log	Access the system logs or user-defined application logs. System Access logs for services running on the server, including flow execution logs. Application Access application logs, logging configurations that give you more control over flow execution logs.
Flow	View the status of a flow or execute a flow. Request List View or delete the running flow requests. Status List View checkpoint data, re-execute a request, or delete a request that isn't running. Statistics View checkpoint statistics. Or, download the data as CSV files. Context List Monitor the current user context. Server List View or delete servers - or disable monitoring. Graph View graphs of Flow Engine metrics. Flow List View flows or execute a flow.
Version Control	Check the current version control status and version history or update to any version.

Log

System

On the Status > Log > System page, you can do the following:

• Troubleshoot the server, Flow Service, or flow execution.
• Access the system logs.
• Search the system logs.
• Change the verbosity.
• Change the display options.

See Also:

• See Settings > Log > System to change the system logging settings.
• See Settings > Log > Application to create an application log. Application logs give you more options to access flow execution logs and component logs, in addition to the system logs.
• See Settings > Services > Flow to troubleshoot at the level of HTTP and SSL. You can configure the server's listener processes to create HTTP and SSL dump logs.

Troubleshoot the Server, Flow Service, or Flow Execution

Use the system logs to get information about the processes that make up the Flow Service. This information includes logs of flow execution, HTTP-and-FTP level access to the Flow Service, and logs for the server itself.

See the table in the following section for the available logs.

Access the System Logs

You can access the system logs in the following ways:

• In the FSMC: Select one of the server-side services in the Log File menu and select the log verbosity in the Level menu.

• In a ZIP: Click Download on Status > Log > System, select a service in the Log File menu, and select the day in the Date menu.

• On the server: Below is the default path to the log files, the log subfolder under the data directory. Note that you can change the default path in Settings > Logs > System.

  Windows	C:\asteriahome5[c,cp]\log
  UNIX	/[Installation user's home directory]/asteriahome5[c,cp]/log

The following table describes the available logs for each process:

Back to Status > Log > System.

Search the System Logs

In the Search Options section, you can

• Search the logs for the service you select in the Log File menu.
• Filter by date in the Date and Time menu.
• Add other filters. You can enter keywords into the Keyword box and use the following operators to create search conditions: Select OR to match one or more keywords. Select AND to match all keywords. Click Clear to clear the keywords. Note that the search is not case sensitive.

Back to Status > Log > System.

Change the Verbosity

Select the verbosity level to display in the Level menu: Fatal Error, Error, Warning, Information, or Debug. The default verbosity is Information, one step less verbose than debug.

The verbosity level you select specifies the maximum verbosity that will be displayed. For example, if you select Debug, debug-level logs are displayed in addition to less verbose logs at the fatal error, error, warning, and information levels.

Back to Status > Log > System.

Change the Display Options

In the Display Options section, you can configure the ordering of results, results per page, and font.

The newest logs are shown first by default. Clear the Reverse check box to show the oldest logs first.

Back to Status > Log > System.

Application

On the Status > Log > Application page, you can do the following:

• Troubleshoot flow execution and components.
• Access application logs.
• Change the verbosity.
• Search the application logs.
• Change the display options.

See Also

• See Settings > Log > Application to create and configure application logs.
• See Status > Log > System for other logs.

Troubleshoot Flow Execution

Application logs capture logs from flow execution and components. You can also access this information with the Flow Service system log; application logs provide a way to filter the output into separate files.

• Using the Flow Service log: On the Status > Log > System page, select the Log File and Level.
• Using application logs: See Settings > Log > Application for a configuration guide.

Back to Status > Log > Application.

Access Application Logs

You can access application logs in the following ways:

• In the FSMC: Select the application log in the Log Name menu and the verbosity to display in the Level menu. See the following sections to configure display and search options.

• In a ZIP: Click Download on Status > Log > Application. Select the application log in the Log Name menu. Select a log file in the Log File menu.

• On the server: Below is the default location of the log files, under the logs/application subfolder of the data directory:

  Windows	C:\asteriahome5[c,cp]\log
  UNIX	/[Installation user's home directory]/asteriahome5[c,cp]/log/application/[log setting name].log

Back to Status > Log > Application.

Change the Verbosity

In the Level menu, select the verbosity level to display: Fatal Error, Error, Warning, Information, or Debug.

The verbosity level you select specifies the maximum verbosity that will be output. For example, if you select Debug, debug-level logs are output in addition to less verbose logs at the fatal error, error, warning, and information levels.

The default verbosity is the information level.

Back to Status > Log > Application.

Search the Application Logs

In the Search Options section, you can filter the log you select in the Log Name menu:

1. In the Log File menu, select one of the logs generated by your application log configuration.
2. Enter search terms in the Keyword box.
3. Use the following options to build search conditions based on the search terms:
   • Select OR to match one or more keywords.
   • Select AND to match all keywords.
   • Click Clear to clear all search options.

Note that the search is not case sensitive.

Back to Status > Log > Application.

Change the Display Options

In the Display Options section, you can configure the ordering of results, results per page, and font.

The newest logs are shown first by default. Clear the Reverse check box to show the oldest logs first.

Back to Status > Log > Application.

Flow

Request List

On the Status > Flow > Request List page, you can do the following:

• Get the current requests.
• Cancel a request.

See Also

• See Status > Flow > Status List to re-execute requests or delete requests that aren't running.
• See Settings > Services > Flow page to configure the Flow Engine process. You can use these settings to troubleshoot or optimize request processing.
• See Status > Flow > Graph to graph performance metrics for requests.

Get the Current Requests

This page lists the following information about the current requests:

Click the Detail button on the action bar to get additional information for a request running currently:

• The project
• The project owner
• The component
• The mapper status in an execution request

Back to Status > Flow > Request List.

Cancel a Request

You can cancel a request that is in the queue or running. Note that components can have different behaviors when they are stopped while running; see below.

Terminating Running Components

When you cancel a running request, the component currently being executed will either

• finish processing the current component, then abort the flow; or,
• terminate the processing of the running component and abort the flow

When you cancel a request, the following components will terminate immediately:

• RDBGet/RDBPut/FastInsert/RDBMerge/SQLCall
• HTTPGet/HTTPPost/REST
• FTPGet/FTPPut/FTPScript
• Sleep
• Mutex
• EXE
• ParallelSubFlow

For more information on how a component terminates, refer to the help for the component.

Back to Status > Flow > Request List.

Status List

On the Status > Flow > Status List page, you can do the following:

• Get checkpoint data.
• Search checkpoint data.
• Re-execute a request.
• Delete a request.

Note that you need to have configured checkpoints to use this page (see below for a guide).

See Also

• See Status > Flow > Request List to view the current requests or delete a request that's running.
• See Settings > Service > Flow > Checkpoint to configure an RDB connection and enable checkpoints.
• See Status > Flow > Statistics to create summary charts of checkpoint data or download a CSV.
• See Settings > Log > Purge to automatically purge checkpoint data.

Get Checkpoint Data

On this page you can view the available checkpoint data:

Select the request and click Detail to get the additional details below:

Back to Status > Flow > Status List.

Search Checkpoint Data

You can specify the following search criteria:

Back to Status > Flow > Status List.

Re-execute a Request

Click Rerun to re-execute a request from the last checkpoint passed.

Back to Status > Flow > Status List.

Delete a Request

Select a request and click Delete. Note that you can't delete requests that are running or queued here - you can do so from the Request List page.

Back to Status > Flow > Status List.

Statistics

On the Status > Flow > Statistics page, you can create summary charts for checkpoint data:

• Query checkpoint statistics
• Graph checkpoint statistics
• Download CSV

Note that you need to have configured the checkpoint functionality to use this page (see below for a guide).

See Also

• See Settings > Service > Flow > Checkpoint to configure the RDB connection for the checkpoint functionality.
• See Status > Flow > Status List to view status details and search checkpoint status information.
• See Settings > Log > Purge to automatically purge old checkpoint data.

Query Checkpoint Statistics

You can use the following options to specify search conditions:

Back to Status > Flow > Statistics.

Graph Checkpoint Statistics

The charts on the Statistics page show the following summaries. See below to configure the chart:

• Group the data.
• Change the chart type.

Back to Status > Flow > Statistics.

Group the Data

Select how to aggregate the data in the Group By menus:

Back to Status > Flow > Statistics.

Change the Chart Type

Select the chart type in the Graph menu:

Back to Status > Flow > Statistics.

Download CSV

Click the Download CSV button to download a CSV file of the results of the query you defined on the Statistics page.

Back to Status > Flow > Statistics.

Context List

On the Status > Flow > Context List page, you can get user context details.

See Also

• See Tools > Account to configure the user context.
• See Settings > Connection > URL to create a URL trigger based on the user context.

Get User Context Details

Back to Context List.

Server List

On the Status > Flow > Server List page, you can access information on the servers in the same cluster as the server that the management console is running on.

• Access server status information.
• Delete a server or disable monitoring.

Access Server Status Information

See below for details and notes on the server information:

Back to Status > Flow > Server List.

Delete a Server

You can delete a server completely or only disable monitoring. Click Delete and select one of these options in the resulting dialog.

If you select the option to delete the server completely, the server will be deleted from the server list as well. If you disable the server, the server will be displayed in the list with a "deleted" status.

Back to Status > Flow > Server List.

Graph

On the Status > Flow > Graph page, you can do the following:

• Monitor Flow Engine performance
• Filter Flow Engine metrics

See Also

• See the Settings > Services > Flow > Flow Engine page to change Flow Engine service settings, such as the request queue size and max thread counts. On the Flow page you can also change the settings for other services such as the HTTP listener.

Monitor Flow Engine Performance

Monitor resource use and processing times with the following charts:

Managing dead threads

After the request finishes, a thread with a dead status is discarded. If a request doesn't finish, the dead thread decreases the number of active threads in the pool. For example, if there's one dead thread, there can be 31 active threads in the pool, by default.

Take care that the dead thread count doesn't reach the max thread count -- in this scenario, the Flow Service seems to have stopped.

Back to Status > Flow > Graph.

Filter Flow Engine Metrics

You can use the following parameters to build search criteria:

• Process: Filter by the process's execution mode: normal, high priority, or parallel.

• Range: Filter by time range.

• Time: Set the end time. By default, data is displayed up to the current time.

• Calc Unit: Specify a time unit for the processing count graph.

Back to Status > Flow > Graph.

Flow List

On the Status > Flow > Flow List page, you can do the following:

• Access flow information.
• Execute a flow.

Access Flow Information

This page lists the following information. Note that this page only lists flows that are owned by the user logged into the Flow Service Management Console.

Back to Status > Flow > Flow List.

Execute a Flow

Back to Status > Flow > Flow List.

Version Control

On the Status > Version Control pages, you can interact with projects, flows, and other files checked into a Subversion repository.

• Current Status: Check the version control status and update to the latest changes.
• History: View the version history and revert to a revision.

See Also

• See Tools > Account to configure version control for a user account. An administrator account is required.

Current Status

On the Status > Current Status page, you can do the following:

• Check the current status of the user's home folder.
• Update to the latest revision.

Back to Status > Version Control.

Check the Current Status

The following fields show the version control status of each file.

Select a file and click Detail to display the following additional details about the version control status:

Back to Current Status. Back to Status > Version Control.

Update to the Latest Revision

Click Update on the action bar to apply the latest changes from the server to the home folder.

Back to Current Status. Back to Status > Version Control.

History

On the Status > Version Control > History page, you can do the following:

• View the version history.
• Revert to a revision.

See Status > Version Control for other how-tos on using version control in the FSMC.

View the Revision History

This page displays the following fields:

Back to History. Back to Status > Version Control.

Revert to a Revision

A revert operation synchronizes your local copy with a revision. To revert, select a revision and click Revert to Revision.

Back to History. Back to Status > Version Control.

Settings

On the following pages, you can configure server settings and data stored on the server - such as data source connection strings, passwords, digital certificates, and logs.

Connection	Manage data source connections. See below for connection guides for each data source. See the intro Connection section for more information on the system and user connection types and CRUD permissions for connections. RDB Connect to a relational database. HTTP Connect to an HTTP server. FTP Connect to an FTP server. SMTP Connect to an SMTP server. POP3 Connect to a POP3 server. IMAP4 Connect to an IMAP4 server. Queue Connect to a JMS server. JNDI Connect with the Queue, Active Directory, or LDAP components. Notes Connect to a Domino server. Common Connect to custom components you created using the SDK.
Trigger	Manage triggers, which are used to execute flows on the following events. URL Trigger a flow with a URL request. Schedule Trigger a flow on a schedule. SOAP Trigger a flow with a SOAP request. FTP Trigger a flow with an FTP request. Mail Monitor Trigger a flow with an email. Message Queue Monitor Trigger a flow with JMS.
Proxy	Configure an HTTP(S) proxy server.
SSL	Configure the certificates used by TLS/SSL connections. Server certificate The certificate that the Flow Service provides as the server in SSL communication. Client certificate The certificate that the Flow Service provides as the client in the SSL client authentication protocol. Server certificate authority The CA cert. that vouches for the server when the Flow Service connects as the client in SSL communication. Client certificate authority The CA cert. used to authenticate clients that connect to the Flow Service using the SSL client authentication protocol.
Log	Configure log settings at the Flow Service or flow levels. System Server logs and logs for other system processes running on the server. Application Component logs and flow execution logs. Purge Purge server logs manually or schedule purges.
Notification	Configure email notifications for server events.
Services	Configure the services running on the server. Flow Flow Service processes. FTP The FTP service built into the Flow Service. MC The management console.
Password	Change the password for the currently authenticated user.

Connection

General Settings

• Creating System or User Connections
• CRUD Permissions for Connections

Creating System or User Connections

Create a system connection () to allow system-wide access. Create a user connection () to restrict access to a single user. The user's role further restricts the user's permissions to create, read, update, and delete connections:

• Administrators have CRUD access to system connections. Administrators also have CRUD access to the connections owned by users who are in the administrator's domain.
• Developers have read access to system connections and CRUD access to the connections that they own.
• Operators have read access to system connections and the connections that they own.

CRUD Permissions for Connections

The following table shows CRUD permissions by role:

Back to Settings > Connection.

RDB Connections

• Deploying a Third-Party JDBC Driver
• Creating an RDB Connection
• Testing RDB Connections

Deploying a Third-Party JDBC Driver

If ASTERIA Warp does not include a driver for your database, follow the steps below to deploy a third-party JDBC driver:

1. Download the driver from the vendor.
2. Copy the JDBC driver into [DATA_DIR]/system/lib/drivers. Below are the default data folders:

   Windows	C:\asteriahome5[c,cp]
   UNIX	/[installation user's home folder]/asteriahome5[c,cp]

3. Restart the Flow Service.

Creating an RDB Connection

See below for details on the RDB connection settings.

Back to RDB Connections.

Testing RDB Connections

A connection test displays the following information:

Back to RDB Connections.

HTTP Connections

• Creating and Editing HTTP Connections

Creating and Editing HTTP Connections

See below for details on the HTTP connection settings.

Back to HTTP Connections.

FTP Connections

• Creating and Editing FTP Connections

Creating and Editing FTP Connections

See below for details on the FTP connection settings.

{.screenshot .size_auto}

Back to FTP Connections.

SMTP Connections

• Creating and Editing SMTP Connections

Creating and Editing SMTP Connections

See the sections below for details on the SMTP connection settings:

• Basic Settings
• Options for POP-before-SMTP Authentication
• Options for SMTP Authentication

Basic Settings

Back to SMTP Connections.

Options for POP-before-SMTP Authentication

Select the POP before SMTP option in the Authentication menu to enable the following options.

POP3 Server Name [pophost]	Enter the host name of the POP3 server.
Use POP over SSL[popProtocol]	Select whether to use POP with TLS/SSL encryption. The default is OFF. ON [pops]: Connect with POP over TLS/SSL. OFF [pop3]: Connect without encryption.
Use STARTTLS [popSslType]	Select whether to use the STARTTLS command to connect with POP over TLS/SSL. The default is OFF. ON [starttls]: Use the STARTTLS command. OFF [default]: Don't use the STARTTLS command.
POP3 Port [popport]	Enter the port number of the POP3 server. The default is 110. If you connect with POP over TLS/SSL, you need to specify a dedicated port number. The well-known port is 995. Specify the port number you are using in actual operation.
Username [user]	Enter the username to authenticate with.
Password	Enter the password of the user.
APOP [apop]	Select whether to use APOP or not for the POP3 server authentication. The default is ON. ON [true]: Use APOP. OFF [false]: Don't use APOP.
Interval (msec)	Enter the time from the beginning of authentication on the POP3 server until the SMTP server is available in milliseconds. The default is 5.

Back to SMTP Connections.

Options for SMTP Authentication

Select the SMTP Authentication option in the Authentication menu to enable the following options:

Back to SMTP Connections.

POP3 Connections

• Creating and Editing POP3 Connections

Creating and Editing POP3 Connections

See below for details on the POP3 connection settings.

Back to POP3 Connections.

IMAP4 Connections

• Creating and Editing IMAP4 Connections

Creating and Editing IMAP4 Connections

See below for details on the IMAP connection settings.

Back to IMAP4 Connections.

Queue Connections

• Creating and Editing Queue Connections

Creating and Editing Queue Connections

See below for details on the Queue connection settings. To configure a Queue connection, you need to first create a JNDI connection to a JMS server.

Back to Queue Connections.

JNDI Connections

• Creating and Editing JNDI Connections

Creating and Editing JNDI Connections

JNDI connections can be used to connect to LDAP and Active Directory, and you also use a JNDI connection in the Queue component. More information on the JNDI connection parameters is below.

Back to JNDI Connections.

Notes Connection

To connect to a Lotus Domino server using a Notes ID, see the configuration guides below:

• Setting Up the Notes Client
• Creating and Editing Notes Connections

Setting Up the Notes Client

1. Install the Notes client to the machine where the Flow Service is running
2. Include the path to the Notes client's execution folder in the PATH environment variable.

Back to Notes Connection.

Creating and Editing Notes Connections

You can configure the following parameters for Notes connections.

Back to Notes Connection.

Common Connections

• Creating and Editing Common Connections

Creating and Editing Common Connections

You can use Common connections to connect to external systems, using the components provided by third-party adapters. The following table details the available settings:

Back to Common Connections.

Trigger

Triggers and Roles

On the Settings > Trigger pages, you can manage and execute triggers. Your user role determines the actions you can perform:

• Administrators and operators can see the triggers owned by the users that belong to the same domain. Developer users can see only the triggers that they own.

• Administrators and developers can create, update, and delete their own triggers, but operators have read-only access.

• The "asu" user of the root domain can create, edit, and delete triggers only for other users.

Below is the complete set of permissions:

• ◯：allowed
• ×：not allowed
• R: read
• W: write
• X: execute
• E/D: enable/disable
• /asu: admin of the root domain
• asu: domain admin
• dev: developer user
• op: operator user

URL

On the Settings > Trigger > URL page, you can manage URL triggers. URL triggers execute a flow when an HTTP or HTTPS request is received.

• View URL Trigger Details
• Create or Edit a URL Trigger

See Triggers and Roles for each role's permissions to view, use, and modify triggers.

View URL Trigger Details

The URL page lists the following information. Click Detail for additional information such as the execution count.

Back to URL triggers.

Create or Edit a URL Trigger

Below are details on the trigger settings, as shown in the dialog to create a trigger:

Back to URL triggers.

Schedule

On the Settings > Trigger > Schedule page, you can manage triggers that execute a flow on a date, time, or interval.

• View Schedule Trigger Details
• Create or Edit a Schedule Trigger

See Triggers and Roles for each role's permissions to view, use, and modify triggers.

View Schedule Trigger Details

The Schedule page lists the following information. Click Detail for additional information such as the execution count.

Back to Schedule triggers.

Create or Edit a Schedule Trigger

Below are details on the trigger settings, as shown in the dialog to create a trigger:

Back to Schedule triggers.

SOAP

On the Settings > Trigger > SOAP pages, you can manage SOAP triggers. SOAP triggers execute a flow when a SOAP request is received.

• View SOAP Trigger Details
• Create and Edit SOAP Triggers

See Triggers and Roles for each role's permissions to view, use, and modify triggers.

View SOAP Trigger Details

The SOAP page lists the following information. Click Detail for additional information such as the execution count.

Back to SOAP triggers.

Create and Edit SOAP Triggers

Below are details on the trigger settings, as shown in the dialog to create a trigger:

Back to SOAP triggers.

FTP

On the Settings > Trigger > FTP page, you can manage FTP triggers. FTP triggers execute flows when a file is uploaded to the Flow Service's FTP server.

• View FTP Trigger Details
• Create and Edit FTP Triggers

Setup

• Start the FTP service on the Tools > Services page. Select the Automatic Start option to start the service when the server starts.
• Allow Flow Service users FTP access, click Tools > Account, select the user, and click Edit in the FTP section. Enable the FTP User option and the option to allow uploads.

See Also

• See Triggers and Roles for each role's permissions to view, use, and modify triggers.
• See Settings > Services > Flow > FTP to configure anonymous login, the port, max connections, and other settings for the FTP service.

View FTP Trigger Details

The FTP page lists the following information. Click Detail for additional information such as the execution count.

Back to FTP triggers.

Create and Edit FTP Triggers

Below are details on the trigger settings, as shown in the dialog to create a trigger:

Changing the virtual root folder

The upload folder is a subfolder under the FTP service's virtual folder. You can change the virtual root folder on the Settings > Services > FTP page in the management console. You need to specify a path that exists.

Back to FTP triggers.

Mail Monitor

On the Settings > Trigger > Mail page, you can manage mail monitor triggers. Mail monitor triggers monitor a POP mailbox and execute a flow when an email is received.

• View Mail Monitor Trigger Details
• Create and Edit Mail Monitor Triggers

See Triggers and Roles for each role's permissions to view, use, and modify triggers.

View Mail Monitor Trigger Details

The Mail page lists the following information. Click Detail for additional information such as the execution count.

Back to Mail Monitor triggers.

Create and Edit Mail Monitor Triggers

Below are details on the trigger settings, as shown in the dialog to create a trigger:

Back to Mail Monitor triggers.

Message Queue

On the Settings > Trigger > Message Queue page, you can manage message queue triggers. Message queue monitor triggers monitor a JMS (Java message service) queue and run flows to process new messages.

• View Message Queue Trigger Details
• Create and Edit Message Queue Triggers

See Triggers and Roles for general information on trigger permissions.

View Message Queue Trigger Details

The Message Queue page lists the following information. Click Detail for additional information such as the execution count.

Back to Message Queue triggers.

Create and Edit Message Queue Trigger Settings

Below are details on the trigger settings, as shown in the dialog to create a trigger:

Back to Message Queue triggers.

Proxy

On the Settings > Proxy page, you can configure a proxy server to forward HTTP or HTTPS requests sent from the Flow Service.

• Configuring the Proxy Server
• Configuring Authentication

See Also

• See Settings > Connection > HTTP to configure HTTP connections to use the system proxy

Configuring the Proxy Server

In the Proxy Server section, click Edit and enter the address and port for HTTP and HTTPS.

Back to Settings > Proxy.

Configuring Authentication

If user authentication is to be performed on the proxy server side, click Edit in the Connection Information section and provide the following credentials:

SSL

Configuring Certificates in the Flow Service

The Flow Service can use the following certificates to act as the client or the server in TLS/SSL.

• Server Certificate: Configure the certificate for establishing a connection as a server.
• Client Certificate: Configure the certificate for establishing a connection as a client.
• Server Certificate Authority: Configure the CA cert for a server that the Flow Service is connecting to.
• Client Certificate Authority: Configure the CA cert for a client authenticating to the Flow Service.

See below for configuration guides:

• Server & client certificates
• Server & client CA certificates

See Also

• See Tools > Account to configure certificates for non-SSL flows or to configure a user's SSL certificates.

Server & Client Certificates

On the Server Certificate and Client Certificate pages, you can configure the certificate the Flow Service uses to establish an SSL connection as the server or client. You need to restart the Flow Service to load changes to the certificates.

• Create a Certificate
• Import a Certificate
• Delete a Certificate
• Export a Certificate
• Export a CSR

See Also

• See Configuring Certificates in the Flow Service for other SSL configuration guides.
• See Settings > Services > Flow > HTTP(S) Communication to enable TLS/SSL connections from clients to the Flow Service.
• See Tools > Account to configure other certificates for components like HttpGet, HttpPost, REST, SMIMEEncrypt, SMIMEDecrypt, and SMIMESign.

Create a Certificate

Click Create to create a private key and a certificate.

Back to Server & Client Certificates.

Import a Certificate

You can click Import to import a private key and a certificate chain (PKCS#12 or JavaKeyStore). To import only a certificate chain (X.509, PKCS#7, PEM, or DER), click Import Certificate. A private key must already exist, and the certificate chain must correspond to this private key.

When you click Import, enter the following in the dialog that is displayed:

When you click Import Certificate, enter the following in the dialog that is displayed:

Back to Server & Client Certificates.

Delete a Certificate

Back to Server & Client Certificates.

Export a Certificate

Back to Server & Client Certificates.

Export the CSR

Back to Server & Client Certificates.

Server & Client CA Certs

On the Client Certificate Authority and Server Certificate Authority pages, you can add, delete, and get details on the trusted CA certificates. See Configuring Certificates in the Flow Service for more information on how the CA certificates are used.

You need to restart the Flow Service to load changes to the certificate.

See Also

• See Configuring Certificates in the Flow Service for other SSL configuration guides.
• See Settings > Services > Flow > HTTPS Listener to enable TLS/SSL connections from clients to the Flow Service.

Log

System

On the Settings > Log > System page, you can configure the following settings for the system logs.

• Configure the output level.
• Configure the output path.

System logs are created by the server-side processes that make up the Flow Service. You can use system logs to troubleshoot the server, flow execution, and other aspects of the Flow Service, such as the HTTP and FTP listeners.

See Also

• See Settings > Log > Application to manage application-log configurations, which give you additional options for accessing flow execution and component logs.
• See Settings > Log > Purge to configure automatic purges for logs and checkpoint data.
• See Settings > Services > Flow to configure the server-side services. Here you can configure HTTP dump logs to get additional troubleshooting information.
• See Status > Log > System to view, search, and download the system logs.

Configure the Output Level

In the Output Level section, you can specify the verbosity of the log files for the following Flow Service processes.

• Asteria: All server processes except the Flow Service
• Flow Service: Logs for the startup and execution of the Flow Service
• MCAPI: Logs for the management console API

Note that the output level specifies the maximum verbosity. For example, if the debug level is specified, then less verbose information at the fatal error, error, warning, and information levels will also be output.

Back to Settings > Log > System.

Configure the Output Path

Follow the steps below to change the folder that the system logs are output to.

1. In the Output Path section, click Edit.
2. In the Path box, set the path of the folder to output the log files. This value must be an absolute path.
3. Restart the Flow Service.

The default path, shown in the table below, is the log subfolder under the data directory.

Back to Settings > Log > System.

Application

On the Settings > Log > Application page, you can manage application logs. See the following sections to create an application log and then configure components and flows to write to the application log.

• How to Use Application Logs
• Create and Configure Application Logs
• Register Application Logs in the Flow Designer

See Also

• See Settings > Log > Purge to configure maintenance for logs and checkpoint data.
• See Status > Log > Application to access application-level logs in the FSMC.
• See Status > Log > System to access logs for server-side services.

How to Use Application Logs

You can use application logs to gain more control over flow execution logs and component logs. You can also get flow execution information from the Flow Service system log; you can redirect the information you need to separate application-log files.

Back to Settings > Log > Application.

Application Log Contents

Flow execution logs

Flow execution logs include the flow start, flow end, and any errors.

Component logs

You can configure individual components to write to an application log: right-click the component and click Log Settings.

Back to Settings > Log > Application.

Create and Configure Application Logs

• Create an Application Log
• Configure Log Rollover
• Configure the Verbosity
• Configure a Subcategory
• Example: Capture Only Debug-Level Logs

Back to Settings > Log > Application.

Create an Application Log

Click New or Edit on the Settings > Log > Application page, enter a log name, and configure the application log's settings:

• Enter a Log Name.
• Select a Rollover option.
• Select the Log Level.
• Optionally, define a Subcategory.

Rollover

Use the following options to split the generated log files:

• By date: To create new log files, the date, month, and year are added to the file name in the format of "filename.yyyy-mm-dd".

  You can use this option to quickly find a log file for a given date, but you also need to configure a retention period on the Settings > Log > Purge page.

• By size: This splits log files by size. When a log file reaches the specified size, a generation number is added to the name of the new file in the format "filename.<number>". The smaller the generation number is, the newer the log file is.

  You can use this option to skip configuring a log purge schedule on the Settings > Log > Purge page. Instead, you specify the number of generations of log files to keep. But, you need to open the log file to find the log for a given date.

File Size

When you select the by size rollover option, enter the specified size at which to roll over a log file.

Generation

When you select the by size rollover option, enter the number of generations you want to save. For example, if you set Generation to 5, the files whose generation number is less than or equal to 5 will be saved. Note that the file currently being output does not have a generation number.

Log Level

Specify the verbosity level to capture in the application log. The application will capture logs at the specified level and at less verbose levels. You can configure subcategories to capture other log levels.

Subcategory

Define a subcategory to capture multiple verbosity levels across components. You can specify the Subcategory option in the component's logging settings.

• To create a subcategory, enter a Category Name and select a Log Level, then click Add.

• To delete a subcategory, select a subcategory you want to delete from the list, then click Delete.

• To update a subcategory, select the subcategory in the list, select the new Log Level or enter the new Category Name, then click Update.

Filtering Logs

You don't need to change individual components' logging settings in the flow when you're troubleshooting an error in the management console or Log Viewer. Instead, in the management console, you can use an application log's Log Level setting like a filter, raising or lowering the log level to include or exclude component logs. Subcategories allow multiple filters.

Example: Capturing Debug Logs with a Subcategory

You can create a subcategory to output debug logs from a component only when you need to troubleshoot. If you set the subcategory's log level to Information and the component's log level to Debug, a log won't be output during flow execution. To output the debug log, set the log level in the subcategory to Debug.

Note that subcategories are registered as log settings; you also need to register components to use the subcategory (see below).

Back to Create and Configure Application Logs. Back to Settings > Log > Application.

Register Application Logs in the Flow Designer

You can register application logs in the logging settings for a project, flow, or component to capture output at the project, flow, and component levels.

• Project Level
• Flow Level
• Component Level
• Notes

Back to Settings > Log > Application.

Project Level

Follow the steps below to configure a default application log for the flows in a project:

1. Double-click the project to open it.
2. In the Application Log Settings section of the project properties, select one of the following in Log Name.

   None	Select this to write to the system log, FlowService.log, and not an application log. This is the default setting.
   Inherit Parent Flow Settings	Select this to specify that subflows and error-processing flows inherit the application log that the parent flow defines. Main flows write to the system log -- the same as the "None" setting -- since there isn't a parent flow.
   The name of an application log	Select an application log.

3. Select the Log Level to capture logs at this level and lower levels.
4. To output logs to the application and log and to the system log, select the Output to System Log option.

Back to Register Application Logs. Back to Settings > Log > Application.

Flow Level

Follow the steps below to configure an individual flow to write to an application log:

1. Open your project and select the flow.
2. In the Application Log Settings section of the flow properties, select one of the following to specify where to write flow execution logs and component logs. By default, flows inherit the project's logging settings or write to the system log.

   None	Select None to write to the log that the project specifies. This is the default.
   Inherit Parent Flow Settings	Enable this to specify that subflows and error-processing flows inherit the application log that the parent flow specifies. If the parent flow doesn't specify an application log, the child flow writes to the log that the project specifies -- the same as selecting the None option.
   The name of an application log	Select an application log. You can define application logs on the Settings > Log > Application page in the management console. Reconnect to refresh the menu.

3. Select the Log Level. This specifies the maximum verbosity. (Output at lower verbosities is also included.)
4. To output logs at the same time to the system log, enable the Output to System Log option.

Back to Register Application Logs. Back to Settings > Log > Application.

Component Level

You can configure individual components to write a custom log message to an application log or the system log:

1. In the worksapce, right-click a component and select Log Setting.
2. Select or clear the Output On/Off option to enable or disable log output for the component. Clear this option to pause log output for the component, but retain the logging settings.
3. In the Log Setting Name menu, select one of the following:

   Application log name	Select an application log you defined in the management console.
   None	Select this to write to the FlowService.log system log. This is the default.
   Inherit Parent Flow Settings	Select Inherit Parent Flow Settings to output the component's logs to a default log you specify in the flow's properties.

4. Select a Subcategory, if defined.
5. Select the Log Level. This specifies the maximum verbosity. (Output at lower verbosities is also included.)
6. Specify the log content in the Output Message box: You can drag and drop the available properties from the Property Formula menu. You can also use autocomplete while you type. See the Flow Designer user's guide, under "Components" > "Component Properties" > "Property Expressions" for the expression syntax.

Notes

Note that a flow writes to the system log, FlowService.log, in the following scenarios:

• If the main flow's Log Name property is also Inherit Parent Flow Settings, then the main flow writes to the system log.
• When you set a flow's Log Name to "Inherit Parent Flow Settings" and invoke the flow with a timer component, like TimerRequest, a FlowInvoker component, or a ParallelSubFlow component, the flow also writes to the system log.

Also, if a flow's logging settings differ from the logging settings for the project that contains the flow, the flow execution logs will simultaneously output logs using the log settings of the project and flow.

Back to Register Application Logs. Back to Settings > Log > Application.

Purge

On the Settings > Log > Purge page, you can purge system and application logs manually or automatically

See Also

• See Status > Log > System to view and download system-level logs.
• See Status > Log > Application to view and download application-level logs.

Purge Logs Manually

In the Purge section, click the Purge button to delete old log files and checkpoint data from the Flow Service's log folder. Note that the current log file (a log file with no date or generation number) is not deleted.

Purge Logs Automatically

In the Automatic Maintenance section, you can configure a schedule to automatically delete old log files and checkpoint history. Click Edit and select one of the following options in the resulting dialog:

• None: Select this option to disable automatic purges.

• Daily: Select this option to check at the same time every day for old logs and checkpoint data that should be deleted.

  Log Retention Period	Enter the number of days to keep the log files.
  Schedule for Checkpoints	Select whether to additionally delete checkpoint data.
  CheckPoint Data Retention Period	Enter the number of days to keep checkpoint data.
  Execute Time	Select the time to perform the log purge.

  

• On scheduled days: Select this option to check weekly for old logs and checkpoints that should be deleted.

  Log Retention Period	Enter the number of days to keep the log files.
  Schedule for Checkpoints	Select whether to additionally delete checkpoint data.
  CheckPoint Data Retention Period	Enter the number of days to keep checkpoint data.
  Execute Time	Enter the time to perform the log purge.
  Purge Days	Select the days of the week to perform the log purge.

  

• On scheduled dates: Select this option to check monthly for old logs and checkpoints that should be deleted:

  Log Retention Period	Enter the number of days to keep the log files.
  Schedule for Checkpoints	Select whether to additionally delete checkpoint data.
  CheckPoint Data Retention Period	Enter the number of days to keep checkpoint data.
  Execute Time	Select the hours and minutes to perform the purge.
  Purge Days	Select the days to perform the purge.

  

Back to Settings > Log > Purge.

Notification

On the Settings > Notification page, you can configure email notifications for server events.

• Configure Email Notifications
• Using Email Notification Templates

Note that if an exception is thrown when the flow ends, a notification will not be sent - use the Exception Processing Flow to deal with exceptions in this case.

Configure Email Notifications

Click Edit to configure the server, recipients, and other message settings. See the sections below for details on each setting.

• Basic Email Settings
• POP-before-SMTP Authentication
• SMTP Authentication

Back to Settings > Notification.

Basic Email Settings

Back to Configure Email Notifications. Back to Settings > Notification.

POP-before-SMTP Authentication

Back to Configure Email Notifications. Back to Settings > Notification.

SMTP Authentication

Select the SMTP Authentication option in the Authentication menu to enable the following options:

Back to Configure Email Notifications. Back to Settings > Notification.

Using Email Notification Templates

The content of an email notification is based on the following templates for different events.

Note that the mail template files "code1.template" and "code4.template" are not used.

Back to Settings > Notification.

Services

Flow

On the Settings > Services > Flow page, you can change the settings for the processes that make up the Flow Service; see below for configuration guides and troubleshooting notes.

You need to restart the Flow Service after making changes. You can restart the Flow Service on the Tools > Services page.

• Server
• Java Startup Options
• HTTP and HTTPS Communication
• Flow Engine
• HTTP Listener
• HTTPS Listener
• Flow Designer Listener
• Checkpoint

See Also

• See the other Settings > Services pages to configure settings for other services - the Flow Service's FTP server and the management console timeout.
• See Tools > Services to manage the services - start and stop services, clear the cache, and get information about the running processes.
• See the System pages to configure other aspects of the system - deploy adapters, change the license, or change the Java path.
• See the Status > Flow pages to get other information about the running server, such as the current requests or performance metrics.
• See Status > Log > System to view, search, and download the logs for the services.

Server

The Server section contains the following fields.

Back to Settings > Services > Flow.

Java Startup Options

In the Startup section, you can change the options passed to the Java program.

Back to Settings > Services > Flow.

HTTP(S) Communication

In the Communication section, you can configure how clients will connect and communicate over HTTP/S. (See HTTP Listener and HTTPS Listener, below, to configure the listener processes.)

Back to Settings > Services > Flow.

Checkpoint

In the Checkpoint section, you can configure the RDB connection for checkpoints:

Back to Settings > Services > Flow.

Flow Engine

In the Flow Engine section, you can configure the Flow Engine process. See below for notes on troubleshooting and the available settings.

• Flow Engine Threading and Execution
• Timeouts, Caching & Other
• Connection Pooling
• Transaction Recovery
• Parallel Threads
• High Priority Threads

Back to Settings > Services > Flow.

Flow Engine Threading and Execution

Back to Flow Engine settings. Back to Settings > Services > Flow.

Timeouts, Caching & Other

Back to Flow Engine settings. Back to Settings > Services > Flow.

Connection Pooling

Back to Flow Engine settings. Back to Settings > Services > Flow.

Transaction Recovery

Back to Flow Engine settings. Back to Settings > Services > Flow.

Parallel Threads

Back to Flow Engine settings. Back to Settings > Services > Flow.

High Priority Threads

Back to Flow Engine settings. Back to Settings > Services > Flow.

HTTP Listener

In the HTTP Listener section, you can configure the HTTP listener process. Below are notes on the settings and troubleshooting.

• HTTP Listener Threading and Execution
• HTTP Settings

Back to Settings > Services > Flow.

HTTP Listener Threading and Execution

Back to Settings > Services > Flow.

HTTP Settings

Back to Settings > Services > Flow.

HTTPS Listener

In the HTTPS Listener section, you can configure the HTTPS listener process and SSL settings. See below for notes on the settings and troubleshooting.

• HTTPS Listener Threading and Execution
• HTTPS Settings

See HTTP(S) Communication to enable the HTTPS listener. Back to Settings > Services > Flow.

HTTPS Listener Threading and Execution

Back to HTTPS listener settings. Back to Settings > Services > Flow.

HTTPS Settings

Back to HTTPS listener settings. Back to Settings > Services > Flow.

Flow Designer Listener

In the Flow Designer Listener section, you can configure the following settings. See below for notes and troubleshooting.

• Flow Designer Listener Threading and Execution
• Flow Designer Access Log

Back to Settings > Services > Flow.

Flow Designer Listener Threading and Execution

Back to the Flow Designer listener settings. Back to Settings > Services > Flow.

Flow Designer Access Log

Back to Flow Designer listener settings. Back to Settings > Services > Flow.

FTP

On the Settings > Services > FTP page, you can configure the Flow Service's FTP server; see below for a guide:

• Configuring the FTP Service

See Also

• See Tools > Account to allow a Flow Service account to authenticate to the FTP server.
• See Tools > Services to manage the FTP service and other Flow Service processes.
• See Status > Log > System to access the logs for the FTP service and other services.
• See Settings > Trigger > FTP to create an FTP trigger, which runs when files are uploaded to the Flow Service's FTP server.
• See Settings > Connection > FTP to create a connection to an external FTP server, which you can use as a data source or data destination in your flow.

Configuring the FTP Service

• FTP Authentication
• Autostart
• FTP Server Settings

FTP Authentication

You can authenticate to the FTP server with a Flow Service account or configure anonymous login. Configure FTP users in the user account settings on the Tools > Account page. Configure anonymous login in the FTP server settings.

Back to Settings > Services > FTP.

Autostart

Note that the FTP service does not start automatically, by default; to configure the service to start when the Flow Service starts, select the FTP service on the Tools > Services page and select the Automatic Start option.

Back to Settings > Services > FTP.

FTP Server Settings

See below for details on the settings. After you make changes, restart the FTP service on the Tools > Service page.

Back to Settings > Services > FTP.

MC

On the Settings > Services > MC page, you can configure the login timeout for the Flow Service Management Console.

Restart the FSMC after making changes.

タイムアウト設定

Style settings

Password

In Settings > Password you can change the password of the user currently logged into the Flow Service Management Console:

See Also

• See Tools > Service to configure other user account settings as an administrator.

Tools

On the following pages, you can manage Flow Service accounts and server-side services:

Account

On the Tools > Account page, an administrator can configure user accounts and domains. Select a user or domain to configure the following:

• Domains and users
• Role
• Password
• Home directory
• Context path
• Version Control
• FTP
• Certificates
• Automatic export and other settings

See Also

• See Users and Roles for more information on each role's permissions.
• See Settings > Password to change the password for the currently logged-in user.
• See Status > Version Control to update and revert as the currently logged-in user.

Domains and Users

• Create a Domain
• Create a User
• Set User and Domain Attributes

Back to Tools > Account.

Create a Domain

See below for a procedure and notes. You will create a domain and the domain administrator, the asu user.

1. Select the parent domain and click Create Subdomain.

   

2. Enter the Subdomain Name in the dialog that is displayed.

3. Enter the admin's password in the asu's Password field.

Notes:

• The domain name is also used as the folder name for the domain's home folder.
• The password is case sensitive

Back to Tools > Account.

Create a User

See below for a procedure and notes:

1. Select a domain.
2. Click Create User.

3. Enter the Username and Password and select the Role.

   Administrator	Has all permissions to the domain and subdomains.
   Developer	This role is used for development in the Flow Designer. This user cannot manage users or the server.
   Operator	This role has read-only access.

   See Users and Roles for each role's level of access to the FSMC.

Notes:

• One-byte letters, numbers, an underscore (_), and the minus mark (-) can be used.
• The first character should be an underscore (_) or a letter.
• The Password is case sensitive, while the Username is not.

Back to Tools > Account.

Set User and Domain Attributes

Typically, you only need to configure user and domain attributes in advanced scenarios. Attributes are set automatically as you make changes in the FSMC. Only the administrator of the root domain can manually edit the domain attributes.

In the Other section, you can do the following:

• Automatically export projects and triggers.

Back to Tools > Account.

Role

The role determines a user's read, write, and execute permissions for flows and also the user's level of access to the management console.

See Using the Flow Service Roles in Common > Users and Roles for the complete permissions and access levels for each role.

Back to Tools > Account.

Password

Note that there is no limit to the length of the password, and letters are case sensitive.

Back to Tools > Account.

Home Directory

Follow the steps below to move or copy the home directory:

1. Enter an absolute path in Home Directory.

2. The default action is to copy the home folder. If you want to move the home directory, select both the options to copy files to the new home directory and delete the old home directory.

   {.screenshot .size_auto}

Notes:

• When you are designing a flow, you can include files in the flow with a path that's relative to the home directory.
• You cannot set the home directory to a relative path (you need to specify an absolute path).

Back to Tools > Account.

Context

You can use the user context path to do the following:

• Create URL triggers: For example, if you set "/test" for the context path, then you can define a URL trigger for http://<your-server>/test/flow1.
• Execute flows directly: You can also configure flows to be executed directly, without a URL trigger.
• Serve static content: You can also configure the user context to resolve to static files.

See below for setup procedures and more information:

• Resolving the context path
• Configuring the User Context

See Also

• See Settings > Connection > URL to create a URL trigger.

Back to Tools > Account.

Resolving the Context Path

The URL is resolved as follows.

1. If a URL trigger has been set for the URL, the Flow Service executes the associated flow.
2. If a URL trigger has not been set for the URL, the Flow Service searches files from the root document.
3. If there is not a file in the root document, the Flow Service searches the DTD folder.

Back to Tools > Account.

Configuring the User Context

See below for notes on the available settings:

HTTP Service User	Select ON to enable the settings below.
Context Path	Enter the URL path that is used to select the context that the request is passed to.
Basic Authentication	Select ON to perform HTTP Basic authentication in the context. The Flow Service account will be used in the authentication, when the flow is executed. The username provided in Basic authentication is the Flow Service account's full domain name. For example: "/guest" or "/testdomain/testuser". Note that the leading / symbol is required.
Document Root	Enter the relative path to the document root from the home directory of the user.
Welcome Page	Enter the resource to return in a redirect when a folder is requested. The resource must be a file or you must register this resource as a trigger. The redirect will not occur otherwise.
Listing	Select ON to return a directory listing when a folder is requested.
Includes	Enter the files to include. You can specify a comma-separated list of the file-matching patterns below: ** Matches the paths to 1 or more folders. * Matches more than 1 character within a folder name or file name. ? Matches any single character within a folder name or file name. . Matches a folder when you append a dot following a folder name in the pattern. / This can be used as a path delimiter only. Examples: **/*.html Returns .html files from all folders. dir1/. Returns the "dir1" folder or folders.
Excludes	Exclude files matching the patterns specified here. You can specify a comma-separated list using the same matching patterns as the Includes setting.
Max body size (KB)	Enter the maximum size of the HTTP request body that the server will accept.
Allow direct execution of flows	Select ON to allow a flow under the root document to be executed without a URL trigger. You can then execute a flow by making a request like the following: context path/path/to/project file name/Flow name. (Note that if there is are non-English characters included in the flow name, the flow cannot be executed directly. In this case you must also set the flow property Invoke by HTTP to true - select the flow and change the property in the Basic properties pane.)
Allow auto register	Select ON to allow the direct execution of projects that are not registered with a trigger. With this option selected, you only need to copy an .xfp file under the root document to then be able to execute a flow.
Default flow for direct execution	Enter a default flow to execute when direct execution is enabled. Use the following syntax in the URL: project file name / flow name.

Back to Tools > Account.

Version Control

Follow the procedures below to configure version control for a user account. You will connect to an SVN repository and commit the user's home folder to the version history. You can then synchronize the user's projects and flows with other revisions in the SVN tree.

• Connect to a Repository
• Synchronize to a Revision

See Also

• See Status > Version Control to work with SVN as the logged-in user. Here you can update, revert, and check the status.

Back to Tools > Account.

Connect to a Repository

Use the following settings to connect to the SVN server, check in the user's home folder, and configure the working tree:

Use version control	Select ON.
Subversion URL (required)	Enter the URL of a directory in the SVN repository. The specified URL will be synchronized with the user's home directory.
Subversion username (required)	Enter the name of a user known to the SVN server.
Subversion password (required)	Enter the user's password.
Ignore	Enter the patterns of the files to be ignored in version control. You can separate multiple patterns with a semicolon ";" and use "*" and "?" as wildcard characters. Generally, you can keep the defaults but you may need to add other file patterns. The defaults are below: Pattern Description Example match .* Ignore hidden files or folders .svn _* Ignore files or folders that start with an underscore _tmp .xfp2 Ignore intermediate project files myProject.xfp2 .$$$ Ignore log files myProject.xfp2.$$$ In the Flow Designer, you can right-click version-controlled files and folders to ignore an individual file or edit the ignore list for an individual folder.
Lock required	Enter the files that need to be locked while they are being edited. You can separate multiple patterns with a semicolon ";" and use "*" and "?" as wildcard characters.
Create a new folder at the URL	Select ON to create the folder specified in the URL if it doesn't exist.

Back to Version Control. Back to Tools > Account.

Synchronize to a Revision

Click Sync Now to sync a user's home folder with the latest revision (the head revision) or with the revision you specify.

Back to Version Control. Back to Tools > Account.

FTP

The Flow Service includes a built-in FTP server. See the following procedures to configure authentication:

• Configure User Authentication
• Configure Anonymous Login

See Also

• See Tools > Services to manage the FTP service and other Flow Service processes.
• See Settings > Services > FTP to configure the Flow Service's FTP server.
• See Settings > Trigger > FTP to create an FTP trigger, which runs when files are uploaded to the Flow Service's FTP server.
• See Settings > Connection > FTP to create a connection to an external FTP server, which you can use as a data source or data destination in your flow.

Back to Tools > Account.

Configure User Authentication

After following the steps below, the user account will be able to authenticate to the FTP service. You will also configure upload/download permissions.

Before you start, ensure that the FTP service is running. By default, the FTP service is not started when the server starts. You can start the service by clicking Tools > Service.

You can now access the FTP server with the Flow Service account.

Back to Tools > Account.

Configure Anonymous Login

Allow anonymous login in the settings for the FTP service: Settings > Services > FTP.

Back to Tools > Account.

Certificates

In the Certificates section, you can configure

• the user's certificate (select the Certificate category): This is used in some components where the user has to provide a private key or a certificate. These components include SMIMEEncrypt, SMIMEDecrypt, SMIMESign, HTTPGet, HTTPPost and REST.

  Note that the certificates in Settings > SSL are used by default for SSL connections. But for some components you can change this to use a user certificate. For example, when using the HTTPGet component, the Client Certificate in Settings > SSL certificates is used by default, but you can set a user certificate with the ClientCertAlias property.

• your partner's certificates: These are used in the SMIMEEncrypt-component to encrypt a message for the selected partner as recipient.

• CA certificates: These are used in the SMIMEVerify component as trusted CA certificates.

Back to Tools > Account.

Other

Automatically Export Projects and Triggers

The following settings simplify migrating projects and triggers to another server. You can automatically generate export files for projects and triggers when the trigger is executed; see below for the configuration procedure. To do the migration, you then import the file.

1. In the Other section, set Create export files automatically to ON.
2. Enter a value in Export Filename. The export filename must be a relative path from the user's home folder.
3. If desired, allow the user read-only access to existing projects; set Designer readonly to ON. When you connect to a project from the Flow Designer with this user, you will have read-only access to the project, functions, external variables, and stream definitions.

Back to Tools > Account.

Maintenance

On the Tools > Maintenance page, you can back up and restore Flow Service logs and settings. See the following sections for procedures and notes.

• Paths in the Backup
• Create a Backup
• Restore a Backup
• Delete a Backup
• Upload a Backup
• Download a Backup

See Also

• See Settings > Log > Purge to purge logs and checkpoints or configure a purge schedule.
• See Settings > Services to configure the services that make up the Flow Service.
• See Tools > Services to start and stop services, get resource use and other process-level information, and perform other management tasks for the services.
• See Status > Log > System to get service logs.

Paths in the Backup

The ZIP contains the paths under [INSTALL_DIR]/flow. The following table matches the files in the ZIP to the files on the server:

Service	Backup folder	Path
Common	conf	conf
	keystore	data/keystore
	statistics	data/statistics
FlowService	conf	services/flowservice/conf
	data	services/flowservice/data
FtpService	conf	services/ftpservice/conf

Back to Tools > Maintenance.

Create a Backup

To create a backup, click Backup and enter a comment.

Back to Tools > Maintenance.

Restore a Backup

1. On the Tools > Service page, stop all services except AccessControl and ManagementConsole.
2. On the Tools > Maintenance page, select an available backup and click Restore.
3. Restart the server.

Back to Tools > Maintenance.

Delete a Backup

Select a backup and click Delete to delete the files off the server.

Back to Tools > Maintenance.

Upload a Backup

Click Upload and browse to the ZIP file.

Back to Tools > Maintenance.

Download a Backup

Click Download and browse to the ZIP file.

Back to Tools > Maintenance.

Calendar

On the Tools > Calendar page, you can configure the system calendars used to execute triggers. See below for procedures and notes.

• Create a Calendar
• Get and Edit Calendar Details
• Clone a Calendar
• Delete a Calendar

See Also

• See Settings > Trigger to create triggers.

Create a Calendar

Click New and select the days you want to execute on over a number of years.

Back to Tools > Calendar.

Get and Edit Calendar Details

Select a calendar and click Edit to display or change the schedule.

Back to Tools > Calendar.

Clone a Calendar

Back to Tools > Calendar.

Delete a Calendar

Back to Tools > Calendar.

Services

On the Tools > Services page, you can manage the server-side services. Select a service to do the following:

• See the memory usage.
• Get process details.
• Start and stop the service.
• Execute garbage collection.
• Start the service automatically.
• Suspend/resume (Flow Service only).
• Clear the caches and connection pool (Flow Service only).

See Also

• See Status > Flow > Graph to monitor memory usage and view graphs of performance metrics.
• See Status > Log > System to access debug output for the services.
• See Settings > Services > Flow to change the service settings.

See the Memory Usage

The graph below displays the status of the heap memory for the service you select:

Green represents the free memory, and red represents the used memory. The circle represents the max memory size. You can change the max memory size and other Java startup options in Settings > Services > Flow > Start.

Back to Tools > Services.

Get Process Details

The Monitor section displays the following details for the process you select. Click Reload to refresh the table.

QMAX	The maximum size of the request queue.
QUEU	The number of requests remaining in the request queue.
RACC	The number of requests that can be accepted.
RWIN	The number of threads that have started processing requests.
RWOT	The number of threads that have completed processing requests.
PMAX	The maximum time spent on processing requests by thread.
PMIN	The minimum time spent on processing requests by thread.
WMAX	The maximum number of parallel threads.
WPOL	The number of thread pools.
WRUN	The number of running threads.
WDED	The number of threads that have spent too much time on processing and are considered to have timed out. If a thread completes processing and ends successfully, this value decreases.

Back to Tools > Services.

Start and Stop Services

Click Start and Stop next to Status. To recheck the service status, click the refresh button at the top of the service list.

Back to Tools > Services.

Execute Garbage Collection

Click Execute next to Garbage Collection to free the unnecessary memory kept in the service.

Back to Tools > Services.

Start the Service Automatically

Select ON next to Automatic Start to start the service when you start the server. If you set this to OFF, you need to start the service on this page or use the fsctrl command.

For a reference to the fsctrl command, see section 1.2 in the Flow Service Operation Guide in the Flow Service Manual - "Start or Stop from the Command Line."

Back to Tools > Services.

Suspend/Resume (Flow Service only)

Click Suspend or Resume to allow or disallow the Flow Service to accept new requests.

Notes:

• Note that if you suspend the Flow Service while a flow is currently running, the Flow Service finishes executing the flow.
• Don't restart only the Flow Service while its status is "Suspended." Otherwise, flows that use schedule triggers will not .

Back to Tools > Services.

Clear the Caches and Connection Pool (Flow Service only)

See below for more information on when you need to clear the Flow Service caches or the connection pool:

• Clear the account information cache.
• Clear the database connection pool.
• Clear the project cache.

Back to Tools > Services.

Clear the Account Information Cache

Account information can be reused if it has been used only once. Clear the account information cache to reflect the changes in this case.

Back to Clear the Caches. Back to Tools > Services.

Clear the Database Connection Pool

Database connections can be reused if they have only been used once. You may need to create a new connection when the old connection has entered an exception state, for example, if the database server was restarted.

In this scenario, operations on the database would throw an exception if you used the cached database connection. Clear the connection pool to reconnect.

Back to Clear the Caches. Back to Tools > Services.

Clear the Project Cache

Project information can be reused if it has been used only once. If you copy a project or change the Flow Service account information, you might reuse the cached project information. Clear the project cache to reflect the changes in these cases.

Back to Clear the Caches. Back to Tools > Services.

System

Here you can manage the system configuration -- update the license, deploy adapters, or reset settings. You can also get details about the server environment.

License	Get license details or install a new license.
Server	Get information about the server, OS, and Java.
Contract	Change the contract account that the license is registered for.
Update	Update the system, apply patches, and deploy adapters. System Update the system version. Patch Patch the system and see the installed patches. Adapter Deploy and manage adapters.
Initialize	Initialize the settings for server-side services.

License

On the System > License page, you can change the license.

• ASTERIA Standard Edition
• Core or Core+ Edition

ASTERIA Standard Edition

1. Click Change to replace a trial license or install a new license needed to deploy an adapter.
2. Restart the server to start using the new license.

Core or Core+ Editions

1. Click Get next to the license key.
2. Restart the server to start using the new license.

Server

On the System > Server page, you can get the server and OS version and change the Java path.

Change the Java Path

1. Click Change beside Java Path and enter the path to java.exe.

   

2. Restart the server.

Contract

On the System > Contract page, you can change and validate the contract account. Note that you can perform the validity check in an online environment only.

Update

On the System > Update page, you can do the following:

• Update the system to a new version.
• Patch the system.
• Deploy an adapter.

System

On the System > Update > System page, you can update the system to a new version. A network connection is needed. Restart the system after you apply the update.

Patch

On the System > Update > Patch page, you can do the following:

• Apply a patch.
• Get patch details.

Apply a Patch

Click Upload to select the patch to apply. You need to restart the server to reflect the changes.

Back to System > Update > Patch.

Get Patch Details

Select a patch you applied and click Detail to show the following information:

Back to System > Update > Patch.

Adapter

On the System > Update > Adapter page, you can do the following:

• Update an adapter.
• Get adapter details.
• Upload an adapter.

Update an Adapter

With a network connection, the latest builds of adapters are shown. New builds of installed adapters are downloaded automatically. Click Download to download adapters manually. Click Apply All to apply all downloaded builds after you restart the system.

Back to System > Update > Adapter.

Get Adapter Details

Click Detail to display the following information:

Back to System > Update > Adapter.

Upload an Adapter

To upload an adapter that you downloaded from the user site, click Upload and select the adapter file to apply. The adapter will be applied after you restart the server.

Back to System > Update > Adapter.

Initialize

On the System > Initialize page, you can initialize the system configuration file, where the settings for the server-side services are saved.

Clicking Initialize does the following:

• Initializes the configuration file to the state at the first startup of the server. This changes the following settings under the Settings menu:

  • Log > System
  • Notification
  • Services > Flow (except the settings under Services > Flow > Server)
  • Services > FTP
  • Services > MC
• Sets the management console's port number to the port you defined in the Initial Settings wizard on the first server startup.
• Sets the password of the superuser, "asu," to the current password.

See Also

• See Tools > Maintenance to create and restore backups of the server settings.