Chat now with support
Chat with Support

Stat 6.3 - System Administration Guide

Overview of Stat Administration Administrative Utilities Stat Security General Maintenance Tables
System Maintenance Service Domain Maintenance Department Maintenance Issue Tracking Maintenance Country Maintenance Customer Maintenance Object Type Maintenance PeopleSoft Environment Connection Maintenance Pre/Post Migration Steps Parameters Oracle Applications Configuration Oracle Applications Connection Maintenance Generic Application Connection Maintenance Schema Object Parameters Maintenance Data Object Maintenance PeopleSoft Search Configurations Stat Report Definition Maintenance Version Control Management Connection Maintenance
Service Domain-Specific Maintenance Configuring the Stat Central Agent Email Configuration Object Security Appendix: Sample Service Domain Configuration Appendix: User Class Rights Appendix: Creating a Staging Database Appendix: Database Tuning Appendix: Oracle Applications File Type Directory Appendix: Ports and Firewalls Appendix: REST Web Services API Appendix: SOAP-Based Web Services API Appendix: Troubleshooting Chart Appendix: stat.conf Configuration Appendix: Custom Report Files

Defining a Custom Command

You can define custom commands for pre and post migration steps. These are operating system commands executed by the Stat Central Agent. Commands can be executed locally where the Central Agent is running or remotely on a migration target server via SSH. All drive mappings and file paths are relative to the server where the Central Agent is running. Commands can be triggered automatically during the migration or manually by the migrator.

To define a custom command:
1
In the Pre and Post Migration Step Maintenance window, click New and specify the object class and object type of the step you want to create.
2
Select the type of executed step: Pre or Post.
3
In the Migration Step drop-down list, select Custom Command.
4
Select Auto if you want the step to trigger automatically.
5
Specify a name for the step in the Description field.
6
Select Object Class and Object Type.
7
Select Default Run Order. The step execution order can be changed later during migration initialization.
8
(Optional) Add Target Environment to trigger a migration step for a specific environment.
9
Click Apply to save your work.
10
Click Define Command.
Stat opens the Pre/Post Migration Step Command Editor window.
Pre and Post migration steps can be run locally on the Stat Central Agent machine. Some steps can also be configured to run remotely via an SSH connection.
•
For PeopleSoft and Generic file objects, the step can be run on all defined file locations or on the default file location.
•
For Oracle E-Business objects, the step can be run on all target servers. Note, for each Server, the file server entry has to be defined in Object Type - Server.
Note that in order to run the step remotely, SSH must be configured for the target server.
When defining a command, you can include predefined parameters as well as user and server-based parameters that have been defined in Stat. This provides a convenient way to specify values commonly invoked by operating system commands, such as server names and download directories. In addition, parameters offer a way to secure sensitive information by encrypting values that you do not want visible to users such as passwords.
Predefined parameters specify values used to login into an environment during a migration (database name, user name and password) or to invoke Stat web services (service domain and CSR ID). User and server-based parameters, on the other hand, generally invoke values associated with the users and file servers defined in Stat. Also, certain parameters may be defined so that their values are different depending on which user or server they are being applied to. For more information, see the section, Pre/Post Migration Steps Parameters .
* 
NOTE: In the case of Oracle-based environments, predefined parameters also include host name, service name, DB listener port, and TNS entry, and for Oracle Applications environments, APPL_SYS_USERNAME and APPL_SYS_PASSWORD.
11
In the Command field, enter the command you want Stat to run.
If you want to include parameters in the definition of the command, click the location in the command line where you want to insert the parameter. Then select parameter type and double-click the parameter you want to insert. When included in a command, the parameter name is enclosed by two percent symbols (%%), for example, “%%GL_PWD%%.”
Certain users and file servers may have parameters that have been defined specifically for them, or the value of a particular parameter may be different depending on which user or server it is being applied to. When the Stat Command Editor is first opened, the parameters are listed as they have been defined for the local client server and the current user. If you want to include parameters defined for a different server, click the Server defined option. Click the User defined option to insert a user-specific parameter.
12
Stat includes a predefined TARGET_OBJECT_NAME parameter that you can use in custom run commands for objects. When this parameter is present in a command, the step will be executed as many times as the number of migrated objects of that type.
13
To run multiple commands on Unix, separate the commands with a semicolon. To run multiple commands on Windows, separate the commands with “&&”. To run commands on Windows, use “cmd /c” before the command.
14
If the command is still running when the connection times out, no log is attached to Stat. However, you can adjust the 5 second default SSH connection timeout setting. A longer connection timeout setting allows the SSH session to stay connected the entire time the command is being processed, in which case the SSH session log will be attached to Stat.
15
(Optional) In the SSH time-out in seconds field, specify a longer connection timeout amount.
16
(Optional) Specify the command return code condition on which migration will be stopped. When a pre-migration step completes with an error, the entire migration will halt with status “Waiting for Pre-Step.” When a post-migration step completes with an error, then migration will halt with status “Waiting for Post-Step.” To continue migration, a migrator can manually trigger that step or change the status of that step to Completed or Canceled.
17
In addition to predefined list of parameters you can use Date/Time parameters
Table 1. List of predefined Date/Time parameters
Parameter
Description
Example

%%yyyy%%

Year

2020

%%yy%%

Year

20

%%MM%%

Month in year

12

%%MMM%%

Month in year

Dec

%%MMMMM%%

Month in year

December

%%dd%%

Day in month

31

%%EEE%%

Day name in week

Tue

%%HH%%

Hour in day

10

%%mm%%

Minute in hour

35

%%ss%%

Second in minute

47

18
Click Apply.

Release Management Maintenance

The Release Management Maintenance table defines major and minor release labels that users can assign to archive sets. This gives users the ability to upgrade their applications or roll back to previous versions by mass migrating archive sets based on application release number. For more information on mass migrating archive sets based on application release labels, see the “Object Migrations” sections in the change management chapters of the Stat User Guide.

Application releases are based on a branching concept by which minor releases reference their immediate parent releases. This way, when a user mass migrates archive sets based on a minor release label, for example, 2.1, any archive set assigned its parent release label, 2.0, are migrated as well.

Application release security is controlled by the following user class rights:

•
Application Releases - Add
•
Application Releases - Edit

The Release Management Maintenance table is displayed in a standard maintenance window. To open this window, select Maintenance | Domain-Specific | Release Management.

Application release numbers are specific to service domain and change management module.

Value
Description

Release Level
(Key Value)

A tree view displaying major and minor releases

Active

If selected, activates the value in Stat

Release Name

Name assigned to the release number

Last Update
(Read Only)

The date and time that this record was last updated

Update By
(Read Only)

The user who last updated this record

To define an application release number:
1
In the Domain field, select the service domain.
2
In the Module field, select the change management module.
3
Do one of the following:
•
To define a new major release number, click New Major.
Stat adds a folder icon to the Release Level view on the left side on the maintenance table window.
•
To define a minor release number, select the major release you want and click New Minor.
Stat adds a subfolder icon beneath the release number icon you selected. You can define minor releases of minor releases.
* 
NOTE: When assigning a release label to an archive set, Stat concatenates the name of a minor release with the name of its parent releases, separated by decimal points. For example, if you name a minor release “2”, and its parent major release “1”, Stat displays the value as “1.2” when assigning an archive set a release label. This is also true for minor releases of minor releases.
4
Enter a name for the release.
Typically application releases use a sequence of ordinal numbers, such as 1, 2, and so on. However, you can name the release anything you want.
* 
NOTE: You can use the same name for a major and a minor release, but you cannot use the same name for two releases defined on the same level. This includes names that use leading or trailing spaces.
5
(Optional) If you want to delete the release numbers you just defined, click Reset.
6
Click Apply or OK.

Template Maintenance

Template Maintenance tables define text templates that are placed in the Description and Resolution tabs of a CSR. Templates are triggered by CSR type and application codes. When a user working on a CSR selects a type or application associated with a template, Stat automatically inserts that template into the text field of the tab that it has been defined for. You can define a separate template for each application and CSR type in a service domain. If a template exists for both the selected CSR type and application, Stat displays the type template above the application template.

Although templates are optional, they are strongly recommended to get the most out of your Stat system.

Template security is controlled by the following user class rights:

•
Templates - Add
•
Templates - Edit

The Application Template Maintenance table is displayed in a standard maintenance window. To open this window, select Maintenance | Domain-Specific | Templates for Description/Resolution | Application Templates.

The CSR Type Template Maintenance table is displayed in a standard maintenance window. To open this window, select Maintenance | Domain-Specific | Templates for Description/Resolution | CSR Type Templates.

The following table defines the fields (columns) in the both the Application Template Maintenance window and the CSR Type Template Maintenance window.

Value
Description

Active

If selected, activates the value in stat

Application/
CSR Type
(Key Value)

The application or CSR type that the template is based on

Type
(Key Value)

Determines whether the template is to be used in either the Description or Resolution tab

Description

A 1-35 character description of the template

Last Update
(Read Only)

The date and time that this record was last updated

Update By
(Read Only)

The user that last updated this record

The Edit Template Window

After you have defined a new template record, click Apply to save your work. Then click Template.... Stat opens the Edit Template window. Here you can specify the information that a user is required or recommended to enter in the Description or Resolution tab of a CSR. The Edit Template window features the same rich text editing capabilities supported in the Description and Resolution tabs, including a Formatting toolbar. For more information on rich text editing, see the Stat User Guide, Chapter 3, “Change/Service Requests.”

To create a template, type a short description of each piece of information that the user is required or recommended to enter. For required information, use double angle brackets: <<>>. In the example above, the sample template specifies recommended information, including User ID and Description of the Request.

After defining the template, click OK or Apply to save your work.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating