Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This document explains the elements for creating a start/stop automation at a high level.

Example: OZSoft tenant.

When creating new start/stop automation procedures, always test on OZsoft tenant first.

Elements of Start/Stop

Impersonating as OZSoft admin, navigate to Management → Automation → Definition and expand the menus

Process Definitions

The process definition is the core and the first step of the start/stop process.

While you’re creating the start-stop workflow, you must take note of the following:

  • The external variables that are going to be input in the form

  • The steps that are going to be in the workflow

  • The workflow’s sequence

Each step in the workflow represents a process definition. Inside a process definition, you can modify the following fields

  • Name: Name of step

  • Owner: All process definitions in a workflow must have a robot user as owner, otherwise the process won’t run. This robot user must have assigned an OS user that can run sudo commands (for linux) and SQL commands (for Windows)

  • Work queue:

  • Command: This is the core and main instruction of the process definition. You can use both Linux and SQL commands for start/stop processes. However, it is important that you manually test the command to make sure it works before creating the process definition in IT-Conductor

(por aqui se empieza, primero hay que averiguar que fields/variables/data vas a necesitar

command: previously test the command. make sure it works manually
Se pueden usar commands linux y SQL para start stop
min 34:57
despues de testear el command manualmente, testear en itc
usar variables.
despues de terminar de modificar el command en el process definition, regresar a la form (form template) y asegurarse de que este atrapando esas variables indicadas en el command y en el work queue

work queue: this is where the activity is going to run (en el ejemplo del video, it runs in a linux host). for start stop make sure to select a dynamic work queue

owner: todos los process definitions en un workflow (de start o de stop por ejemplo) tienen que tener a un robot user como owner, si no, no va a funcionar. Y el robot user tiene que tener un OS user asociado tmb. el OS user asociado debe poder hacer sudo commands (para linux).
(preguntar min 37:54 for sap host you need to be able to add the permission for host agent al usuario owner)

Form Templates

To create the form templates you need to have identified the fields, variables, or data that will serve as input parameters for the start/stop wizard.

Chances are that there already exists a form template with the necessary inputs, in that case, you may reuse it instead of creating a new one.

Otherwise, you can duplicate the one with the closest parameters. You can see which variable, app, or class the form is calling on the “Property” column. To edit the template, you can select a row and click on “Modify row.”

Execution Configs

Execution configs are a list of variables that you pre-configure to use in the future, for example, if you’re going to schedule a process to run in the future. Ad-hoc execution configs won’t appear on this list.

Wizard

The wizard in IT-Conductor is a combination of the form template and the process definition. It’s where the user will launch the start/stop workflow.

The creation of the wizard is divided into three steps:

  • Input parameters: Here, the user will enter the parameters needed to run the workflow. These parameters are specified in the selected form template.

This step also includes entering the name and description of the wizard, the owner (usually the admin user of that tenant), the target class (choose execution config), and the form template

  • Create process: In this step, on the “Wizard_Element.Definition” option, you select the previously created process definition

  • View process: It’ll show you a final view of what the workflow looks like before you save the wizard

Same as with process definitions and form templates, you may copy an existing wizard and modify the “Input parameters” and “Create process” steps, and change the name, description, process definition, and form template.

Dashboards

You may design a dashboard for start/stop automation like the one for OZsoft and add them to the tenant’s main menu if necessary.

The Start/Stop automation dashboard for OZsoft has a tile for the Start/Stop Wizards that you can modify by entering the Design Mode (to enter design mode you need to use your admin IT-Conductor account, not impersonate the tenant’s admin).

You can add a Wizard tile to display a few pre-created wizards upfront.

The wizard tile contains the following options:

  • Dashboard: Select the dashboard that it’ll belong to

  • Title: Name of the tile

  • Menu item: Here you insert the pre-created wizard items that the tile will display. The items are inserted inside a saved search which has the object ids of the pre-created wizards. In the saved search, in “Display mode” you may also select how the wizard items will be displayed on the dashboard. how to create a saved search?

  • Row: Select the row where the tile will be placed

  • Column: Select the column where the tile will be placed

  • Parameters: Insert the id of the tenant that this tile/dashboard will be associated to

  • No labels