-arccats "cats"
-arccategories "cats"
|
Sets the archive document category indexes for document writing. There can be any number of semi-colon delimited categories, with each category supporting up to three pipe-delimited levels. Each level can be up to 20 characters long. A different character than the pipe can be use by specifying a –arcsep option. Generally this option must be enclosed in quotes to protect semi-colons, pipes, and spaces in the command line. The format structure is this:
"cat1.1|cat1.2|cat1.3;cat2;cat3.1|cat3.2;..."
|
-arccount n
|
Specifies the maximum number of records to return in some -arclist* options. Useful along with -arcfirst to return pages of information to scripts.
|
-arcdel
|
Triggers removal of an archive image or document, honoring the options for -arclib, -arcdoctype, -arcdocid, -arcsubid. Delete access to the library is required for the –arclogin user. If a –arcsubid is supplied, then just that image is removed. If no –arcsubid is supplied, then the document record and all sub-images are removed.
|
-arcdocdata "name=value"
|
Sets a name-value pair for updating doc data values, or for searching. Multiple pairs can be separated by semicolons, or multiple -arcdocdata options can be specified.
|
-arcdocid "docID"
|
Sets the archive document ID for document writing or retrieval.
|
-arcdoctype "doctype"
|
Sets the archive document type for document writing or retrieval.
|
-arcdtm "ymddate"
-arcdate "ymddate"
|
Sets the archive document date for document writing to the date specified. Normally this value is calculated automatically. The date supplied must be in the format yyyymmddhhmmss, with the first 8 characters required.
|
-arcdtmupdated "ymddate"
-arcdateupdated "ymddate"
|
Used with the –arcsearch command to filter the date/time updated. Setting this does not affect the date updated stamp when writing archive records.
|
-arcend "end"
|
Specifies an ending point for –arclist and –arclistdocs options, allowing for a range a range of documents to be returned. The ending point should logically be associated with the order specified in the –arcorder option. If the order is "category", then end can contain pipe separators to indicate category level breaks. If the order is "docdata", then a docdata name can be supplied.
|
-arcentityid "entityid"
-arcentid "entityid"
|
Sets the entity ID for document writing, either the default for UnForm jobs or the value for direct (-arcput) document writing.
|
-arcexists
|
Returns a 1 (found) or 0 (not found) plus a CRLF to the output device, typically –o client:filename, based on testing the existence of -arclib, -arcdoctype, -arcdocid, and –arcsubid options. This option does not require a login. The number of options supplied determines the test performed, from simply testing for library existence, to looking for any documents of a specified document type, to testing for a specific document ID, then finally image sub ID.
|
-arcfilter "filter"
|
Specifies a filter string to apply to the –arclist and –arclistdocs options. This filter applies to all elements of the document, including title, keywords, and categories. If the filter starts with a tilde (~), the remaining characters are interpreted as a regular expression. Otherwise, wildcard characters * and ? are supported for matching any characters or any single character.
|
-arcfirst n
|
Used by certain -arclist* options, typically along with -arccount, to return a portion of results. Useful when designing scripts to return pages of information.
|
-arcflowid "flowid"
|
Can be specified during a -arcput operation, so that after the image has been added to the library, a DocFlow is started in the specified flow ID.
|
-arcget
|
Triggers retrieval of an archive image, honoring the options for -arclib, -arcdoctype, -arcdocid, -arcsubid, and -o. Read access to the library is required for the –arclogin user.
|
-arcimport "from lib"
|
Used to import a library from a previous version of UnForm, or an sdStor library.
|
-arckeywords "kwds"
|
Sets the archive document keywords for document writing. There can be any number of semi-colon delimited list of words or phrases. If none is set, then documents inserted by UnForm jobs (as opposed to those written via a –arcput option) will have a configurable number of unique keywords generated automatically from input file content. Generally this option must be enclosed in quotes to protect semi-colons and spaces in the command line. The format structure is this:
"kw1;kw2;..."
|
-arclib "libpath"
|
Sets the archive library path for document writing or retrieval.
|
-arclink "links"
-arclinks "links"
|
Sets the archive document links, which is a semi-colon delimited list of links to web documents, either external or other archive documents. Each link in the list can be in one of the following formats:
•A full URL, optionally matching a URL used to load a document or image from a library, or a URL to an outside page or document. This structure, if it begins with http:// or ftp://, can be prefixed with a title in the format of title=URL. If the title is specified, that becomes the visible link in the browser.
•A simplified pipe-delimited structure of library|doctype|docid[|subid], which is displayed in the browser interface as a URL link to the document or image named by library, document type, document ID, and optionally image sub ID.
There can be any number of links in the list.
|
-arclist
|
Triggers a listing of archives, honoring the options for –arclib, -arclistfmt, -arcorder, -arcstart, -arcend, and -arcfilter. This listing displays the document archives, but not the image sub ID’s. Use the -arclistdocs for this additional information. The -o option can be used to send the results to a file.
|
-arclistcats
|
List category segments in a library, honoring the -arcstart option to provide segment seeds, and -arcfirst and -arccount options to limit results.
|
-arclistdocs
|
Triggers a listing of archives and image sub ID’s, honoring the options for -arclib, -arclistfmt, -arcorder, -arcstart, -arcend, and -arcfilter. This listing displays the document archives plus their associated images. The -o option can be used to send the results to a file.
|
-arclistkeywords
|
Lists keywords in the library, honoring -arcstart to start the list at a certain position, and the -arcfirst and -arccount options to limit results.
|
-arclistkeywordseeds
|
Lists keyword segments, such as those starting with "a" or "ab", honoring the -arcstart option to specify the starting prefix, and the -arcfirst and -arccount options to limit results.
|
-arclisttypes
|
Triggers a listing of document types in the library specified with an associated –arclib option. The –o option can be used to send the results to a file. A -arclogin is typically required. The listing is a single text column of values, one document type per line.
|
-arclistfmt fmt
|
Sets the format for -arclist and -arclistdocs. It must be one of the following: tab, csv, pipe, html[:stylesheet], or xml|xmlf[:stylesheet].
If the format is xml, a XSLT stylesheet can be referenced by URL with a colon suffix: "xml:http://somewhere.com/stylesheets/mystyle.xsl". Likewise, if the format is html, a CSS stylesheet URL can be referenced with a colon suffix: "html:http://somewhere.com/default.css". An alternate format, "xmlw3c:stylesheet" can be used to generate the header type= tag as "application/xsl" rather than "text/xsl".
If stylesheets are specified, the application that views are parses the document must have access to the specified stylesheet.
If the format is xmlf, then a base64-encoded version of the image file is included with the xml output.
|
-arclistlibs
-arclistrwlibs
-arclistrwdlibs
|
Triggers a listing of libraries, including path, description, creation date, and default permissions. This list returns libraries that are readable by the user specified with the -arclogin option. Alternate options return libraries with read/write access, or full access.
|
-arclogin "userid/pswd" | ask
|
Sets the login user ID and password (they must be separated by a slash - /) for the command. Logins are required for many archive command line operations. Under some circumstances, login information can be read from files. See the Document Archiving and Management chapter for more details.
Optionally, enter the word "ask" and the client will prompt for the login information. Note the Windows console client will not suppress user input when prompting. The Unix client does suppress display of input.
|
-arcnotes "notes"
|
Sets the archive document notes for document writing. To force line breaks, insert \n mnemonic character sequences.
|
-arcorder order
|
Sets the order of the lists retrieved by the –arclist and –arclistdocs options. The order must be one of the following: id, date, title, docdata, or category. The default order is id.
|
-arcput
|
Triggers writing of a file directly to a library, bypassing UnForm processing of the input file. The option requires values for -arclib, -arcdoctype, -arcdocid, -arcsubid, and -i, and supports the archive property setting options such as -arctitle, -arckeyword, etc. Review the archiving chapter for more details.
|
-arcsep char
|
Sets the separator character for category levels to char. The default is |.
|
-arcsearch
|
Triggers a search to be performed, in conjunction with the -arclib, -arcdoctype, -arcdocid, -arctitle, -arcentityid, -arcdate, -arckeywords, -arcnotes, -arccats, -arclinks, -arctext, -arcsubid, and -arcdocdata option(s). The search results are sent to the –o output file. The format of the results is controlled by the -arclistfmt option.
|
-arcsearchdocs
|
Identical in function to –arcsearch, except that image sub ID information is additionally returned.
|
-arcserver "name[:port]"
|
Sets an archive server name and optional port for archive commands. This overrides the server= entry the [archive] section in uf101d.ini. An archive command can also specify a ,server option, which has the highest priority.
|
-arcstart "start"
|
Specifies a starting point for –arclist and –arclistdocs options, allowing for a range a range of documents to be returned. The starting point should logically be associated with the order specified in the –arcorder option. If the order is "category", then start can contain pipe separators to indicate category level breaks. If the order is "docdata", then a docdata name can be supplied.
|
-arcsubdtm "ymddate"
|
Sets the archive document image sub ID date for document writing to the date specified. Normally this value is calculated automatically. The date supplied must be in the format yyyymmddhhmmss, with the first 8 characters required.
|
-arcsubid "sub ID"
|
Sets the archive document image sub ID for document writing or retrieval. When used in conjunction with –arcget, you can use two special suffixes, "-<" and "->", to return the first or last sub ID that matches the sub ID string. For example, a value of "@UnForm->" would return the last sequential @UnForm sub ID in an auto-sequenced library. Escape the suffix as "\->" to look for the literal value.
|
-arcsubtitle "title"
|
Sets the archive document image sub ID title for document writing.
|
-arctextdata "value"
|
Used in conjunction with the –arcsearch option to search text image data, archived with @text sub IDs, for the value supplied.
|
-arctitle "title"
|
Sets the archive document title for document writing.
|
-ldapsync
|
Triggers a command line LDAP/AD sync process, which update user and group databases based on additional -ldap* options. This process mirrors that provided by the archive browser interface Admin, Users, Sync option.
The command line sync always backs up the user and group database files, which are ufarcusr.dat, ufarcacc.dat, ufarcgrp.dat, and ufarcgac.dat. These files are copied to .bak versions. After the sync, if there are issues with user logins, you can copy the .bak files back, or use the Restore function found in the archive browser interface Admin, Users, Sync window.
The additional -ldap* options will update the ldap.ini or ldap.profile.ini file and run the sync process. Check the server logs for messages prefixed with "LDAP sync". Only the -ldaplogin and -ldappassword are required if the ldap.ini or ldap.profile.ini have been configured to work using the browser interface sync process.
|
-ldapprofile profile
|
Specifies the profile to use, and which ldap.profile.ini file to work with. If not specified, the ldap.ini file is used.
|
-ldapserver server
|
The server format specifies the hostname of the LDAP/AD server. Optional :port suffix, and optional ssl: or tls: prefix indicating how to communicate with the LDAP/AD server. Examples:
•ssl:myserver:699 (uses ldaps, non-standard port)
•192.168.1.130:389 (open, standard but specified port)
•tls:10.10.1.100 (standard port, uses STARTTLS) |
-ldaplogin login
-ldappassword password
|
Specifies the authentication values used when connecting to the LDAP/AD server. Note this is different from the -arclogin values used to authenticate the UnForm user that will perform the action. This must be a login that can list users and groups.
|
-ldaptype type
|
Specifies the type of sync process. A type refers to a section in the ldap ini file that defines how to interpret the server responses. When using the browser sync interface, types are presented as a Server Type radio selection option.
|
-ldappaging count
|
If there are a large number of users and groups to sync, this option enables paged processing to avoid memory errors. A common option is -ldappaging 100.
|