businessobject list Command

The Businessobjectlist comand lets you work with lists of business objects.

This page discusses:

Syntax

Use this syntax to issue the businessobjectlist command:

[sync|updatestate|purge|validate|rechecksum] businessobjectlist CLAUSE;

Synchronizing a Business Object List

The Businessobjectlist command lets you publish newly checked-in files to other locations associated with a list of businessobjects.

sync businessobjectlist SEARCHCRITERIA [SYNC_ITEM {SYNC_ITEM}];
  • SEARCHCRITERIA defines a search to generate the list of business objects to sync and can be one of these clauses:
    set NAME
    query NAME
    temp set BO_NAME{,BO_NAME}
    temp query [TEMP_QUERY_ITEM {TEMP_QUERY_ITEM}]
    temp query businessobject TYPE NAME REVISION [TEMP_QUERY_ITEM {TEMP_QUERY_ITEM}] [casesensitive]
    expand [EXPAND_ITEM {EXPAND_ITEM}] 
    SEARCHCRITERIA BINARY_OP SEARCHCRITERIA
    [( {( }]SEARCHCRITERIA [ ){ )}]

    For more information, see query Command.

  • SYNC_ITEM is the type of modification you want to make. Each is specified in a clause, as listed in the following table. You only need to specify the fields to be modified.
    SYNC_ITEM Clause Specifies
    overwriteOnly use if you also specify to to or from clause. Overwrites the files on the specified stores without first comparing the files.
    updateCopies files only to locations that contain a previous version of the file.
    commit NControls how many objects or connections are processed before committing the transaction.
    continue Include the keyword continue if you do not want the command to stop if an error occurs. If the log file is enabled, failures are listed in the file.
    from [store | location NAME {,NAME}The store or location from which the files will be replicated to other locations. If you do not also include the to clause, all locations will be updated.
    to [store | location NAME {,NAME}When not syncing files to all stores, the to clause lets you sync to a specific store or location.
    format FORMAT_NAMEDefines the format of the files to be synced. Only one format can be passed as a filter argument at a time.
    vcconnectionDefines the DesignSync File Access connection to synchronize.

Updating the State of Objects in a List of Business Objects

Use the updatestate keyword to update the current lifecycle state for a list of business objects.

updatestate businessobjectlist SEARCHCRITERIA;

For more information on SEARCHCRITERIA, see Synchronizing a Business Object List.