Configurations (Predefined)

Configuration Variants

squid by arc46 comes with an ever-growing amount of predefined configurations. These have a certain logical structure that once understood make it easier for you to find the correct configuration for your requirements.

What we return - the data

We define three variants of what data is returned.

A *_minimal variant with only that absolut basic information without becoming useless. See below for the rational on what is included why.

A default variant where we expect most standard use cases to be satisfied. This is more art than science. Does your company use life_cycle_stage and life_cycle_stage_status or legacy install_status and operational_status. We don't know, both usages are valid, so we'll include both.

cd_rom / cd_speed? We've taken the liberty not to include these properties. If you need them, you'll have to build a custom configuration (not hard, we'll help)

But what about cost / cost_currency? In our experience this is seldom used and if it is, seldom for the integration of peripheral systems. But there are tens of thousands of ServiceNow installations. Maybe we're wrong. Maybe a majority of our customers require these values. Give us a heads-up over at Feature Requests, and we'll see what we can do.

The challenge is that if we include everything we're at...

a *_full variant. This includes everything on the base table including any custom properties you might have defined. It also includes any additional properties of derived class if predefined by squid by arc46. This is effectively a full data dump.

How we return it - the renderType

In addition to the variants of what data is returned we also define two variants of how that data is rendered.

A default variant that renders references as a Reference.

default configurations are not restricted in the amount of entities that are returned, but they do not allow Inline Relations.

An *_inline variant that a) renders references as Inline Content and b) allows Inline Relations.

*_inline variants are not intended for mass data retrieval and are by default restricted to a maximum of 10 returned entities.

The Standard Configuration Variants

Combining the what with the how from above gives us six standard configuration variants that squid by arc46 provides for every predefined class/table.

• class_minimal - see below
• class
• class_full
• class_inline_minimal - same content as class_minimal
• class_inline - same content as class
• class_inline_full - same content as class_full

*_minimal Properties

*_minimal configurations will at least include the following properties

Property	Comment
sys_id	The primary key of the entity.
sys_class_name	The classname of the entity. Relevant when derived classes are included. Not always applicable.
sys_updated_on	Included to make the query parameter updatedBefore / updatedSince possible.
sys_mod_count	Enables peripheral systems to keep track of the current version of the entity and notice changes.
last_discovered	Included to make the query parameter lastDiscoveredBefore / lastDiscoveredSince possible.
name	The name of an entity. Mostly, but not always applicable.
asset_tag	Asset tags are often used as inventory numbers. Mostly, but not always applicable.

*_minimal configurations will include class/table specific additional properties where applicable.

Any properties included in *_minimal configurations will be included in the default variant.

The rationale for including sys_updated_on, sys_updates and last_discovered in *_minimal configurations is to allow peripheral systems to recognize deltas compared to their last data sync without retrieving and processing the full data volume.