utledigen (Command to export management information)

This command generates an export file for management information that has already been registered.

You can modify the generated export file and re-register it by using the utlediupdt command to import management information.

Table 1.9 Executability of commands

Grade

User type for DataMagic

Business group settings for management information

Access rights

Executability

DataMagic Server

Superuser

-

-

Executable

General user (#1)

Omit specification of rights (#2)

-

Executable

Specify rights

View, View and refresh

Executable

Other than the above

Not executable

DataMagic Desktop

-

-

-

Executable (#3)

#1

:

For the DataMagic Server grade, general users cannot export user information and business group information.

#2

:

Indicates that user rights are not specified for business groups but they will be used as filtering conditions.

#3

:

For the DataMagic Desktop grade, you cannot export user information as well as user information included in business group information because such information does not exist.
Note

  • The password for database connectivity information is output in the form of "PASSWD_ENC, encoded-password". If you are not changing the password by using the utlediupdt command, enter this output as-is.To change the password, use the PASSWD tag to specify the new password in plain text.

  • The password for user information is output in the form of "PASSWD_ENC, encoded-password". If you are not changing the password by using the utlediupdt command, enter this output as-is. To change the password, use the PASSWD tag to specify the new password in plain text.

  • For the DataMagic Server grade, if the user ID of the user who starts DataMagic is "root" (in UNIX) or "SYSTEM" (in Windows), information about the user cannot be exported.

Commands

For the DataMagic Server grade

utledigen -f filename
         [-i {ed [-R]|csv|fmt|mfmt|hfmt|xml|excel|db|dbc|pon|user|group}]
         [-d id[,id2,...]] [-g grpid] [-k {E|S|8}] [-x [-r]] [-m]

For the DataMagic Desktop grade

utledigen -f filename
        [-i {ed [-R]|csv|fmt|mfmt|hfmt|xml|excel|db|dbc|pon|group}]
         [-d id[,id2,...]] [-g grpid] [-k {E|S|8}] [-x [-r]] [-m]

Parameters

-f filename

The export file to be output. (This parameter cannot be omitted.)

-i {ed [-R]|csv|fmt|mfmt|hfmt|xml|excel|db|dbc|pon|user|group}

The management information to be output. (This parameter can be omitted.)

If you omit this parameter, all management information is exported.

ed

: Data processing information

If you add "-R", you will also be able to export all of the related management information.

csv

: CSV information

fmt

: Format information

mfmt

: Multi format information

hfmt

: Hierarchy format information

xml

: XML information

excel

: Excel information

db

: Database table information

dbc

: Database connection information

pon

: Common components information

user

: User information

group

: Business group information

Note

  • For the DataMagic Server grade, "user" and "group" cannot be specified by general users.

  • For the DataMagic Desktop grade, "user" cannot be specified.

  • If you output all of the management information by omitting the -i option, the information is output in the following order:

    1. User information (This is not output in the DataMagic Desktop grade.)

    2. Business group information

    3. Fixed-format information

    4. CSV information

    5. Format information

    6. XML information

    7. Hierarchy format information

    8. Excel information

    9. Database connection information

    10. Database table information

    11. Common components information

    12. Data processing information

-R

Export all of the related management information in batch. (This parameter can be omitted.)

If you specify the -R option when ed (data processing information) is specified for the -i option, the command exports data processing information and the relevant information (that is, layout information and common resource information) in batch.

= Remarks =

Refer to the following examples if you want to specify -R:

  • Example 1: -i ed -R

  • Example 2: -i ed -R -d data-processing-ID

-d id[,id2,...]

The management information ID to be output. (This parameter can be omitted.)

If you omit this parameter, all IDs are applied.

To specify multiple management information entries, specify IDs delimited by commas (,). You can specify up to 100 entries.

You can use an asterisk (*) to specify an ID that begins with, ends with, or contains a particular character string.

Note

If you use an asterisk (*), enclose id in double quotation marks (").

Example: -d "ab*"

-g grpid

Business group ID related to the management information to be output (This parameter can be omitted.)

If you omit this parameter, the management information of all business groups is output.

Note

If you specify "user" or "group" for the management information you want to generate, you cannot specify a business group.

-k {E|S|8}

Encode for the export file (This parameter can be omitted.)

If you omit this parameter, the following value is applied to the processing.

For Windows

: SHIFT-JIS

Note that UTF-8 will be applied if the character code (system locale) in Windows is UTF-8.

For UNIX

: Value of Local host kanji code type (knjcode) in the system environment settings file (huledenv.conf)

-x

This parameter creates the schema or DTD file as a separate file when exporting XML information. (This parameter can be omitted.)

If you omit this parameter, the schema or DTD is imported into the export file in base64 encoding.

= Remarks =

  • Export files created with omission cannot be used for versions earlier than 6.6 of HULFT DataConversion.

  • The XML information of an export file generated without using this parameter does not allow for editing except for "comment" and "ID".

  • We recommend using -x only when you want to edit the generated export file, when you want to use the generated export file for versions earlier than 6.6 of HULFT DataConversion, or when the export file is very large.

  • Using this parameter generates multiple files; therefore, we recommend that you create a work folder prior to executing the command. To register the export file using the command to import management information, all generated files will be necessary.

  • If you omit this parameter, XML validation is not performed.

-r

This parameter overwrites files, when the XML information is exported, if the XML import file name or the file name specified in schemaLocation of import or include already exists in the current folder. (This parameter can be omitted.)

This parameter can only be used if -x is specified.

If you omit this parameter, an error occurs if the above file name already exists.

-m

This parameter appends the management information into an existing export file if the specified export file already exists. (This parameter can be omitted.)

If you omit this parameter, the management information overwrites data in the existing export file.