extract

You can use the extract command to create a text file by copying the item definitions from the database.

Overview

You can configure the command line syntax with different parameters to create specific item definitions. You can either use create or extract to copy the item definitions. You must have display access to the items being copied and modify access, if you want to use the ;lock keyword.

Syntax and command line options

You must provide at least one scheduling or security item and the filename with the command to perform the action. The ;lock parameter is optional.

ocli model create | cr | extract | ext filename from Scheduling or Security item [;lock]

For the list of scheduling or security items that you can use and the required format, see the following tables.

Scheduling and Security items

Table 1. Scheduling items
Scheduling items	Description
`filename`	You must specify a name for the file to which the item definitions are copied.
`calendars \| calendar \| cal [folder/]calname`	You can specify the name of the calendar and optionally, the folder in which the calendar is defined. If you do not specify the `calname`, all the calendar definitions are copied into the file. Wildcard characters are permitted.
`folder \| fol foldername`	You can specify the name of the folder. If you do not provide the `foldername`, all the folder definitions are copied into the file. Wildcard characters are permitted.
`parms \| parm \| variable \| vb [[folder/]tablename.]variablename`	You must provide the `[[folder/]tablename.]variablename` to copy a specific variable within a specific table. If you specify the `variablename` only, the variable definition in the default variable is displayed. If you do not provide the `[[folder/]tablename.]variablename`, all the global variable definitions in the default variable table are copied into the file. Wildcard characters are permitted on both `[folder/]tablename` and `variablename`.
`jobs \| jobdefinition \| jd [[folder/]workstationame#][folder/]jobname`	If you provide a specific `jobname` only that particular job definition is copied and if not, all the job definitions are copied into the file. You can provide `[folder/]workstationame#]` and the folder in which the job is defined to make the selection more specific. Wildcard characters are permitted.
`sched \| jobstream \| js [[folder/]workstationame#][folder/]jstreamname[valid from date\|valid to date \|valid in date date][;full]]`	If you provide a specific `jstreamname` only that particular job stream definition is copied and if not, all the job stream definitions are copied into the file. You can provide `[folder/]workstationame#]` and the folder in which the job stream is defined to make the selection more specific. Wildcard characters are permitted. You can also add the options below to provide more details of the job stream. `Valid from date`: You can specify a date which will restrict the selection of job streams, that have a `valid from` date equal to the value specified. The format is `mm/dd/yyyy`. `Valid to date`: You can specify a date which will restrict the selection of job streams, that have a `valid to` date equal to the value specified. The format is `mm/dd/yyyy`. `valid in date date`: Specify the time frame at which the job is run. You can specify one of the dates as `@`. The format is `mm/dd/yyyy-mm/dd/yyyy`. full: If you add the option, all the job definitions in the job stream are displayed.
`users \| user [[folder/]workstationame#]username [;password]`	You must specify the username from which the user definitions are copied to the file. You can provide `[folder/]workstationame#]` and the folder in which the user is defined, to make the selection more specific. Wildcard characters are permitted. You can use the `;password` option to set a password for the user and if not, the password is set for the user as a sequence of 10 asterisks (*).
`vartable \| vt [folder/]tablename`	You can specify the name of the variable table and optionally, you can provide the folder in which the variable table is defined. If you do not specify the `tablename` and add wildcard characters, all the variable table definitions are copied into the file. Wildcard characters are permitted.
`workstation \| ws \| cpu [folder/]workstationame]`	You can specify the name of the workstation or workstation class or domain and optionally, you can provide the folder in which these items are located. Wildcard characters are permitted.

Table 2. Security items
Security items	Description
`accesscontrollist \| acl foldername\|F+foldername\|A+ADMIN`	If you specify the `foldername\|F+foldername\|A+ADMIN`, the access control list definition for that particular folder is copied and if not, the access control list definitions for all the folders are copied into the file. Wildcard characters are permitted. `foldername\|F+foldername`: You can specify the option if you want to filter out the lists that are associated with a folder. The security roles are valid, only for the items available in the folder. `A+ADMIN`: You can specify this option, if you want to filter out the lists that allows specific permissions on API keys (that are not defined in folders) and on agent registration action.
`securityrole \| srol securityrolename`	If you specify the `securityrolename`, the security role definition for that particular security role is copied and if not, the security role definitions for all the security roles are copied into the file. Wildcard characters are permitted.

;lock

You can use the option to lock the selected items. If the selected items are locked by any other user, you cannot copy the definitions into the file.

Examples

Run the following command to create the file calperm with all calendars defined in the database:
```
ocli model create calperm from calendars=@
```
Run the following command to create the file store with all job streams defined in the database:
```
ocli model cr store from jobstream=@
```
Run the following command to create the file mainvid.txt with the definition of user rorshar of workstation serv2356, including the encrypted password:
```
ocli model extract c:\mainvid.txt from user=serv2356#rorshar;password
```
The contents of file mainvid.txt will be:
```
USERNAME rorshar
  PASSWORD "ENCRYPT:EIu7PP+gvS8="
END
```