Using Import and Export Functions

#### Search Results

Search

# Using Import and Export Functions

This document covers the following topics:

- Accessing Import/Export Functions Online

- Importing Objects

- Exporting Objects

- Retention Period for Import/Export Requests from Entire Operations GUI Client

Importing and exporting objects via Entire Operations is only possible if the Monitor is running. All import and export operations are executed asynchronously.

## Accessing Import/Export Functions Online

To access import/export functions online

1. From the Entire Operations Main Menu, select Import/Export .

   For batch use, see Using Import/Export Functions in Batch Mode.

   An Import/Export Main Menu appears:

        08.06.18           *** Entire Operations Import/Export ***           10:47:35
                                          Main Menu                   User ID SAG
        ------------------------------------------------------------------------------
        Option ==> _

                   1  Import Objects
                   2  Export Objects
                   3  Export whole environment

       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        End

2. Select the required option by entering the corresponding option number in the Option field and pressing ENTER:

   - Import Objects
     Enables you to import definitions from a file which contains data which meet the syntax of the external format (see also Syntax in Import/Export Files and Object Processing Rules) to your Entire Operations database. See Importing Objects.

   - Export Objects
     Exports selected Entire Operations definitions from your database to a file. See Exporting Objects.

   - Export whole environment
     Exports all definition of jobs, networks, nodes, etc., from the Entire Operations database to a file. See Exporting the Whole Environment.

## Importing Objects

This section provides information on the process of importing objects and handling errors.

| Warning: You should use the import function with care. It can delete definitions from or add definitions to your database.

To import objects

1. Enter `1` in the Option field of the Import/Export Main Menu.

   An Import Objects window like the example below opens:

       +--------------------------------------------------+
       |                                                  |
       |            - Import Objects -                    |
       |                                                  |
       |   From:                                          |
       |   Location     ==> NAT                           |
       |   NAT Library  ==> ________                      |
       |   NAT Member   ==> ________ (Prefix)             |
       |   Initial Mode ==> A                             |
       |                                                  |
       |   Owner        ==> __________                    |
       |   Network      ==> __________                    |
       |   Job          ==> __________                    |
       |                                                  |
       |     Stop after ==> 5____ errors                  |
       |             or ==> 10___ warnings                |
       |    Keyword Gap ==> 5____ lines                   |
       |                                                  |
       |   Display parsing information ==> N              |
       |                                                  |
       | Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7--- |
       |       Help        End         Imprt              |
       +--------------------------------------------------+

   The values you enter in this window determine the conditions for the import process.

   The fields contained in the window are described in Fields and Options: Import Objects Window.

2. Choose PF3 (End) to cancel the import.

3. Choose PF5 (Imprt) to perform the import.

   The data collected for the selected object is output in the specified import file or Natural object. For the information provided during the import process and possible error handling, see Import Process Information and Handling Import Errors.

   The syntax that applies to the entries in the output file (or object) is explained in Syntax in Import/Export Files and Object Processing Rules.

This section covers the following topics:

- Import Process Information

- Fields and Options: Import Objects Window

- Handling Import Errors

- Repeating a Failed Import

### Import Process Information

During the import, a window opens which informs you about the imported objects.

This window displays number, name and type of the imported object, the mode which was used for this object, the amount of lines the object had, the time needed to import the object, the status (accepted or failed), name of error object (if the object was rejected).

Additionally, the total elapsed time, total number of lines, total number of errors/warnings occurred is shown in the window. This window shows only least information about the last ten processed objects. The screen scrolls automatically forward.

Do not press a key while the import is running. When the import is finished, a message appears which informs you whether the import ended successfully.

The import ended successfully if all objects were processed and the error/warning limit was not exceeded. If this was not the case, the import was cancelled due to too many errors or warnings.

### Fields and Options: Import Objects Window

The fields and options provided in the Import Objects window are described in the following table.

All values entered in this window are checked for their validity. If a Natural object is specified as import file, the file existence is also checked.

Field | Description
--- | ---
Location | The location of the file to be imported. Enter one of the following values:
`NAT` | Import from a Natural text object. See also the fields Library and NAT Member (Prefix).
`PC` | Import from a PC file. Entire Connection must be installed, and the desired PC file must be assigned to Work File 7.
`WRK` | Import from work file. Work File 1 is used.
NAT Library | Only for `NAT` locations. Leave this field blank if the location is not `NAT`. Enter the name of the library, where the Natural objects reside.
NAT Member (Prefix) | Only for `NAT` locations. Leave this field blank if the location is not `NAT`. Enter the prefix (maximum is 5 characters) of the names of the objects to be imported or enter the name of a rejected object (`ERR-nnnn`, see also Handling Import Errors). For explanations of prefix, see the description of the NAT Member Prefix field used for the export operation.
Initial Mode | The mode to be used when starting to import the object definitions contained in the file to the Entire Operations database. The mode can change during import if the file contains mode commands. Enter one of the following values:
`C` | Check syntax of objects.
`A` | Add objects to the database (default).
`U` | Update objects on the database.
`R` | Replace objects on the database or add them if they do not exist.
`D` | Delete object from the database.
Owner Network Job | These fields can be used to define a range of objects to be imported from the import file.
Enter the required owner, network and job. If you use a wildcard (`*`), no selection is made, but a range is specified. For example, enter `TEST*` to specify the range `TEST` through `TESTZZZZZZ`. Notes: A selection on a lower level is accepted only if exactly one object is selected on the higher level (i.e. if you have not already used a wildcard). Selections cannot be verified against the target database, since they usually do not exist there. If nothing can be imported, check your selections. The selection is valid for all objects in the import file which contain Owner, Network and Job within their key fields.
Stop after ... errors | Enter the number of errors which can occur before terminating the import process. Valid range: 1 to 99999. Default: 5.
or ... warnings | Enter number of warnings which can occur before terminating the import process. Valid range: 1 to 99999. Default: 10.
Keyword Gap | Enter the number of lines, within which the next keyword is expected.
Display parsing information | If you enter `Y` here, a window appears during the import process, which informs you about the current object type, name of object, parsed keyword, value, format, length and line. If you enter `N`, the window simply displays:
    Please wait
The import process is much faster with `N`.

### Handling Import Errors

If at least one error occurs within the object, the whole object is rejected. Errors and warnings are counted for single objects during the import. If the error or warning limit is reached, the whole import is cancelled.

Whenever an object is rejected, it is saved with the prefix `ERR-` and an ascending number (`ERR-0001`, `ERR-0002`, and so on) in the library specified for the import operation. These objects contain the rejected object and the errors which caused the rejection. The error text is written directly above the line which contains the error.

Note
You must specify a Natural library name for storing these objects. Otherwise, errors are only protocolled in the job log.

In addition, a header is written to the object informing you about the:

- Number of errors or warnings in this object;

- User who started the import;

- Date and time when the object was rejected.

  (See also Date and Time Formats in the User's Guide.)

You can edit these error objects manually and import them again.

Possible error causes and advice about fixing errors are described in the following section.

> Error Severity

>   There are three levels of error severity:

>   - Warnings
>     Warnings are displayed, but do not cause the rejection of the object.

>   - Errors
>     Errors cause rejection of the object but do not cause termination of the import. Import continues with the next object within the file, if the error/warning limit has not been reached.

>   - Fatal Errors
>     Fatal errors are serious problems which cannot be ignored and cause immediate termination of the import. A fatal error occurs, for example, when it is impossible for the parser to continue at a new point.

> Causes of Errors - Syntax

>   If errors or warnings occur during import, some of the possible causes could be syntax errors, for example:

>   - A value has invalid format.

>   - A character in a numeric field.

>   - A keyword was invalid or non-existing.

>   - The value of a field exceeds valid length.

>   - A non-existing object type was specified.

>   These errors should not occur when importing an unchanged exported object. If you edit the exported object online or create a new object manually, these errors could occur.

> Causes of Errors - Logical Errors

>   If errors or warnings occur during import, some of the possible causes could be logical errors, for example:

>   - Value has correct syntax but does not meet the requirements of Entire Operations.

>   - A Job type is specified, which is not allowed in Entire Operations.

>   - The field has a special range (e.g. only `Y` or `N`).

>   - Adding an object to Entire Operations which already exists.

>   - Deleting a non-existing object.

### Repeating a Failed Import

To repeat a failed import operation

1. Correct all erroneous `ERR-` objects as described in the previous section.

2. If the settings from the import window are not suitable, specify the desired import mode in the first line of the first error object.

3. Start a new import as described in Importing Objects with the location `NAT` (Natural source) for all objects prefixed with `ERR-`.

## Exporting Objects

This section explains the export of objects and their key fields.

Exporting an object can invoke the transformation of records from the Entire Operations database into an external format.

This section covers the following topics:

- Exporting Single Objects

- Exporting the Whole Environment

- Export Process Information

- Fields and Options: Export Objects Window

- Object Types to be Exported: Key Fields of the Objects

- Using Wildcards

### Exporting Single Objects

To export single objects

1. Enter `2` in the Option field of the Import/Export Main Menu and press ENTER.

   A Select Export Target Version window prompts you to enter the export target version:

        08.06.18           *** Entire Operations Import/Export ***           10:47:35
                                          Main Menu                   User ID SAG
        -------------------- +--------------------------------------------------+ ----
        Option ==> 2         |                                                  |
                             |        Select Export Target Version              |
                             |                                                  |
                   1  Import |   Current Version ==> 5.5.1                      |
                   2  Export |                                                  |
                   3  Export |   Target  Version ==> 5.5.1_______________       |
                             |                                                  |
                             |   A + behind the current version means           |
                             |   that the current version was updated           |
                             |   by further corrections.                        |
                             |                                                  |
                             |                                                  |
                             |                                                  |
                             |                                                  |
                             | Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7--- |
                             |       Help        End         Apply              |
                             +--------------------------------------------------+

       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        End

   Enter the required target version: see Target and Current Versions.

   After this, choose PF5 to continue.

2. The Export Objects screen appears:

        08.06.18           *** Entire Operations Import/Export ***           10:53:23
                                         Export Objects               User ID SAG
        ------------------------------------------------------------------------------

                          Please select object type to be exported:

             1 NETWORK-MASTER                   11 MAILBOX-DEFINITION
             2 NETWORK-VERSION-USAGE            12 MAILBOX-ENTRY
             3 JOB-MASTER                       13 NODE-DEFINITION
             4 GLOBAL-EXIT                      14 RESOURCE-DEFINITION
             5 EOJ-CHECK-MASTER                 15 USER-DEFINITION
             6 DESCRIPTION                      16 DEFAULTS
             7 SCHEDULE                         17 OWNER
             8 CALENDAR                         18 CONDITION-ACTIVE
             9 TO-ACTIVATE                      19 RESOURCE-PREREQ
            10 SYMBOL-MASTER                    20 SYMBOL-VERSION-USAGE
                                    Your Selection ===> __

       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        End

   Select the desired object type by entering the appropriate number in the field after Your Selection ===>.

3. Press ENTER.

   An Export Objects window like the example below opens:

       +-------------------------------------------------------+
       |                                                       |
       |                    - Export Object -                  |
       |   Origin Version    ==> 5.5.1.1                       |
       |   Object Type       ==> NETWORK-MASTER                |
       |   Owner             ==> __________                    |
       |   Network           ==> __________                    |
       |   Version           ==> __________                    |
       |                                                       |
       |                                                       |
       |                                                       |
       |   Target Version    ==> 5.5.1.1                       |
       |   Location          ==> NAT                           |
       |   NAT Library       ==> ________                      |
       |   NAT Member Prefix ==> _____                         |
       |   Export Mode       ==> N      (A,N,R)                |
       |   Passwords         ==> N      (Y,N)                  |
       |   with Schedules    ==> N      (Y,N)                  |
       |   with Calendars    ==> N      (Y,N)                  |
       |   with Symbols      ==> N      (Y,N)                  |
       |   with Grants       ==> N      (Y,N)                  |
       | Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8-- |
       |       Help        End         Exprt                   |
       +-------------------------------------------------------+

   The data collected for the selected object is output in the specified export file or Natural object. For the information provided during the export process, see Export Process Information.

   The syntax that applies to the entries in the output file (or object) is explained in Syntax in Import/Export Files and Object Processing Rules.

### Exporting the Whole Environment

Note
If your Entire Operations system contains a large amount of data, you should invoke the Export whole environment function in batch mode. For more information, see Using Import/Export Functions in Batch Mode.

To export the whole environment

1. Enter `3` in the Option field of the Import/Export Main Menu and press `ENTER`.

   A Select Export Target Version window described earlier prompts you for a target version.

2. Enter the required target version and choose PF5 to continue.

   An Export whole environment window like the example below opens:

       +---------------------------------------------+
       |                                             |
       |         - Export whole environment -        |
       |                                             |
       |   Origin Version    ==> 5.5.1.1             |
       |                                             |
       |   Target Version    ==> 5.5.1.1             |
       |   Location          ==> NAT                 |
       |   NAT Library       ==> ________            |
       |   Nat Member Prefix ==> _____               |
       |   Export Mode       ==> N      (A,N,R)      |
       |   Passwords         ==> N      (Y,N)        |
       |   with Schedules    ==> Y      (Y,N)        |
       |   with Calendars    ==> N      (Y,N)        |
       |   with Symbols      ==> N      (Y,N)        |
       |   with Grants       ==> _      (Y,N)        |
       | Enter-PF1---PF2---PF3---PF4---PF5---PF6---P |
       |       Help        End         Exprt         |
       +---------------------------------------------+

3. Enter the required definitions.

   The input fields are described in Fields and Options: Export Objects Window. The To fields are the same. The From fields are omitted.

4. When you are finished press ENTER or choose PF5 (Exprt).

   The data collected for the selected environment is output in the specified export file or Natural object. For the information provided during the export process, see Export Process Information.

   The syntax that applies to the entries in the output file (or object) is explained in the remainder of this chapter.

### Export Process Information

During the export, a window opens which informs you about the currently exported object.

This window displays the name and type of the exported object, the number of lines contained in the object has and the total number of lines written during the export run.

Important
Do not press a key while the export is running.

When the export has finished, a message appears on the screen which informs you about the way the export ended. This information is also written to the export object, so that you can check whether or not all specified objects were written. For some reasons, the export process could terminate abnormally. This could happen, for example, if you attempt to write more than 999 objects.

### Fields and Options: Export Objects Window

The fields and options provided in the Export Objects or Export whole environment window are described in the following table.

Field/Option | Description
--- | ---
From:
Origin Version | Current Entire Operations version from which the objects are exported.
Object type | Object type to be exported. See also Object Type to be Exported: Key Fields of the Objects.
... | The remaining From fields differ according to the object type selected.
To:
Location | Location of the export file to be created. Enter one of the following values:
`NAT` | Export to a Natural text object. See also the fields Library and NAT Member Prefix.
`PC` | Export to a PC file. Entire Connection must be installed and the desired PC file must be assigned to Work File 7.
`WRK` | Export to Natural work file. Work File 1 must be defined.
Notes: The work file format must be the same as for Natural INPL utility. The work file will be written using variable record format.
NAT Library | Only for `NAT` locations. Leave this field blank if the location is not `NAT`. Enter the name of the library that contains the Natural text object used for the export operation.
NAT Member Prefix | Only for `NAT` locations. Leave this field blank if the location is not `NAT`. Enter the prefix (maximum is 5 alphanumeric characters) of the Natural text object(s) that are to store the export data. The prefix is padded with hyphens (`-`) to its maximum length of 5 character. For example, the prefix entry `PRE` is converted to `PRE--`, `PREF` to `PREF-`. The prefix is followed by a 3-digit number, for example, `PREF-001`. One or more text objects with the specified prefix are created depending on the amount of data to be exported. For example: The prefix `PREF` can comprise text objects with the names `PREF-001`, `PREF-002` and `PREF—003`.
Export Mode | Only for `NAT` locations. Determine how to handle the export data contained in the Natural text object(s) specified with the prefix in the NAT Member Prefix field. Possible values are:
`A` | Enter this value to append the data to be exported to the specified text object. Text object with the specified prefix must exist.
`N` | Enter this value to save the data in a new text object. If a text object with the specified prefix already exists, an appropriate message is returned. This is the default setting.
`R` | Enter this value to replace the data in the specified text object.
Passwords | Only for object types which contain passwords (e.g., password of a protected data set). Enter one of the following values:
`Y` | Export passwords.
`N` | Do not export passwords.
with Schedules | If you also export the schedules, the imported networks will get the same schedule definitions as the exported networks. (They can be modified after the import.) Enter one of the following values:
`Y` | Export schedules (default).
`N` | Do not export schedules.
with Calendars | If you export object(s) with calendars, all referenced calendars will be exported after objects, each calendar once. Enter one of the following values:
`Y` | Export calendars.
`N` | Do not export calendars (default).
with Symbols | If you export object(s) with symbols, all referenced symbol tables will be exported after objects, each symbol table once. Enter one of the following values:
`Y` | Export symbols.
`N` | Do not export symbols (default).
with Grants | If you export networks, you can determine whether access rights granted to users/owners in the source environment are also exported. Enter one of the following values:
`Y` | Export granted access rights.
`N` | Do not export granted access rights (default).

> Target and Current Versions

>   The version in the Target Version and Current Version fields of the Select Export Target Version window have the format `v.r.s.pp`, where:

>   `v.r.s` or `v.r.s.` | Valid Entire Operations version. `v.r.s.` is the correct format if the version is followed by a cumulative fix number (`pp`), for example: 5.5.1.1
>   `pp` | One- to two-digit cumulative fix number (if available). Leading zeros are suppressed.

>   Valid input values for Target Version are from 5.1.1.14 to the current (or next) `v.r.s.pp` version. The highest allowed value is preset as default.

>   You can enter an asterisk (`*`) in the Target Version field to select value from the list.

>   The Current Version read-only field indicates the Entire Operations version installed in your current environment.

>   About the current version:

>   If there is a correction in export/import that brings at least one new keyword and the current Entire Operations version is `5.5.5.1`, for example, then export will show the current version as `5.5.1.1+`. This is to show that there may be problems when importing to pure version `5.5.1.1`. If you specify the target version as `5.5.5.2`, export will run with all new keywords. If you specify the target version as `5.5.5.1`, then new keywords will not appear in the export file but some data loss may occur if new definitions/settings are in use because the export will convert them to an older version.

>   When a service pack (cumulative fix) is completed, the plus sign (`+`) is eliminated, and the import/export version will be brought to the same level as the rest of Entire Operations.

### Object Types to be Exported: Key Fields of the Objects

The key fields you must specify for any `object-type` you want to export are described in the following table.

The object types listed in the following table are used in an import or export file. They correspond to the object types you can select from the Export Objects screen.

Object Type | Key Field 1 | Key Field 2 | Key Field 3 | Key Field 4 | Remark
--- | --- | --- | --- | --- | ---
OWNER | Owner |  |  |  | This exports all objects which belong to a specific owner.
NETWORK-MASTER | Owner | Network | Version |  |
NETWORK-VERSION-USAGE | Owner | Network |  |  |
JOB-MASTER | Owner | Network | Version | Job |
EOJ-CHECK-MASTER | Owner | Network | Version | Job |
DESCRIPTION | Owner | Network | Version | Job | A hyphen (`-`) used instead of a job name exports the description of the network.
SCHEDULE | Owner | Schedule |  |  | Schedule = Network
CALENDAR | Owner | Calendar |  |  |
TO-ACTIVATE | Owner | Network | Version | Job | Job is optional.
SYMBOL-MASTER | Owner | Symbol table |  |  |
SYMBOL-VERSION-USAGE | Owner | Symbol table |  |  |
MAILBOX-DEFINITION | Mailbox |  |  |  |
MAILBOX-ENTRY | Mailbox |  |  |  |
NODE-DEFINITION | Node |  |  |  |
RESOURCE-DEFINITION | Resource |  |  |  |
RESOURCE-PREREQ | Owner | Network | Version | Job |
USER-DEFINITION | User ID |  |  |  |
DEFAULTS | Library |  |  |  |
CONDITION-ACTIVE | Owner | Network | Version |  | The export will be performed for all active runs of the condition.
GLOBAL-EXIT |  |  |  |  | All global exits will be exported.

### Using Wildcards

Depending on the object type you have selected, you must fill in related key fields as required (see also Object Type to be Exported: Key Fields of the Objects). If you are going to import from a source location which was previously written by an export process of Entire Operations, these fields have been filled in correctly.

For the fields Owner, Network and Job, you can enter an asterisk (`*`) in one of these fields and press ENTER to open a window from which you can select an object from a supplied list.

For all other fields, you can use an asterisk (`*`) as a wildcard to delimit the range of objects to be exported. For example, if you enter `WILD*` in the Job field of the object type `JOB-MASTER` and press ENTER, the jobs WILD, WILDxxxx, WILD-1, and so on are exported. If you enter `*` in all selection fields, all objects of this object type are exported.

For some object types some descriptors are optional. If you do not wish to use an optional field, enter a hyphen (`-`) to ignore it. For example: a job or a network can have a `DESCRIPTION`.

To export the DESCRIPTION of a network only

1. Enter Owner and Network name and enter a hyphen (`-`) for Job name. All values entered are checked for their validity.

2. Choose PF3 to cancel the export.

3. Choose PF5 to perform the export.

   Note
   All objects that are related to the selected objects (see the section Hierarchical Order for Object Processing) are also exported.

## Retention Period for Import/Export Requests from Entire Operations GUI Client

Data generated for import and export requests from Entire Operations GUI Client is retained for the number of days specified for active jobs in the Retention Periods of the Entire Operations default settings (see Default Setting (1) in the Administration documentation).

Older import and export requests listed in the Reporting window of Entire Operations GUI Client are automatically removed after this period or during the next database cleanup (see also the Administration documentation).

### On this page

- Accessing Import/Export Functions Online
- Importing Objects
- Exporting Objects
- Retention Period for Import/Export Requests from Entire Operations GUI Client