Misc elements in the Process Designer tool enhance capabilities of the
Automator.
Element
Name |
Description |
Properties
and Comments |
Distribution |
Distributions specify actions, called distribution
actions, that distribute or handle files and information outside
of Automator.
Distributions can be specified for input files,
export files, and portable reports, and can be configured with
the Distribution Editor and the Script Editor. Distributions can
be used for:
-
Sending
emails
(with or without attachments)
-
RSS feeds
-
Moving, copying,
and deleting
files (to both the file system and to FTP/SFTP-compliant and
WebDAV-compliant servers using http)
-
Writing
to the Windows Event Log
|
Acceptable distribution actions:
-
Log — allows you to create an
event written to WindowsApplication Event Log.
-
Email — allows you to email
files to another user
-
Move — allows you to move files
to another location, either to the file system using drive
letter or UNC naming, or to FTP/SFTP and HTTP locations
-
Copy — allows you to copy files
to another location, either to the file system using drive
letter or UNC naming, or to FTP/SFTP and HTTP locations
-
Delete — allows you to delete
all files specified by the distribution
-
RSS — allows you to "pull"
information as opposed to the "push" model of Email
-
Email By Key — allows you to
set the recipients of the E-mail, based on key. This option
available only for the Summary Export element.
-
Export to Amazon S3 — allows
you to export input and export files to Amazon S3.
Detailed information on distribution
settings is specified in the Distribution Settings
table below. |
Script |
Automator supports the use of Visual Basic.NET
script.
You can find collection of Visual Process Designer
scripts is the Process
Designer Scripting API section. |
-
Name — name of the graphic element.
-
Script field — displays the
current script.
-
Run — runs the current script.
-
Insert Script — allows
to quickly generate VB.NET script for frequently used tasks.
Click to select the necessary options. For details, refer
to Inserting
a Script section.
-
User Scripting Help — opens
Help on user scripting.
If the scripts have errors, all the errors are
displayed below the Script field.
All namespaces and references, which are specified
in the Global Scripts of Standard Processes, are imported in the
scripts of Visual Processes.
There is no limit to what you can do with the
scripting function of Visual Process Designer Scripting API. The
entire Microsoft .NET Framework is available for use.
You can use Visual Studio.NET to help create your
scripts, or you can obtain the free Microsoft .NET Framework SDK.
Note that while you can compile and test your
scripts with the Visual Process Script, you must ensure that you
are not using message boxes or other functions that interact with
the UI when you are running the scripts as part of a process.
NOTE: Automator users
can only edit scripts if they are granted editing privileges by
the Admin. |
Credentials |
Use it to specify the HTTP, FTP/SFTP, and
Amazon S3 login credentials for input, model, export files from
an FTP/SFTP site, a SharePoint repository, or Amazon S3 storage. |
Note:
To use the current windows login, select the corresponding check
box.
-
FTP/SFTP Credentials — specify
a name in the User name field and password in the Password
field.
-
Amazon S3 Credentials — specify
an ID in the Access key ID field and an access key in the
Secret access key field.
|
Timer |
When configuring a process, one of the settings
you can specify is a process retries setting.
This setting allows a process workflow to be retried
if it fails for some reason, such as due to a process prerequisite
not being met.
When specifying a process retries setting, you
may specify the interval for the retry in hours and minutes, as
well as the number of retries to attempt.
NOTE: The Timer object can also
be configured such that it sends an alert about failures in the
process after the set number of retries has been exhausted. For
example, once the number of retries has been exceeded, the Timer
object could trigger an email distribution informing staff of
the failed process. |
-
Name — name of the graphic element.
-
Retry Type: select one of the
following options:
-
-
Indefinitely: Select this
option to continue retrying the process indefinitely until
it runs successfully.
-
Retry at most: Select this
option to enter the maximum number of times you want the
Automator to retry running the process.
-
Retry every — the desired retry
interval in hours, minutes or seconds.
|
Visual Process |
This functionality allows processes
to be run in a chain.
Example:
In this case, the first process starts to run.
As soon as it is completed, the second process starts. If the
first process fails, the second process does not start,
except if the two processes are connected by a red connector. |
-
Name — name of the visual process
-
Process name field — click the
Browse button to select
a saved visual process
-
Description — description of
selected visual process
-
Preview Process — click this
option to preview the selected visual process
|
Standard process |
This functionality allows processes
to be run in a chain.
Example:
In this case, the first process starts to run.
As soon as it is completed, the second process starts. If the
first process fails, the second process does not start,
except if the two processes are connected by a red connector. |
-
Name — name of the visual process
-
Process name field — click the
Browse button to select
a standard process
-
Description — description of
the selected standard process
-
Projects — list of projects
connected to the standard process; click the project name
to view its information
|
File Burster |
This functionality allows file or web inputs
to be split into smaller files according to defined properties.
|
NOTE: Only ASCII files
are supported as input for file burster item (e.g., .txt and .prn
inputs are supported but .pdf inputs are not).
-
Recognize
Line Key, Offset
– optional identifier within the input files to be bursted;
bursting proceeds when the key is recognized within the input
file; offset specifies
the number of characters to be counted from the left of the
key
-
Trim
leading characters – this option is available when Defined
Bursting is selected; specify the number of characters to
be trimmed from each line throughout the output document (small
values are usually used, e.g., 1 or 2)
-
Burst
Type (Defined or Pages)
Defined:
Used when the input file contains a table. The table is parsed
according to the following definitions:
-
Index
Table Start Maker, Offset – an indicator that marks
where in the input file the index table begins
-
Line
Validator, Offset – specifies the symbols that mark
the beginning of a line
-
Line
Field Offset, Line Field Length – specifies the column
number in the input file that marks the end of a line;
field length specifies the number of characters that make
up the line field
-
ID
Field Offset, ID Field Length – specifies the number
of characters in the input file that should mark the beginning
of the ID field; field length specifies the number of
characters that make up the ID field
-
Index
Table End Marker, Offset – an indicator that marks
where in the input file the index table ends
-
Content
Start Marker, Offset – an indicator that marks where
in the input file the content of the table begins
Pages:
A Monarch model is used to define the page headers of a file and
parse it into smaller files. This is a better option when dealing
with large files.
-
Process
successive number files as one – select this option
if you want consecutively numbered files in one location
to be bursted as one file
-
Model
– specify the model file to be used for the input file
-
Pages
per Output File – specify the number of pages that
each output file should contain
-
Destination
Path – location of generated files after bursting
-
Output
Filename Mask – name pattern for the generated files
-
Error
Directory – location
of generated files containing errors after bursting.
NOTE: All burst output files will
inherit the “last modified” timestamp of the original parent input
report. |
The table below specifies distribution actions.
Distribution
Action |
Description |
Procedure
and Comments |
Log |
Allows you to create an event written to WindowsApplication
Event Log.
This can be useful when using system management
systems such as BMC Patrol, Tivoli, or Openview to tie in Automator
operations with your overall systems. |
-
Type: Select the type from the
drop-down list.
-
Event ID: Enter the event ID.
-
Message: Type the message in
the text field.
Note:
You may use the naming macros to provide a message for the log
distribution. To do this, click the Insert Macro icon and select
the naming macros from the drop-down list.
NOTE:
When exporting to Knowledge Studio, all three files (*.kdd, *.ksd,
and *.ksd-data) are listed individually in the event log. |
Email |
Allows you to email files to another user |
Emailing procedure:
-
Specify the recipients' email
addresses in the corresponding boxes: From,
To, Cc, Bcc. To select recipients from the contacts
list, click the Contacts
icon.
-
Type the message subject in
the Subject box.
Note:
You may use the naming macros to provide a subject line for an
email distribution. To do this, click the Insert
Macro icon and select the naming macros from the drop-down
list.
-
Type the message in the Message box.
-
Select the Attach
files check box to attach a file for the distribution.
-
Select the Zip
check box to archive the attached files. The Zip
Options appear.
-
Under Zip
Options provide the following information:
-
Specify the Compression
level from the following: None, Medium, Maximum.
-
Select the Store
directory path check box if necessary.
-
Select the Password
check box to set the password.
-
Select the Attach
links check box to attach a link to file.
Note:
Please specify the Admin Host
and Port information in
the System Settings.
-
Select the One
file per mail check box to attach only one file per
mail.
NOTE:
When exporting to Knowledge Studio, all three files (*.kdd, *.ksd,
and *.ksd-data) are kept together and sent in one email.
-
Select the email Priority
from the following: Low, Normal, High.
|
Move |
Allows you to move files to another location,
either to the file system using drive letter or UNC naming, or
to FTP/SFTP and HTTP locations. |
Moving procedure:
-
In the Destination
box, specify the destination folder. You can either enter
the destination folder path in the box or select the folder
in the Browse section.
-
Click the Browse
button to open the Browse dialog.
-
From the Named
Paths list, select the appropriate named path.
-
Select the folder from the
list displayed in the Named Path Content box.
-
Click OK
to add the folder.
-
In the Rename
as box, specify a new file name if you want to change
the file name.
Note:
You may use the naming macros to name the moved files and destination
folder. To do this, click the Insert
Macro icon () and select the naming macros
from the drop-down list.
-
Select the Change
extension to check box to change file's extension.
Specify new extension in the enabled text box below.
-
Select the Zip
check box, if you want to archive the file. The Zip
Options settings appear.
Note:
The Zip check box is disabled
if Change extension to
check box selected.
Under Zip
Options, provide the following information:
-
-
Select the Compression
level from the following: None, Medium, Maximum.
-
Select the Store
directory path check box, if you want to store
directory path.
-
Select the Set
password check box to set the password.
-
In
the When destination files
exist option:
-
Select
Raise error to
receive an alert of an existing file.
-
Select
the Overwrite
check box to overwrite the existing file.
-
Select
Skip to skip the
existing file.
NOTE: When exporting
to Knowledge Studio, all three files (*.kdd, *.ksd, and *.ksd-data)
are moved and listed in the log individually. |
Copy |
Allows you to copy files to another location,
either to the file system using drive letter or UNC naming, or
to FTP and HTTP locations. |
Copying procedure is similar to moving procedure
(see above).
NOTE: When exporting
to Knowledge Studio, all three files (*.kdd, *.ksd, and *.ksd-data)
are copied and listed in the log individually. |
Delete |
Allows you to delete all files specified by
the distribution. |
NOTE: When exporting to Knowledge
Studio, all three files (*.kdd, *.ksd, and *.ksd-data) are deleted
and listed in the log individually. |
RSS |
Allows you to "pull" information
as opposed to the "push" model of Email.
RSS (Really Simple Syndication) is a widely used
format for publishing information.
The RSS file must reside on a web server and be
accessible to users who can read the RSS feed using one of the
many free and commercial RSS news readers available on the market,
for example, RSSBandit. |
-
In the Feed
box, specify the RSS file. You can either enter the destination
folder path in the box or select the folder in the Browse
section.
-
Click the Browse
button to open the Browse dialog.
-
From the Named
Paths list, select the appropriate named path.
-
Select the folder from the
list displayed in the Named Path Content box.
-
Click OK
to add the folder.
-
Select the Create
if not found check box if you want to create the file
if the specified file is not found.
-
In the Title
box, enter the item title.
-
In the Item
description box, enter the item description.
Note:
You may use the naming macros to provide a title and description
for an RSS distribution. To do this, click the Insert
Macro icon and select the naming macros
from the drop-down list.
-
In the Link
box, enter the name of link to the file.
-
Expand the Channel
section to provide the channel parameters:
-
Title: Enter channel title.
-
Channel Description: Provide
channel description.
-
Link: Enter the name of
the link to the file.
Note:
If you leave the Title, Channel Description, and Link fields blank
the default values will be automatically assigned.
-
NOTE: When exporting
to Knowledge Studio, all three files (*.kdd, *.ksd, and *.ksd-data)
are listed in the RSS file individually.
|
Email By Key |
Allows you to set the recipients of the E-mail,
based on key. This option available only for the Summary Export
element. |
-
From:
Type the address or click the Contacts
icon to choose a sender.
-
To:
Type the address or click the Contacts
icon to choose a sender.
Note:
When typing multiple addresses, separate them with semicolon.
-
Recipients:
Allows you to set the recipients of the e-mail, based on key.
-
Subject:
The subject line for the message. You can use the adjacent
arrow icon to insert a naming macro.
-
Type the message in the Message box.
-
Select the Attach
files check box to attach a file for the distribution.
-
Select the Zip
check box to archive the attached files. The Zip
Options appear.
-
Under Zip
Options provide the following information:
-
Specify the Compression
level from the following: None, Medium, Maximum.
-
Select the Store
directory path check box if necessary.
-
Select the Password
check box to set the password.
-
Select the One
file per mail check box to attach only one file per
mail.
-
Select the email Priority
from the following: Low, Normal, High.
|
Export to Amazon S3 |
Allows you to export input and export files
to Amazon S3
NOTE: This option requires
the Credentials element to be connected to the Distribution element.
The Credentials element should be set with the appropriate Amazon
S3 credentials (i.e., access key ID and secret access key). |
-
Specify the URL path of the
Amazon S3 storage in the Destination
field.
-
Enter a new file name in the
Rename as field if
you wish to use a new file name for the export/input item.
-
Select the Change
extension to check box to change the file's extension.
Specify a new extension in the enabled text box.
-
In the When
destination files exist option:
-
Select
Raise error to
receive an alert of an existing file.
-
Select
Overwrite to overwrite
the existing file.
-
Select
Skip to skip the
existing file.
-
Select the Zip
check box if you want to archive the file. The Zip
Options settings appear.
Note:
The Zip check box is disabled
if Change extension to
check box is selected.
Under Zip
Options, provide the following information:
-
-
Select the Compression
level from the following: None, Medium, Maximum.
-
Select the Store
directory path check box if you want to keep the
directory path.
-
Select the Set
password check box to assign a password to the
archived file.
|