Skip to content

SoftwareItem

Software items hold customer specific information about software objects.

erDiagram
    Currency ||--o{ SoftwareItem : "InitialCostCurrencyID"
    Currency ||--o{ SoftwareItem : "RecurringCostCurrencyID"
    OctopusObjectType ||--o{ SoftwareItem : "AssignableToOctopusObjectTypeID"
    SoftwareLicenseMetric ||--o{ SoftwareItem : "SoftwareLicenseMetricID"
    SoftwarePublisher ||--o{ SoftwareItem : "SoftwarePublisherID"
    SoftwareItem ||--o{ SoftwareItemDocument : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemGroup : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemLicenseManagerServer : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemMachine : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemOrganization : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemOwner : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemRbacUser : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemSoftwareLicenseMetricProperty : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemSoftwarePackage : "SoftwareItemID"
    SoftwareItem ||--o{ SoftwareItemUser : "SoftwareItemID"

Fields

Field Type Description
Active boolean Mark the Item as active. Inactive items can be hidden from most lists.
AdditionalInfoLink string Can contain a link to additional information
AdministratorNotes string Remarks that can only be read by a small group of users
AlertCriticalDays numeric How many days before the end date of this ite, a critical alert is triggered
AlertEndDate boolean If true, an alert is triggered before the end date is reached
AlertInformationDays numeric How many days before the end date an informational alert is triggered
AlertToAddress string Email address to send alerts to
AlertWarningDays numeric How many days before the end date of this itema warning alert is triggered
AssignableToOctopusObjectTypeID numeric Internal ID that references the OctopusObjectType entity (Foreign Key)
CcpReference string A reference to a CCP use rights item, if this software item is linked to a CCP item
ConsumedUnits decimal A universal field that can contain a number
ConsumedUnitsManualOverride boolean If true, the consumed units value is manually overridden and not computed by a compliance query
ConsumedUnitsWarningPercentageThreshold numeric Percentage threshold for consumed units warning - currently not used
ConsumedUnitsWarningUnitThreshold decimal Unit threshold for consumed units warning - currently not used
Created datetime Date/Time the item was created
CreatedByRbacUserID numeric RBAC user that created the item
CustomField1 string Custom field 1, not used by OctoSAM
CustomField2 string Custom field 2, not used by OctoSAM
CustomField3 string Custom field 3, not used by OctoSAM
CustomField4 string Custom field 4, not used by OctoSAM
CustomField5 string Custom field 5, not used by OctoSAM
CustomField6 string Custom field 6, not used by OctoSAM
Description string Description of the item. Can be html formatted.
Enabled boolean If not enabled, the Item cannot be edited
EndDate datetime End date of the software item
ExtraData string Extra data for this software item
Guid guid Unique ID of the item, can be used for export/import or for the web UI
HintHasDocuments boolean True if the item has associated documents
ID numeric Internal ID for the SoftwareItem entity (Primary Key)
InitialCost decimal Initial Cost
InitialCostCurrencyID numeric Internal ID that references the Currency entity (Foreign Key)
LastAlerted datetime Date/Time when the last alert was triggered for this item
LastModification datetime Date/Time the item was last modified
LastModifiedByRbacUserID numeric RBAC user that last modified the item
Name string Name of the software Item
Notes string Remarks that are visible to all users that have read access to the item
OwnerNotes string Remarks that can only be read by software package owners
PrintableName string Name of this item for reports and queries
RecurringCost decimal Recurring Cost
RecurringCostCurrencyID numeric Internal ID that references the Currency entity (Foreign Key)
Res1 string Reserved for future use
Res2 string Reserved for future use
SiteUniqueID string A site defined unique id for each item. Must be unique if not empty.
SoftwareInstallationApproval boolean Installation approval logic is active for this software item
SoftwareLicenseMetricID numeric Internal ID that references the SoftwareLicenseMetric entity (Foreign Key)
SoftwarePublisherID numeric Internal ID that references the SoftwarePublisher entity (Foreign Key)
Spla boolean True if the software item describes a Microsoft SPLA item
StartDate datetime Start date of the software item
Units decimal A universal field that can contain a number
Version string Version of the software item
Visible boolean Item is visible
VisibleStartDate datetime Item becomes automatically visible after this date

References

Column Name Referenced Table Description
AssignableToOctopusObjectTypeID OctopusObjectType Object types defined in OctoSAM Inventory
InitialCostCurrencyID Currency Lookup table for currencies
RecurringCostCurrencyID Currency Lookup table for currencies
SoftwareLicenseMetricID SoftwareLicenseMetric Software license metrics define how software licenses are measured
SoftwarePublisherID SoftwarePublisher Normalized publisher information from the catalog

Referenced by

Table Column Name Description
SoftwareItemDocument SoftwareItemID Relation between SoftwareItem and Document entities
SoftwareItemGroup SoftwareItemID Relation between SoftwareItem and Group entities
SoftwareItemLicenseManagerServer SoftwareItemID M:n relation between SoftwareItem and LicenseManagerServer tables
SoftwareItemMachine SoftwareItemID M:n SoftwareItem to Machine relation, for Items that are linked to specific machines
SoftwareItemOrganization SoftwareItemID M:n SoftwareItem to Organization relation for Items that are linked to specific organizations
SoftwareItemOwner SoftwareItemID M:n relation between SoftwareItem and RBAC User. Models software item ownership. Software Item Owners can be assigned special privileges on their owned products.
SoftwareItemRbacUser SoftwareItemID M:n relation between SoftwareItem and RbacUser for items that are linked to specific RBAC users
SoftwareItemSoftwareLicenseMetricProperty SoftwareItemID Reserved for future use
SoftwareItemSoftwarePackage SoftwareItemID M:n relation between SoftwareItem and SoftwarePackage, curently only 1:n is used
SoftwareItemUser SoftwareItemID M:n relation between SoftwareItem and User for items that are linked to specific users