Professional Documents
Culture Documents
Axway Automator
Version 3.6
11 March 2013
Copyright Axway Software, 2013
All rights reserved.
This documentation describes the following Axway software: Axway Automator 3.6
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer
language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior
written permission of the copyright owner, Axway Software S.A.
This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information
in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway Software
S.A. may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this
document. Axway Software S.A. does not warrant that this document is error free.
Axway Software S.A. recognizes the rights of the holders of all trademarks used in its publications.
The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are
provided for your convenience only. Axway Software S.A. does not control, endorse or guarantee content found in such sites. Axway
Software S.A. is not responsible for any content, associated links, resources or services associated with a third-party site.
Axway Software S.A. shall not be liable for any loss or damage of any sort associated with your use of third-party content.
Contents
1 Introduction ............................................................................................................................................................ 5
2 Axway Automator .................................................................................................................................................. 6
Presentation .............................................................................................................................................. 6
3 Introduction to configuration ................................................................................................................................ 7
Configuration Options ................................................................................................................................ 7
Menu Bar ........................................................................................................................................... 7
Hierarchy ........................................................................................................................................... 8
Preferences ........................................................................................................................................... 9
Synchronize ......................................................................................................................................... 10
Rights management (Using LDAP) .......................................................................................................... 10
Console Management ............................................................................................................................ 12
4 Configuring the modeling server ........................................................................................................................ 25
Modeling Server screen ............................................................................................................................ 25
Using LDAP ............................................................................................................................................. 26
Internal mechanisms............................................................................................................................. 26
Behavior ......................................................................................................................................... 26
Configuration ....................................................................................................................................... 27
Example for Active Directory management .............................................................................................. 29
5 Configuring production servers ......................................................................................................................... 31
Production server screen .......................................................................................................................... 31
Advanced Tab ......................................................................................................................................... 31
AS/400 production server ......................................................................................................................... 32
Redirection Tab .................................................................................................................................... 33
Accounting Integrator connector ............................................................................................................ 33
Questionnaires Tab .................................................................................................................................. 34
6 Configuring domain servers ............................................................................................................................... 35
Domain server screen .............................................................................................................................. 35
Connectors Tab ....................................................................................................................................... 35
Audit ................................................................................................................................................... 36
7 Configuring connection objects ......................................................................................................................... 37
Connection Objects tab ............................................................................................................................ 37
JDE Connector......................................................................................................................................... 37
Movex M3 Connector ............................................................................................................................... 38
PeopleSoft Connector ............................................................................................................................... 38
Rules ......................................................................................................................................... 39
Pericles Connector ................................................................................................................................... 39
SAP Connector ........................................................................................................................................ 39
Multiple-Instance Principle ..................................................................................................................... 39
Load Balancing and Direct Connection .................................................................................................... 39
Submitting an SAP Job .......................................................................................................................... 41
Web Services Connector ........................................................................................................................... 42
Presentation
Axway Automator is a production automation system that is used to:
Implement production based on graphic modeling features; processing diagrams are defined dynamically
Schedule periodic or ad-hoc processing, that is processing that cannot be scheduled in advance
Synchronize all constraints (environment, applications, jobs, etc.); Automator processes the actions and
implements the schedule in real time
Prepare processing automatically
Centralize administration using a driver to provide an overall view of how operations are
progressing(ready, failed, rescheduled processing, etc)
Provide a simulation feature to test production scheduling rules
Configuration Options
To access the configuration, click the Configuration icon or, from the menu bar, select Exploration >
Exploration Pane > Configuration.
This guide describes each of these options. This chapter describes the options from this menu that can be
selected for and from any object, Hierarchy, Preferences, Synchronize, and Console Management.
The right pane is the working area used to create, modify or view Axway Automator object definitions.
The left pane of the window lists the different types of Axway Automator objects.
1. Double-click an object type to open the list of associated objects.
2. Double-click an object to edit it, so that it can be queried or modified.
The different types of objects are as follows:
Modeling Server
Production Servers
Domain Servers
Connection Objects
User Groups
Users
Profiles
Calendars
Macros
Scheduling Rules
Date Variables
Global Resources
Chart Views
Execution group
The icon is used to mask or redisplay the left pane of the window.
Menu Bar
Action
[Reinit] Reset a current modification/query by clearing the data in the fields. You can
then create a new object.
(Also available from the toolbar.)
[Save] Save changes to an object in the Configuration module or a chart in the
Modeling module.
(Also available from the toolbar.)
[Refresh] Cancel current changes and return to the initial status.
(Also available from the toolbar.)
[Print] Print the object configuration.
(Also available from the toolbar.)
[New] Create a new object.
Action
[Open] Open an existing object.
[Open Ref.] Open the reference object.
[Delete] Delete an object.
[Duplicate] Duplicate a resource.
[Set my default view] Set the default view for the connection user.
[Enable Server] Enable a production server.
[Disable Server] Disable a production server.
[Modify my password] Set the password for the connection user.
[Hierarchy] Access the hierarchical view of the objects used.
[Synchronize] Synchronize the modeling server data with the production servers.
[Preferences] Modify the look & feel and language of the GUI.
[Right management] LDAP Access the lists of login users and user groups. Define the
specific rights.
[Console management] List information for servers, Network, Chart locks, Connected GUIs, Database
information and Keys.
[Exit] Exit the application.
Exploration
[Show/Hide Browser] Display or mask the left pane to obtain a larger window.
[Close screen] Close the current screen when configuring a specific object (Also available from
the toolbar).
[Fullscreen] Set the display to full screen size
[Exploration Pane] Access the Configuration, Modeling or Processing modules.
Help
[Technical Support] Obtain the contact details for the Technical Support team.
[About] Obtain general information on the product.
Hierarchy
The Hierarchy menu gives a hierarchical view of the objects defined in Axway Automator and can be accessed
from all menus in the configuration module.
This menu is used to view all the relationships between the elements defined for the Production Server, Users,
Calendars, Macros, Scheduling Rules, Date Variables, Global Resources, Execution Group and Charts.
Subsequently, an element is selected in the left pane (scheduling rules, for example), and its occurrence. The
link structure is then expanded until the required information is found in the working area.
You can search for an element by specifying its name in the text area located in the toolbar. Then click the Find
Next icon to locate the next element or the Find Previous icon for the previous element.
From the V360 version, possibilities to have a hierarchical view from a Domain server or a Connection object:
Preferences
The Preferences menu is used to manage the preferences of the user logged in and can be accessed from all
menus in the configuration module. Any changes you make to the preferences are only applied when you
restart the GUI.
General tab
In the General tab, you can modify the following general parameters.
Parameter
Location: Select the user language.
Look & Feel Selects the type of graphical user interface to be used (JAVA, CDE/Motif or
Microsoft Windows).
Toolbar Displays the icons in the toolbar with or without text.
Modeling tab
In the Modeling Graph tab, you can modify the display parameters of the objects in the graph.
Parameter
Position Grid Display or mask
Grid X-Spacing Distance between two points along the X axis in the grid.
Grid Y-Spacing Distance between two points along the Y axis in the grid.
Object Color Click to modify the color.
Tracker tab
In the (Tracker) Graph tab, you can modify the following parameters.
Parameter
Automatic scrolling Enable or disable automatic scrolling
Display color Select the display color for the objects.
Synchronize
Synchronization is run on request to update the objects that were modified after at least one instance was
created (user password, calendar, macro, scheduling rules and date variables). The Synchronize menu can be
accessed from all menus in the configuration module.
When you request synchronization, the parameters of the objects to be synchronized are sent to the relevant
production servers in real time to be applied immediately, except for the scheduling rules, which are processed
when the schedule is next accessed (subsequent session).
Note: The names of objects that have been modified and are to be synchronized, so that they can be applied,
are preceded by the pencil icon.
User groups
From the list of user groups, select one to retrieve the groups attributes (description) set in LDAP. The edition
of profiles and contexts for the group allows the connection of the associated users.
You have to associate one or more profiles to a user group
The Inherited contexts tab allows defining contexts which will be inherit by the users of this group.
Contexts tab: the association of contexts to a group makes it possible to restrict the perimeter of action.
Users
From the list of users, select one to retrieve the user attributes, description and user groups, set in LDAP.
The user inherits all the rights given to all the profiles and contexts associated with the groups allowed in
Automator (with icon).
Contexts tab: the Inherited context list displays contexts which are defined for the user groups.The association
of contexts to a user primarily makes it possible to restrict that users perimeter of action.
Console Management
Use the management console to locate information about the following sections: list of known and connected
servers, network, locked charts, list of interfaces connected to the modeling server. The login users need rights
to access the Console management. Set these rights read and/or write when configuring Profiles.
You can configure the production server and the modeling server as follows:
Set the log level and the maximum log size.
Configure the properties (file $HOME/config/OPSchedule.ini):
For each property, there is a name, if we must restart or not the server to take into
account the modification, the actual value (that we can modify), and the description
with the accepted values.
File transfer (file $HOME/lists/transfert_tcp.lst):
Only on production server. For each line there is no autonomous server, the real
server name, the script used, the login and the password of the user.
Bank holidays:
Only on modeling server. You can configure the bank holidays. From this window,
we can add and delete countries (if not used), add and delete years and
synchronize the new configuration to the production servers.
To set or unset a bank holiday, just click above.
You can configure the domain server as follows:
Access and update properties files for technical configuration of the Domain Server.
Access and update properties files for ERP connector types used by this Domain Server. The new values
updated in the files are notified to the object instances.
Network
From the Network tab, you can verify the Network activity between a reference server and a specific server
chosen from the list.
From version 3.6.0 with IPv6 compatibility, use the management console to verify the
network activity whatever the protocol version:
Resolve a name (ping in ipv4 and ipv6)
Transaction verification (DCX): alert in case of communication errors.
Verify UDP.
In main menus of Automator an alert represented by the icon is displayed if UDP problems are detected
(UDP not sent after 5 minutes).
Symbol appears on the left of the servers which have UDP not sent after 5 minutes.
Click the button to list the UDP for the selected server.
To modify the order of display for UDP: Right click the header of the column that you want to sort.
Select a specific Production Server to display the list of waiting UDP:
Through this console it is possible for users to delete UDP if they are blocked due to network issue: Right click
the UDP to delete.
This operation can be dangerous for the production; a dialog box is displayed to confirm your choice:
With:
No button to abort.
Yes button to delete the selected UDP.
Database Information
You change the database connection parameters in Automator as the OPADMIN user. You have to update the
OPSchedule.ini file. The modeling server must be started.
You need to have the same username and password in the database environment. It is better to use the Axway
Installer in configure mode because that is the only way to update both Automator and XDBM.
If there is a difference between the password in the database environment and the password in the
OPSchedule.ini file, the modeling server does not start.
For more information, refer to the Database Management chapter in the Automator Getting Started Guide.
The users password is encoded in the file. Do not manually modify the TO_DATABASE_USER_PWD variable in
OPSchedule.ini.
Database information is only available for the MySQL or MS SQL server database types.
Key Management
You can display the detail of the key for the specific modeling server:
Date of validity
Activated options
Number of licenses (production servers max)
Update center
From this tab, you can schedule and trigger update actions for any type of servers. More precisely, you can:
Upload the different service packs or patches required for any server to update (production servers,
domain servers or modeling server).
Schedule when (date/time) the update of the various servers will take place; take care to update the
servers in the right order : first the domain server(s), then the production server(s) and finally the
modeling server. It is not possible to update of GUIs by the update center.
The update operations will take place according to the schedule predefined in this step.
Warning: in order to update servers in the Windows environment, there are two prerequisites :
The servers must be installed in service mode.
The variable TO_SERVICE_NAME=MyServiceName describing the service name of the server must be set
in its configuration file: the file OPSchedule.ini for the Modeling and the Production server and the file
server.properties located in the DServer/config directory for the Domain server.
Button Action
Schedule a new update
Delete the selected update
pencil Edit selected update
Start/Resume the selected update
Hold the selected update
Stop the selected update
The set of actions you can perform on the update depends on the status of the update, as shown on the
following table:
When the update has the status Then you can select this Action
In Progress Hold - Stop
Not Ready Delete Edit - Stop
Scheduled Delete Edit - Stop
Paused Start/Resume
Canceled Delete
3. Locate the directory where the Service Packs (.jar) are stored.
5. Depending on the platform type and the product version of the selected file, the list
in the column on the right shows all the available servers. The list in the column on
the left represents the servers associated with the current update.
To add one or more servers to the update:
o Select the relevant server(s) in the list on the right.
o Click the Add button.
o To add all servers, click Add All.
2. Launch the script update.bat or update.sh (located in the bin directory for the
Domain server and in the scripts directory for the Production server).
3. Stop of the server (without killing this script).
4. Application of service pack or patch via the Axway Installer product (unattended
mode).
5. Restarting the server.
A notification is automatically sent to the modeling server to record the current
update session.
Error management
Due to the independent execution of the script, some errors cannot be returned to the
modeling server; however some messages are displayed in the Comments field of the GUI:
Field Description
Server Name Name of the modeling server, that is, the name of the system, on which the
server is installed.
IP Port Server IP port.
Description Freeform text of up to 132 characters.
Alert Server Name of the server, on which Alert Server is located.
Monitor Server Name of the server, on which Monitor Server is located.
Console Server Name of the server, on which Console Server is located.
Last Startup Date and time, at which the Automator server was last started up.
Number of charts Displays the number of available charts for statistical purposes.
Number of applications Displays the number of available applications for statistical purposes.
Number of jobs Displays the number of available jobs for statistical purposes.
Audit messages and statistics are sent to Axway Sentinel instead of Focal. There is no more Focal server to
define by default for the Modeling server definition.
Using LDAP
If this option is enabled in the modeling server configuration screen, the modeling and production server are
able to connect to an LDAP service to identify connection users, instead of defining users within Automator.
The LDAP plug-in is used to simplify the management of login users. In case a LDAP repository exists on the
network, Automator will use it to authorize the connection of a user.
Internal mechanisms
You have to associate one or more profiles to a user group.
You can also associate context(s), to a group or to a user. (Cf Rights management)
To be allowed to connect, a user has to be in a group with at least one profile.
The LDAP plug-in replaces the standard authentication method, by opening a session on the specified LDAP
repository when a user connects to an Automator server.
Behavior
There are several behavior modifications when using LDAP authentication:
The login users are no longer shown in the configuration tree; only submit users are available in the
Automator GUI.
The Rights Management (LDAP) panel is activated.
Login fails if the LDAP server is not available, unless you are logged in with OPADMIN.
When activating LDAP in Automator, all existing groups and login users are removed (Except OPADMIN).
A user disabling LDAP will have a configuration without user groups and login users (Except OPADMIN).
Configuration
For Automator to be able to connect to LDAP, the following parameters are required:
Field Description
LDAP Server LDAP URI : Specifies the LDAP server to connect to, and must be provided as a
Parameter URI. The port number is optional, and defaults to 389.
Connection User The specific name of the service account to use for binding to the LDAP server.
User Password The password for the service account used to establish the connection to the LDAP
server.
User fields mapping User root
Field name for the user name.
Field name for the description.
Group fields Group root
mapping Field name for the group name.
Field name for the description.
Requests LDAP search filters to obtain the list of users, the list of user groups and the groups
of a specific user.
Requests
List users
LDAP search filter for the user.
Example, (&(objectClass=person)(sn=%TOKEN%))"
The search filter must contain ONLY one %TOKEN%. Automator replaces the
%TOKEN% with a user name.
For a user search requests, a wildcard can be used. Do not put a wildcard directly
before or after %TOKEN%.
For a given name replacing %TOKEN% the search must return ONLY one result.
List groups
LDAP search filter for the group.
Example, (&(objectClass=groupOfUniqueNames)(cn=%TOKEN%))"
The search filter must contain ONLY one %TOKEN%. Automator replaces the
%TOKEN% by a group name.
For a group search requests, a wildcard can be use. Do not put wildcard directly
before or after %TOKEN%.
For a given name, replacing %TOKEN%, the search must return ONLY one result.
List groups of user
LDAP search filter for listing groups of a user.
Example, (&(objectClass=groupOfUniqueNames)(uniqueMember=cn=%TOKEN%,
ou=people, dc=example, dc=com ))"
The search filter must contain ONLY one %TOKEN%. Automator replaces the
%TOKEN% with a user name.
The performance of LDAP search depends on the complexity of these requests.
Cache
Cache TTL
Time To Live.
To improve performance, when a user connects to Automator, its definition is
retrieved from the LDAP server and put in a cache.
If the user connects again before the end of the TTL, values are read from the
cache. Otherwise they are retrieved again from LDAP server.
Clean LDAP cache
This button is to force clean the LDAP cache so that all user values will be retrieved
from the LDAP server even if the cache entry did not expire.
You can now access the Rights management panel in the Action Menu bar to define the Automator rights.
Requests
The List users field contains LDAP search filter for the user.
Example, (name=%TOKEN%)"
The search filter must contain ONLY one %TOKEN%. Automator replaces the
%TOKEN% with a user name.
For a user search request, a wildcard can be used. Do not put a wildcard directly
before or after %TOKEN%.
For a given name replacing %TOKEN% the search must return ONLY one result.
The List groups field contains LDAP search filter for the group.
Example, (cn=%TOKEN%))"
The search filter must contain ONLY one %TOKEN%. Automator replaces the
%TOKEN% by a group name.
For a group search request, a wildcard can be used. Do not put wildcard directly
before or after %TOKEN%.
For a given name, replacing %TOKEN%, the search must return ONLY one result.
The List groups of user field contains LDAP search filter for listing groups of a user.
Example: (&(objectClass=group)(member=CN=%TOKEN%,ou=people,dc=axway,dc=com))"
Field Description
Name Network name of the server where the jobs are to be executed, using up to 128
alphanumeric characters without any special characters (except , _ and @).
TCP Port Number of the server's communication IP port.
Description Freeform text of up to 132 characters.
License verification: It is impossible to create a new Production Server if the max number is closed.
Advanced Tab
The Advanced tab is used to enter the Job Log directory where the logs of executed jobs are to be stored. A
checkbox is used to specify that the log files are to be automatically deleted on a periodic basis according to a
number of days between 1 and 99.
If you have a AS/400 production server, you can check the Intercept manual jobs box, which renames the
XXSBMJOBXX command of the unique library to SBMJOB. The name of the unique library is stored in the
OPSUNIQ dtaara. Conversely, uncheck this box to reset the command to XXSBMJOBYY.
If the Enable server box is not checked, no transactions can be performed between the modeling server and
relevant production server (instantiating a Chart, for example). This parameter is useful when you create a new
production server, one which is not yet installed or started. In this case, transaction requests are stored and
sent only when you check this box.
The default duration for request storage is 72 hours. To modify the duration, use the
TO_NOTIF_FREQ=Number_of_seconds preference variable in OPSchedule.ini.
Redirection Tab
If the production server can submit AS/400 jobs, you can define intercepted jobs, so that they can be directed
to a predefined jobq.
Click the Redirection tab to display the following columns:
Field Description
Execution Group This execution group must already exist in the configuration and be associated with
the execution user.
Job name Enter a 10-character job name, a generic job name or *ALL.
User Enter a 10-character user name, a generic user name or *ALL (you do not have to
create the generic name or *ALL in the user list).
Enable This definition is activated for the redirection.
JOBQ Name of the queue.
Library Name of the jobq library.
Pending The job is redirected to the jobq and suspended.
Note: To intercept jobs and redirect them to the jobq, you must first define the physical AS/400 users in the
user definition and associate them with an execution group.
Field Description
RDJHome Installation environment.
RDJExec Execution environment.
RDJLang English/French.
QMGRName Queue Manager MQseries.
QMGRPrefix
TRKHome Sentinel server Installation environment.
TRKExec Files subdirectory & Script of audit file indexation.
TRKApiHome UniversalAgent Installation environment
Questionnaires Tab
This tab is used to specify the Questionnaires to be inherited by the jobs submitted on the production server,
irrespective of the job and chart. The list on the right shows the available Questionnaires. The list on the left
shows the Questionnaires assigned to the production server.
The order in which the questionnaires are applied can be modified by selecting a questionnaire in the left-hand
list and then using the up-arrow and down-arrow buttons. The first Questionnaire applied is also the first one in
the list.
Field Description
Name Network name of the server where the jobs are to be executed, using up to
128 alphanumeric characters without any special characters (except , _ and @).
TCP Port Number of the server's communication IP port.
Description Freeform text of up to 132 characters.
License verification: It is impossible to create a new domain server with inactivated connectors. Its possible to
create a domain server without any connectors for Reports generation.
Refer to the Automator Reporting Tool Users Guide.
Connectors Tab
A Domain server can communicate with multiple ERP and Axway products, the Connectors tab is used to select
the connectors to run and monitor.
Audit
Messages can be generated:
XOS_CFG_DSRV_NEW: Domain server creation
XOS_CFG_DSRV_UPD: Domain server update
XOS_CFG_DSRV_DEL: Domain server deletion
These messages can be activated from the configuration panel of the modeling server.
JDE Connector
License verification: Refuse the Connection Object definition saving if it is not defined as an authorized
connector.
You can verify the validity of the JDE connector key in the Console Management or check via API. Refer to the
Automator Advanced Users Guide.
To display the corresponding screen:
1. Right-click the JDE object in the left pane.
2. Select New where you enter the required information.
Field Description
Environment JDE working environment
Role JDE role
Movex M3 Connector
License verification: Refuse the Connection Object definition saving if it is not defined as an authorized
connector.
You can verify the validity of the Movex M3 connector key in the Console Management or check via API. Refer
to the Automator Advanced Users Guide.
To display the corresponding screen:
PeopleSoft Connector
License verification: Refuse the Connection Object definition saving if it is not defined as an authorized
connector.
You can verify the validity of the PeopleSoft connector key in the Console Management or check via API. Refer
to the Automator Advanced Users Guide.
To display the corresponding screen:
1. Right-click the PEOPLESOFT object in the left pane.
2. Select New to enter connection parameters.
Field Description
Application Server Application Server host to add/modify/delete
Port Number JSL Application Server port
Server List List of Application Server hosts
Button Description
Up The selected server takes the place of its predecessor in the server list. Nothing is done if the
selected server is the first in the server list
Down The selected server takes the place of its successor in the server list. Nothing is done if the
selected server is the last in the server list
Add Add the values of the fields Application Server and Port Number as a new server in the
server list
Modify Modify the selected server with the values of the fields Application Server and Port Number
Delete Delete the selected server from the server list
Rules
1: At least one Application Server host and port must be added to the server list. (The displayed format
in the server list is host:port).
2: The servers are tested by list order: the job is submitted to the first reachable server (and low-
loaded in the case of PeopleSoft load balancing system).
3: No verification is performed on these fields. Bad values may cause the PeopleSoft connector not to
run.
Pericles Connector
License verification: Refuse the Connection Object definition saving if it is not defined as an authorized
connector.
You can verify the validity of the Pericles connector key in the Console Management or check via API. Refer to
the Automator Advanced Users Guide.
To display the corresponding screen:
1. Right-click the PERICLES object in the left pane.
2. Select New to enter connection parameters: Host Network domain User
Pericles domain.
SAP Connector
License verification: Refuse the Connection Object definition saving if it is not defined as an authorized
connector.
You can verify the validity of the SAP connector key in the Console Management or check via API.
Refer to the Automator Advanced Users Guide.
Multiple-Instance Principle
Each Automator environment configured to submit SAP jobs can connect to one or more SAP systems at the
same time. The same production server can therefore submit SAP jobs to different SAP instances.
A TCP/IP connection is used via the standardized SAP/R3 BC-XBP interface.
The Axway Automator production server does not require the same operating system as the SAP/R3 server and
can be located on another system. However, only specific operating systems are supported for SAP. Refer to
the list in the SAP prerequisites document.
Advanced parameters:
Field Description
SAP route Name of the SAP route to be used if applicable.
This field may contain up to 50 alphanumeric characters.
User language This field may contain up to two upper-case alphanumeric characters - either
two characters for an international code or one character for a SAP language
code.
Debug Enable the SAP RFC traces.
ABAP debug Enable the ABAP debugger.
Connection control Enable the connection control.
A Web Server has to be installed to be able to launch a web service. You can install and deploy a Web Service to
test the Automator connector.
Refer to Production server and ERP in the Axway Installation and Prerequisites Guide.
MFT Connector
License verification: Refuse the Connection Object definition saving if it is not defined as an authorized
connector.
You can verify the validity of the MFT connector key in the Console Management or check via API. Refer to the
Automator Advanced Users Guide.
To display the corresponding screen:
Audit
Messages can be generated:
XOS_CFG_OBJCNX_NEW: Connection object creation
XOS_CFG_OBJCNX_UPD: Connection object update
XOS_CFG_OBJCNX_DEL: Connection object deletion
These messages can be activated from the configuration panel of the modeling server.
Users
Axway Automator works with three types of users:
Login users can log into the GUI
Submit users can submit jobs
AS/400 users can be intercepted (name, *ALL)
Login users have a list of chart rights (View/Modeling/Processing Tracker) and a default chart view enabling
them to access this view directly when browsing.
To display the corresponding screen:
If the LDAP plug-in is activated, there is no longer access to the Login user configuration (Refer to Rights
management chapter).
Note: If you are defining an AS/400 user and wish to perform manual job interception for either jobq
redirection or manual jobs, you must associate an execution group with the system on which
the manual jobs are to be intercepted.
Field Description
Name User name, up to 64 characters without any special characters (except , _ and
@).
Password Left-click the key to enter a password with up to 16 characters.
Description Freeform text of up to 132 characters.
Default View Name of the default view to be selected from a list.
AS/400 Context Exclusively for AS/400, it defines a unique execution group for each system. It is
a selection criterion for manual job interception.
User groups Manage user rights for a login user.
Context Manage rights on Automator objects.
Note: The submit user of a SAP job must be written correctly with the correct case (uppercase or lowercase).
Otherwise, submission problems could occur.
You can only associate objects with a context that belongs to the current user (the connected user). In the
following example, some contexts are grayed out, which means they are not associated with the connected
user.
Rules
Keep the following points in mind as you associate objects with a context:
It is not mandatory to create a context in order to be able to use the product.
Deleting a context is possible if it is not attached to an object.
Object and context association is not mandatory. When an object is not attached to a context, it is said to
be in the global context, or global.
A global object can be used by every user. But user rights on the object can restrict usage.
Object/context association implies access limitation to the object. Thus, user members of the contexts are
the only ones allowed to work with the object. Other users will be able to see it but not use it.
A change in a context can be tracked by using an audit message.
Note: When a context is added to or deleted from an object, you might need to synchronize it.
When a change is made to an object used in an instance, synchronization is required to propagate the
change to the production servers.
Profiles
Profiles allow you to define access rights according to object types.
Main rights
Four rights have been defined:
Read right (R)
An object can be read, but it cannot be modified.
Write right (W)
An object can be created or modified, but it needs read access.
Profile object
Description
This object is designed to define rights on the Automator object types:
Green indicates that the right is activated.
Red indicates it is not allowed.
Grayed out indicates that this object type does not support that right.
Profile audit
Tree messages can be generated to see any change in the profiles.
XOS_CFG_PRF_NEW: profile creation
XOS_CFG_ PRF _UPD: profile change
XOS_CFG_ PRF _DEL: profile deletion
These messages can be activated from the configuration panel on the modeling server.
Updating profiles
A user with sufficient rights can modify a profile. But the behavior will not be the same depending on the profile
being not used or used.
Profile used
If the profile is used it will impact all the user groups using this profile and all the users associated with this
group. The modification of the profile involves a new calculation of the rights and an update of the permissions
granted to the various concerned users.
In production, a synchronization operation forwards the changes to the production servers. Nothing will be in
effect on the Production server until synchronization is done.
Rules
At least one profile must exist
The Admin profile is automatically created
An update in the profiles is immediately reported to the users
It is possible to create a profile without any rights, users using this profile will not be able to do anything
A change in the profile can be seen through the audit message sent
User group
Definition
A user group is defined by its name, description and one or more profiles that result in a main profile.
User groups are created to simplify access rights management.
A user group is the simplest way to group login users with the same profile.
If the LDAP plug-in is activated, no more access to the User group configuration (Refer
to Rights management chapter).
Audit
Messages can be generated:
XOS_CFG_UGRP_NEW: User group creation
XOS_CFG_UGRP_UPD: User group update
XOS_CFG_UGRP_DEL: user group deletion
These messages can be activated from the configuration panel of the modeling server.
When a user is used in production, synchronization is needed in order to propagate information to the
production servers.
Rules
A user group must be associated with at least one profile
More than one profile can be associated with a user group
Including more than one profile in a group creates a virtual profile called main profile that corresponds to
the sum of all the profiles of the group
It is possible to create one or more user groups
It is not possible to delete a user group used by a user
At least one user group must be created in order to use Axway Automator
User
A user group can be associated with a login user. Thus, the user inherits all the rights given to all the profiles
associated with the group.
Note about OPADMIN: The OPADMIN user is a full administrator of Axway Automator and has all rights to
everything. It does not belong to any user group. Change its password (Modeling
server definition panel) and restrict this user usage to maintenance operation.
Each user has a type, either login (can connect to the GUI) or submit (used by the production server to submit
a job).
Users are displayed in the left-hand tree under two nodes, depending on their type: Login or Submit.
Note: When LDAP is enabled, only submission users are displayed.
Context tab
The Inherited context list displays contexts which are defined for the user groups.
The association of contexts to a user primarily makes it possible to restrict that users perimeter of action. Thus,
users can only act on global objects, or on the objects in their contexts.
Any addition of a context makes a larger view of the product available. Conversely, a reduction of context also
reduces the users scope of activity on the product.
Rules
Login user/group association is mandatory.
The user inherits the rights of the user groups.
Any change of group involves a modification of the rights associated with the user.
opscmd API
The opscmd API integrates the concept of safety. When attempting to connect to a production server or
modeling server through the API, the servers are able to detect if the action is protected or allowed.
Principle of operation
A change to the API is not visible. The API uses the user id to check the rights associated with that user.
Before executing, the API connects to the modeling or production server to verify that the user has enough
rights to execute and connect to the API. When the user does not have the rights an error message is
generated.
Field Description
Name Calendar name, up to 32 alphanumeric characters without any
special characters (except , _ and @).
Year Year currently being configured.
Description Freeform text of up to 132 characters.
Carry Forward Specific Days Check this box to automatically integrate specific days in the
calendar when carrying it forward to the following year (refer to
Specific Workday and Specific Holiday).
National State Holidays Check this box to automatically integrate holidays (marked in red)
into the current year, such as January 1, May 1, etc., according to
the country selected from the list above it.
Closed days
To define the same day of the week as a holiday for the whole year (every Saturday for example), check the
day of the week in the Closed days group. You can check several days (every Saturday and Sunday for
example).
This is an additional selection method, which takes into account the days that have already been defined, so
that Monday, January 3 can be considered to be the first day of the month of January 2011.
For example, if the first recurring day is already defined as a holiday, then the following workday is
automatically selected. Likewise, if the last recurring day is already defined as a holiday, the previous workday
is selected.
Introduction to macros
A macro is a stored and named formula.
A formula is used to describe complex scheduling cases and is written in a natural language comprising
keywords and arithmetic operators (+ and -).
To display the corresponding screen:
1. Click the Configuration tab.
2. Select the Macros object in the left pane.
Field Description
Name Macro name, up to 20 characters, without any special characters (except _ and @).
Description Freeform text.
Formula Text expressing the rule.
Keywords
The objects available when defining a macro are lower-case keywords. Accented characters can be used.
Once defined, you can perform a quick real-time test on a scheduling rule for better adjustment.
The Formula Editing tab is used to define more complex scheduling rules.
The objects available when entering the formula are keywords or macros (that have already been defined
refer to Section).
Formula syntax
The formula syntax is as follows:
Lines that begin with the hash symbol (#) are treated as comments.
Parentheses can group comparisons to establish priorities between ANDs and ORs.
The syntax is checked. If the system finds a problem, it displays a window that informs you that the formula
syntax is invalid.
The nm1-12 and pm1-12 periods allows you to select a previous (pm) or coming month (nm).
Examples
test {today=last.day.work.week}
test {today=last.day.work.week - 1.calendar.day}
test {today=last.day.work.week - 1.work}
test {today=first.day.work.month}
test {today=last.day.work.month}
test {today=2.day.work.month}
test {today=2.day.work.month}
test {today=1.day.work.month + 1.work}
test {today=3.day.work.month + 3.day.calendar.- 3.day.work}
test {today=last.day.work.fortnight}
test {today=monday}
test {today=3.friday.work.month}
Date variables
Date variables can be passed to jobs as parameters.
To create a date variable, there must be at least one calendar and one macro.
To display the corresponding screen:
Field Description
Name Resource name, up to 32 characters, without any special characters
(except , _ and @).
Description Freeform text of up to 132 characters.
Schedule Type Schedule button: the schedule date is taken as the reference date.
System button: the system date is taken as the reference date.
Calendar To be selected from a list: name of the calendar, to which the variable applies.
Macros To be selected from a list: name of the macro used.
Format To be selected from a list.
You can do testing to evaluate the variable date.
Global resources
Used in Charts, Resources enable you to:
Determine how applications or jobs are started up
Pass values to the applications or jobs as parameters
There are two types of resource:
Global resources common to all charts
Resources local to a chart
In the Configuration module, only global resources are processed.
The various resources are of the following types:
Numerics
Texts
Weights
FIFO lists
Possibility to duplicate an existing resource to create a new resource.
Numeric resources
This type of resource is used to trigger applications or jobs when the resource has a given numeric value. It is a
text area that only contains digits. The execution criteria are =, <>, >, <, >= and <=.
To display the corresponding screen:
1. Click the Configuration tab.
2. Select the Global Resources object in the left pane.
3. Right-click Numerics.
4. Select New.
Complete the fields on the resulting screen display as follows:
Field Description
Name Resource name, up to 32 characters, without any special characters
(except , _ and @).
Description Freeform text of up to 132 characters.
Value Instant resource value; this information is dynamically updated by the GUI or
online Automator commands.
Text resources
This type of resource is used to trigger applications or jobs when the resource has a given alphanumeric value.
It is only a text area. The criteria are =, <> and an expected value. For example, a job must be performed if
another Automator job has given the OK.
To display the corresponding screen:
1. Click the Configuration tab.
2. Select the Global Resources object in the left pane.
3. Right-click Texts.
4. Select New.
5. Complete the fields on the resulting screen display as follows:
Field Description
Name Resource name, up to 32 characters, without any special characters
(except , _ and @).
Description Freeform text of up to 132 characters.
Value This information is dynamically updated by the GUI or online Automator
commands.
Weight resources
These resources are used to manage job exclusivity or the overall job load.
Example: Four processing operations are to be submitted to a system that can only accept two concurrently.
To display the corresponding screen:
If you create a global production server resource, it is known by all production servers after you have created
an instance on each server. The instance must be created after the resource.
Or, the production server does not know the resources. No instance was created on the production server
since the resource was created.
In this case, an error message is displayed.
To set the value of the resource on a specific production server, open the resource definition on the relevant
server and then modify its value and save. Therefore, the same resource on different production servers can
have different values.
For a global production server resource the FIFO list is limited to 65500 characters.
Multiple-system chart
In the case of multiple-system charts, when you need to evaluate or assign a value to a global production
server resource, all the relevant operations are performed on the main server for the instance (to determine
which is the main server for an instance, request the statuses of the instances in the processing module on the
GUI and then click the Parameters tab). Consequently, when you test a global production server resource, you
are testing the value of the resource on the main production server. Similarly, when you assign a value for a
global production server resource, you are modifying the value of the resource on the main production server.
Chart views
Chart views are full or partial logical groups of all charts, so that users can only work on relevant graphs.
To display the corresponding screen:
Field Description
Name View name, up to 30 alphanumeric characters, without any special characters
(except , _ and @).
Description Freeform text of up to 132 characters.
To add one or more charts to the view:
1. Select the relevant chart(s) in the list on the right.
2. Click the Add button.
To add all graphs, click Add All.
Execution group
The execution group concept is used to dissociate the various execution instances in the same chart.
For example, a user associates all chart or application objects with two execution groups ( Morning and
Evening). The groups were defined when chart execution was requested (instance creation). You can thus
define two actions:
Execute the chart instance with the Morning execution group according to a scheduling rule (everyday)
and with a start time of H1 = 9:00 a.m.
Execute the same chart with the Evening execution group according to the same scheduling rule, but with
a start time of H2 = 8:00 p.m.
Consequently, these actions are used to start all or part of the same chart on the same day, but with two
different execution groups.
Example: A user defines a chart with an execution group object (MONTHLY), which is different from the other
group objects (DAY).
When the action is triggered for the DAY execution group, the chart is executed without the MONTHLY group
object, but once a month, a MONTHLY execution group action processes all the objects (several execution groups
can be assigned to an object).
The execution group concept can therefore be assimilated with the scheduling session concept.
The execution group is represented only by a name and color. It is only significant if associated with the
instances.
To display the corresponding screen, left-click the Configuration tab, right-click the Execution group object in
the left pane. Then select New.
On AS400 systems, the execution group is an important selection criterion for manual job interception.
To intercept manual jobs, you must associate an execution group with each user (name, *ALL) on an AS400
system.
Field Description
Name View name, up to 30 alphanumeric characters, without any special characters (except ,
_ and @).
Description Freeform text of up to 132 characters.
Group Color Color selected for the execution group.
Swatches Choice of colors.
HSB Color shades.
RGB Color shades.