Skip to main content
Sign in

Creating workflows for Citrix assets

  • April 17, 2024 08:18
  • Updated

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets as data from Citrix is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Citrix in minutes

You'll get visibility of your Citrix assets by creating configurable workflows to automate tasks such as:

  • Locking and unlocking containers
  • Getting device details
  • Wiping devices
  • Locking and unlocking devices
  • Tracking devices
  • Enabling Airplay Mirroring on a device
  • Sending notifications to, or calling a device
  • Enabling or disabling restrictions
  • Getting or updating device properties
  • Deleting or revoking devices
  • Updating and deploying devices

Let Oomnitza be your single source of truth!

You'll get visibility of your devices as data from Citrix is automatically transformed into consumable information and actionable insights.

Before you start

Before you can create the integration with Oomnitza, you need to have added your Citrix credentials to Oomnitza and set your XenMobile Server hostname and port number as a global variable. For further information, refer to Adding your Citrix credentials to Oomnitza.

We recommend that you also create the extended integration for Citrix assets. You can use Asset ID  retrieved in this integration to run many of the presets listed below. 

Creating workflows

Create asset workflows

To create an asset workflow, you must complete these steps:  

  1. Click Configuration > Workflows 
  2. Click Add (+) and select Assets from the list.
  3. Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to New you can trigger a workflow every time a new asset is created. Refer to Using the Begin block.
  4. Drag and drop the API block onto the Sandbox.
  5. Click Edit on the API block and enter Citrix in the search field. 
  6. Select a preset from one of the categories listed below. 
  7. To choose a preset, click the forward arrow (>).
  8. Select the credentials that you created in Adding your Citrix credentials to Oomnitza.
  9. Your Hostname and Port number should be derived from the global variable you created in Adding your Hostname and Port number as a global variable.
  10. Supply any mandatory information and select Advanced Mode.
  11. Select the Body or Information tab. You will notice that the Asset ID is referenced in the property {{citrix_asset_id}}. Create the Asset Load so that this property exists in Oomnitza and is populated with information before you run this workflow.
  12. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. Once you have the entire response, you can then parse the JSON response values to custom Oomnitza fields.
  13. Click Save.
  14. Connect the Blocks. 
  15. Save, validate, and activate your workflow.

Container presets

The following presets can be used to enable or disable container locks on devices:

  • Container Lock On Devices: Enables a container lock on a list of devices, by Device ID.
  • Cancel Container Lock On Devices: Cancels the above lock on a list of devices, by Device ID.
  • Container Unlock On Devices: Enables a container unlock on a list of devices, by Device ID.
  • Cancel Container Unlock On Devices: Cancels the above unlock on a list of devices, by Device ID.
  • Reset Container Password On Devices: Resets a container password on a list of devices, by Device ID.
  • Cancel Reset Container Password On Devices: Cancels the above reset on a list of devices, by Device ID.

Get device details presets

The following presets can be used to retrieve device information:

  • Get Asset Details: Gets an asset's details, by Device ID.
  • Get Device Actions: Gets the actions of a device, by Device ID.
  • Get Device Applications: Gets a device's applications, by Device ID.
  • Get Device Delivery Groups: Gets a device's delivery groups, by Device ID.
  • Get Device Managed Software Inventory: Gets a device's managed software inventory, by Device ID.
  • Get Device Policies: Gets a device's policies, by Device ID.
  • Get Device Software Inventory: Gets a device's software inventory, by Device ID.
  • Retrieve Device iOS MDM Status: Gets a device's iOS MDM status, by Device ID.

Wipe device presets

The following presets can be used to wipe or cancel wipes on devices and apps:

  • Wipe Mac Devices: Wipes a list of Mac devices, by Device ID. Enter true or false (boolean) in the Force Erase Memory Card field. The pin code must be 6 digits. 
  • Wipe Other Devices: Wipes a list of other (non-Mac) devices, by Device ID. Enter true or false (boolean) in the Force Erase Memory Card field. 
  • Cancel Wipe Devices: Cancels the above wipe on a list of devices, by Device ID.
  • App Wipe On Devices: Wipes the applications on a list of devices, by Device ID
  • SD Card Wipe On Devices: Wipes the SD card on a list of devices, by Device ID
  • Cancel SD Card Wipe On Devices: Cancels the above SD card wipe on a list of devices, by Device ID.
  • Selective Wipe Devices: Performs a wipe on a select list of devices, by Device ID.
  • Cancel Selective Wipe Devices: Cancels the above wipe on a list of devices, by Device ID.

Lock or unlock device presets

The following presets can be used to lock or unlock devices or apps:

  • Lock iOS Devices: Locks a list of iOS devices, by Device ID. Add a message and a phone number to the lock request. Please note that this feature only works for IOS 7 and later. 
  • Citrix Lock Android, Symbion, Windows Phone Devices: Locks a list of Android, Symbion, and Windows devices, by Device ID. Add a pin code to the lock request. The pin code must be between 4 and 16 characters for Android and Symbion devices, and 4 digits for Windows devices.
  • App Lock On Devices: Locks the applications on a list of devices, by Device ID.
  • Bypass Activation Lock On Devices: By-passes the activation lock on a list of devices, by Device ID.
  • Cancel Lock Devices: Cancels the lock on a list of devices, by Device ID.
  • Unlock Devices: Unlocks a list of devices, by Device ID.
  • Cancel Unlock Devices: Cancels the above unlock on a list of devices, by Device ID.

Track device presets

The following presets can be used to track devices:

  • GPS Track Devices: Tracks a list of devices, by Device ID.
  • Cancel GPS Track Devices: Cancels the above track on a list of devices.
  • Locate Devices: Locates a list of devices, by Device ID.
  • Cancel Locate Devices: Cancels the above action on a list of devices.
  • Get Device GPS Coordinates. Gets the coordinates of a device, by Device ID. Enter the Start and End Date to filter the GPS coordinates.
  • Get Device Last Location: Gets the last location of a device, by Device ID

Enable or disable Airplay Mirroring on a device presets

The following presets can be used to enable airplay mirroring (mirroring your screen on another device):

  • Request Airplay Mirroring On Devices: Enables mirroring on a list of devices, by Device ID. Supply the Destination Device ID (this can be the Destination Name or Destination Device ID), the number of seconds to scan the device, and the password for screen sharing. 
  • Cancel Request AirPlay Mirroring On Devices: Cancels the above action on a list of devices.
  • Stop AirPlay Mirroring On Devices: Disables mirroring on a list of devices, by Device ID.
  • Cancel Stop AirPlay Mirroring On Devices: Cancel the above action on a list of devices.

Send a notification or call a device presets

The following presets can be used to call or send a notification to a device:

  • Ring Devices: Enables you to ring a list of devices, by Device ID.
  • Cancel Ring Devices: Cancels the above action on a list of devices.
  • Send Notification To Devices: Enables you to send a notification to a list of devices, by Device ID. Refer to the sample request below.
"to": [
{
"deviceId":{{citrix_asset_id}},
"osFamily": "Enter ANDROID or iOS",
"email": "user1@test.com",
"smsTo": "+123456789"
}
],
"smtpFrom": "Test XMS",
"smtpSubject": "this is test subject",
"smtpMessage": "this is test message",
"smsMessage": "this is test message",
"agentMessage": "this is test message",
"sendAsBCC": "true",
"smtp": "true",
"sms": "true",
"agent": "true",
}

Enable or disable restrictions presets

The following presets can be used to clear or cancel device restrictions:

  • Clear Restrictions On Devices: Enables you to clear restrictions on a list of devices, by Device ID.
  • Cancel Clear Restrictions On Devices: Cancels the above action on a list of devices.

Get or update properties presets

The following presets can be used to get and update device properties:

  • Get Device Properties: Gets a device's properties, by Device ID.
  • Delete Device Property: Deletes a device's properties, by Device ID.
  • Add Or Update Device Property: Updates a device's properties, by Device ID. Supply the property name and value. Refer to the sample request below.
{
"name": "LAST_IP_ADDR",
"value": "10.20.30.50"
}

Delete or revoke a device presets

The following presets can be used to delete, disown or revoke devices:

  • Delete Device: Deletes a device, by Device ID.
  • Disown Devices: Disowns a list of devices, by Device ID.
  • Revoke Devices: Revokes a list of devices, by Device ID.

Update and deploy device presets

The following presets can be used to update and deploy devices:

  • Renew Device Certificate: Renews the certificate on a list of devices, by Device ID.
  • Authorize Devices: Authorizes a list of devices, by Device ID.
  • Generate Device Pin Code: Generates a pin code. Supply the length of the pin code.
  • Deploy Devices: Deploys a list of devices, by Device ID.

articles_icon.svg Reference articles for workflows

Citrix Public REST API Documentation

Related articles

Comments

0 comments

Please sign in to leave a comment.