DOCS

Snapshots

The Snapshot feature records information on the selected object types in the becubic repository on the date and time you create the snapshot. Subsequently, users can apply a snapshot view to take a look at the object state at a given date and time, by using any data viewing features. See the ASG-becubic User’s Guide and the ASG-becubic Web Client User’s Guide.

If objects of the type on which you have applied versioning have been updated several times but no snapshot has been created, only the current information regarding the object type can be viewed.

To create a snapshot

This procedure describes the operations on the becubic Web Administration page. If you are using the becubic Eclipse client, select becubic

Snapshot to open the related window.

On the Administration page of becubic Web, expand Repository Administration in the left frame.
Expand Version Control.
Click Snapshots. This opens the Snapshots window:

Click Create New.
Enter a name for the Snapshot.
Click Add a New Snapshot. The snapshot is now displayed on the Snapshots window.

Snapshot Tool

When inserted as a step into a redocumentation sequence generated by Model Wizard (see the ASG-becubic Installation and Implementation Guide), this redocumentation tool creates a snapshot at each incremental load.

This table describes the parameters of Ant Based Snapshot Tool:

Parameter	Description
General section
snapshotDescription	Snapshot description.
snapshotName	Snapshot name.
Connection section	The next three parameters are used to specify the repository on which you want to execute the query. They require prior configuring of the connection to the repository in the becubic Eclipse client.
domain	Domain of the User as declared in the connection parameters. Select a value from the drop-down list.
server	Server (repository) name as displayed on the Connections page of the Preferences window. Select a value from the drop-down list.
user	User name as declared in the connection parameters. Select a value from the drop-down list. This is not the Name of the connection node on the Connections page of the Preferences window.

Web Service for Creating a Snapshot

Use this syntax to create a snapshot by means of a Web service:

/service/snapshot?snapshotName=MySnapName&snapshotDescription=MySnapDescription

This returns an XML or a JSON message.

If there are multiple repositories, the default connection that was defined on the machine is assumed, unless you add these parameters to the URL:

&jndi=RepJNDI&domain=MyDomain&user=MyUser&password=MyPwd