Orchesto Central user guide

This guide describes how you can use the Orchesto Central.

Note

This documentation describes using central from the perspective of a user with admin role. A user without the admin role will only have access to the overview functionality.

Login Page

To login in to Orchesto Central you need to enter your credentials and then click Log in button. If you forgot your password click Forgotten password .

Login

Reset Password

Enter your email and click Reset password button. An email with a link to reset your password will be sent to you.

ResetPassword

Click the link in the email and enter a new password in the New Password field. Then confirm it and click on Reset Password button.

PasswordResetForm

Central Licencing

Orchesto Central will be in an unlicensed state until at least one gateway is added and a Central license has been purchased.

UnlicencedCentralOverview

Central Overview

On the left-hand side of the Central is the sidebar, which provides access to all principle Central functions.

At the top of the Central is the topbar, where you will find buttons to toggle the sidebar, notifications and user menu.

CentralOverview

Dashboard

This is an overview of your data aggregated from all your added gateways:

  • Total Gateways provides information about all your Gateways in central
  • Cached Requests provides information about the number of downloads from cache instead of cloud
  • Data Saved provides how much Data is saved in your Gateways
  • vBuckets Used provides how many vBuckets are used
  • Data Volume provides a detailed graph of your data
  • ZIDA Volume provides a detailed graph of your ZIDA managed data
  • Traffic in provides a detailed graph with incoming data
  • Traffic out provides a detailed graph with outgoing data

Dashboard

With the Filter button, you can select which of your Gateways are shown in Dashboard:

  • Reset button will restore to default state and all Gateways on the Dashboard
  • If all or none Gateways are checked, Dashboard will show all Gateways

FilterButton

Gateways

In this view all your added gateways will be listed in a table. You can filter the table by typing in the search field. You can search by Name, Tags or Status. To navigate into a gateway click its name.

GatewayOverview

Add gateway

To add a gateway to central you need to enter the details in a modal window.

  • In Gateway name fill the name of your Gateway
  • In Tags type tags for your gateway
  • In Endpoint provide the address of your gateway (etc https://www.mygateway.orchesto.io)
  • In Access key provide your Access Key
  • In Secret key provide your Secret Keys

AddGateway

Gateway Detail

In this view you can see detailed information of a gatevay. You can also edit it or delete it if no longer needed.

  • Basic Info provides general info about your gateway
  • Traffic in provides a detailed graph with incoming data
  • Traffic out provides a detailed graph with outgoing data
  • Data Volume provides a detailed graph of your data
  • ZIDA Volume provides a detailed graph of your ZIDA managed data
  • Cached Requests provides information about the number of downloads from cache instead of cloud
  • Regions provides info about the number of regions to which is Orchesto connected. You can filter these regions by Date with Filter button at the top

GatewayDetail

Edit Gateway

By clicking edit, you can edit your Gateway in the modal window. Fields are the same as in the Add Gateway step

EditGateway

Delete Gateway

To prevent accidental deletion you must confirm deleting a gateway.

DeleteGateway

Users

In this view all your added users will be listed in a table. You can filter the table by typing in the search field. You can search by Email. To navigate into a user click its name.

Users

Add User

To add a user to central you need to enter the details in a modal window.

  • In Email address fill email of the user that is created
  • In Password fill his password, then confirm it in Confirm Password field
  • In Role select if the user will be normal user or administrator

AddUser

User Detail

In this view you can see detailed information of a user. You can also edit it or delete it if no longer needed.

ProfilePage

Edit User

By clicking edit, you can alter the role of the user with Role selector

EditUser

Delete User

To prevent accidental deletion you must confirm deleting a user.

DeleteUser

Changing password

Update your password by filling out the form in the modal window.

ChangePassword

Audit Log

The Audit Log provides information about all actions made in Orchesto Central. You can search the Audit Log by Actions and Actors.

You can also filter Action with the filter button in Action field and Time with a button in Time field located in the table header

AuditLog

Policies

Policies Overview

In this view all your added policies will be listed in a table. You can filter the table by typing in the search field. You can search by Nam. To navigate into a policy click its name.

PoliciesOverview

Add Policy

To add a policy to a gateway in central you need to complete a wizard in a modal window.

  • Creation of policies is divided into 4 steps form
  • At the bottom of the form is always displayed Policy sentence

Step one

  • Set a name of your policy in the Policy name field
  • A description of your policy can be added in the Description field
  • Then you can choose if you want to be policy encrypted (check Encrypt checkbox) or you can set time of expiration (check Expires in checkbox and select time)

PolicyFormOne

Step two

In the second step you are choosing Condition for your policies, you can choose None, Metadata or In-Content

None

If you choose None condition no regards to the objects metadata or in-content will be taken. I.e. the object will pass to the next step.

Metadata

If you choose Metadata condition:

  • Enter the key pair Label and Value for the metadata

PolicyFormTwoMetadata

In-content

If you choose In-content:

  • Enter the value to be searched for in the Contains field

PolicyFormTwoInContent

Step three

In the third step, you will choose file extensions for Policy

  • In Filetype field you can select group of file extensions. Filetype groups can be managed in the Settings view
  • To Custom extension you can type your custom file extension
  • To Exclude extension you can specify which file extensions will be excluded from the policy

PolicyFormThree

Step four

In the fourth step, you will choose the target gateway

  • In Gateways select target gateway or gateways for your policy

PolicyFormFour

Policy Detail

In this view you can see detailed information of a policy. You can also edit it or delete it if no longer needed.

  • In this view, you can see who created the policy, when it was created and which gateway(s) the policy is targeting as well its description
  • On the bottom of policy detail panel the policy sentence is displayed
  • Use the Add filter button for adding additional filters for your policy

PolicyDetail

Edit Policy

Editing of policy is divided into two steps:

Step One

In this step, you can edit Actions of the policy.

EditPolicy

Step Two

In the second step, you can edit Target of your Policy.

EditPolicyTwo

Delete Policy

If you want to delete Policy you need to check checkbox I agree with policy deletion and click on Delete button.

DeletePolicy

Add Filter

In the first step of Add Filter form, you can choose Condition for your filter of the Policy.

FilterPolicy

In the second step of Add Filter form, you can choose the file type for your filter of the Policy.

FilterPolicyTwo

Settings

Settings

Heartbeat

Update the heartbeat interval for Central

  • You can change the time of heartbeat (default is 5)
  • You can change max missed heartbeats after which a Gateway will go offline (default is 3)
  • Set default settings button will set default values

Policies

Manage and create custom extensions groups

  • Add a custom extensions group by clicking the Add new filegroup button
  • Enter the name of the filegroup type your custom extensions into File Extensions field

AddNewFilegroup