Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Assets / Create Assets

  • Article
  • 3 minutes to read

Operation Information

Creates an asset for a Ricoh Locker machine.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Ricoh.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Ricoh in the Type pick list;
  • Give the Ricoh KeySafe key a Title (this is the name / identifier for the Ricoh account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Tenant string Ricoh Tenant
Username string Authentication Username
Endpoint string Ricoh API Endpoint
Password string Authentication Password
Access Token string Ricoh Access Token this will be updated aumatically and does not need to be manually filled.

Tip

To connect to Ricoh, you will need to input your username and password for your Ricoh account.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Ricoh account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Machine ID machineId string The identifier of the Ricoh Locker machine. Yes None provided
Code code string The asset code. Yes None provided
Serial Number serialNumber string The asset serial number. No None provided
Status status string The status to assign to the asset. Yes INSTOCK, INWORK, INREPAIR, DELETED, SOLD, STOCKING, RESERVED, DEFECTIVE, INREPAIROUT
Asset ID assetId integer The catalog asset ID associated with this machine asset. Yes None provided

Output Parameters

Display Name ID Type Description
Operation Status status string The operation outcome — ok or failed.
Error error string Error detail if the operation failed.
Code code string The asset code.
Serial Number serialNumber string The asset serial number.
Asset Status assetStatus string The current asset status.
Asset ID assetId integer The associated catalog asset ID.
Machine Asset ID id integer The created machine asset ID.
Picked Up At pickedUpAt string When the asset was picked up.
Dropped Off At droppedOffAt string When the asset was dropped off.
Warranty Expiry warrantyExpiryDateTime string The warranty expiry date and time.
Last Serviced At lastServicedAt string When the asset was last serviced.
Park Time Minutes parkTimeMinutes integer The asset park time in minutes.
Reason reason string The reason associated with the asset.
Time Used timeUsed integer The asset time-used value.
Must Return Before mustReturnBeforeDateTime string The required return date and time.
Overdue Email Sent At overdueEmailSentAt string When the overdue email was sent.
Must Remind Before mustRemindBeforeDateTime string The reminder date and time.
Reminder Email Sent At reminderEmailSentAt string When the reminder email was sent.
Description description string The asset description.
Cell ID cellId string The assigned cell identifier.
Cell Box ID cellBoxId integer The assigned cell box ID.
Agent ID agentId integer The associated agent ID.
End User ID endUserId integer The associated end-user ID.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document