Managing repositories and instances
With repository and instance management, you can:
- Create and edit both repositories and instances, modifying content as needed
- Set roles in repositories
- Snapshot repositories
- Set content dependencies in repositories
- Create duplicate packages in the same repository, with different parameters
- Maintain multiple sets of properties for elements with the same name but different values.
- Lock instances to prevent changes
- Set default routes for instances
- Clone instances
To add a repository
- Click the Define tab.
- From the left menu, select Repositories.
- Click New Repository.
- Specify a name and select a role for the repository.
- Click Create.
After you add a repository, you can edit it to add content and change other settings.
To modify a repository
- Click the Define tab.
- From the left menu, select Repositories.
- Click the name of the repository to edit.
- To change the name, role, instance name format, or next instance number, click the current value, modify it, and submit the change.
- Click the Properties subtab to add, edit, or delete properties.
- In the Contents subtab, add content by dragging and dropping items from the tabs at the bottom of the page or uploading new content.
- In the Config subtab, set any dependencies for the content or other specifications that you need.
- When you are finished making changes, click a button:
- Deploy — Deploys the repository
- New Instance — Creates a new instance of the repository
- Snapshot — Copies the setup
To delete a repository
- Click the Define tab.
- From the left menu, select Repositories.
- In the Actions menu at the end of the same row as the repository that you want to delete, click Delete.
To modify an instance
- Click the Define tab.
- From the left menu, select Instances.
- Click the name of the instance to edit.
- To change the name or role, click the current value, modify it, and submit the change.
- To lock an instance to prevent edits to it, click Yes in the Locked column.
(Click No in that column to unlock the instance.) - To set the default route for the instance, click the value in the Route column.
- In the Properties subtab, add, edit, or delete properties as needed.
- In the Contents subtab, add content by dragging and dropping items from the tabs at the bottom of the page or uploading new content.
- Set any dependencies or other configuration settings that you need for the content.
To delete an instance
- Click the Define tab.
- From the left menu, select Instances.
- In the Actions menu at the end of the same row as the instance that you want to delete, click Delete.
Grouping repository and instance content
To reach the management pages for a repository or instance from the Define tab, click Repositories or Instances in the left menu and then select a repository or instance. On the management page for a repository or instance, you can view your content in a Group order view.
To group contents together
- Group the contents, following these guidelines:
- Drag-and-drop by Select content from the section at the bottom of the page, drag it to the Contents section, and drop it there.
- You can select a single piece of content or an entire repository or instance. Dragging a repository or instance retains the structure of the item being added. Dragging a package creates a group with that package name and its content.
- To remove grouped structure when dragging content, hold down Shift before you drop the content. This adds the content to the repository without any associated groups.
- You can create multilevel groups.
- You can have duplicate packages in the same repository, with different parameters.
- To add a single group from a repository or instance, drag the entire group to the current repository or instance.
- If groups are already in a repository or instance, when you drag content to it, the system displays a new outline in blue as you hover over the associated group to help you get the correct order.
- To rearrange content or groups, drag the item to a different group, using the icon to the left of its name. Use the colored outlines to determine which group you are moving to.
- To delete a group, click the group's Delete link to the right of the Contents section. This moves any content in the group outside that group and removes the group. If you delete a group that contains groups, those nested groups move to the deleted group's parent group.
To print the repository or instance management page
On the management page for a repository or instance, the Print View link is in the upper right corner above the Summary section. Click this link to produce a printer-friendly version of the page. (To reach these management pages from the Define tab, click Repositories or Instances in the left menu and then click a repository or instance.)
The printer-friendly page has up to four sections, depending on whether properties are set or configuration settings are present on any of the solids. To hide a section before printing, click the X icon next to the section. These sections are described as follows:
Print section | Description |
---|---|
Summary | Summary of the repository and instance |
Properties | Repository and instance properties, if any exist |
Configuration | Configuration settings for any solid with such settings |
Contents | Contents of the repository and instance, as well as any dependencies and metadata associated with that content |
Working with repository or instance contents
Use the tabs at the bottom of the page to add existing content or upload new content to your repository or instance. For example, click and hold the image of a package, drag it to the Contents section, and drop it to add that content. You can see the images in the Name columns. When you click an image, the Contents section is highlighted in green.
In the Contents section, the Name column has images of a piece of paper and the names of the content. After data is fetched, you can hover over an image to display the table of contents for a piece of content. Click the name to go to the management page for that piece of content. On the management page, you can preview the contents of that item, add configuration settings or analyzers, and add notes.
The Contents section also has a Location column to indicate where the data for this piece of content lies. With this information, you can be sure you have the correct piece of data in the repository or instance.
The Version column shows None unless you have an analyzer tied to that item to update the version field in the database. However, you can click the value to edit this field manually.
After data is fetched, the Size column shows a Refresh button. Click this button to delete all current data in the database for that solid and refetch the data from the location provided by the reference. The Refetch All button at the lower right of the Contents section refetches all of the data in the repository or instance.
After all solids are fetched, the following buttons appear in the Summary section in the upper right corner:
- For a repository:
- Snapshot: This button creates a copy of the repository in the database, so that you can make changes without affecting the repository that you have already set up.
- Deploy: You can also deploy the current repository, which snapshots it, creates an instance of it, and redirects you to the deployment page so you can select your route, properties, contents to deploy, and so on.
- New Instance: You can create a new instance of that particular repository.
- For an instance:
- Clone: You can clone the current instance and create a copy of it in the database, enabling you to make more changes to the current one without affecting what you have already set up.
- Deploy: You can also deploy the current instance, which does not clone it, and redirects you to the deployment page so you can select your route, properties, contents to deploy, and so on.
To view references in a package
The Packages tab displays the list of packages in the system. Click the name of a package to display the references defined in the package.
To view content in a repository
The Repositories tab displays the list of repositories (besides the current one you are working with) defined in the system. Click the name of a repository to display the content in the repository.
To view instances and deployments
The Instances tab displays the list of "manageable" instances. A manageable instance is one that has not yet entered a deployment route. After the instance enters a route, it cannot be altered. However, you can still pull data from that instance and apply it to the current repository or instance.
The Deployments tab displays the list of "nonmanageable" instances. These instances have entered a route and cannot be altered. You can pull data from this section into your current repository or instance.
Under both tabs, you can click the name of an instance to display its content.
To upload a file
If an item that you want to add is not already available in one of the content tabs, you can upload any file from your computer to the current repository or instance. On the Upload tab, click the highlighted upload section, browse to select your file, and click Upload. The file is uploaded and stored in the database.
You can configure the size of file which you want to upload to the instance or repository in the PHP configuration file. The default file size is 32MB.
To set the number of lines in logs
The Log tab displays background actions. By default, the log shows only the 50 most recent lines.
To change the number of lines shown:
- Click the System tab.
- From the left menu, select Settings.
- Locate the Items Per Page entry.
- Click its value, enter a new value, and submit it.