Creating an Assembly
The Opalis Quick Integration Kit
Command Line Interface Wizard enables you to encapsulate commands,
arguments, and parameters that you configure into a Microsoft .Net
2.0 Framework assembly.
After you have created the assembly,
you can test and edit it, and then convert it into a custom
Integration Pack. See the other topics in this help file for
instructions.
To provide assembly
details:
1.
|
Open the Opalis Quick Integration
Kit Command Line Interface Wizard. On the first screen, click
Next. The Assembly Details dialog appears.
|
2.
|
In the Name field, type the name of the
assembly that you are creating.
|
3.
|
In the Assembly file field, type the path
where you want to save the assembly that you are creating, or click
the ellipsis button (...)
and browse for the location.
|
4.
|
In the License Key field, type or paste the
license key that the custom Integration Pack that you create from
the .Net assembly will require to run.
|
5.
|
To provide details about the
assembly that you are creating, click Assembly information. The Assembly Information dialog appears.
The information provided in this filed will appear in the file
properties of the DLL assembly that will be created.
|
6.
|
In the Title field, type a title for the
assembly that you are creating. The title will be used as a default
name when using the QIK Wizard to generate an integration
pack.
|
7.
|
In the Description field, type a description
of the assembly that you are creating.
|
8.
|
In the Product field, type a product name for
the assembly that you are creating.
|
9.
|
In the Company field, type the name of your
company.
|
10.
|
In the Copyright field, type your company’s
copyright information.
|
11.
|
In the Trademark field, type your company’s
trademark information.
|
12.
|
In the Version fields, type the version
numbers that you want to assign to the assembly that you are
creating. For example, typing 1 0
2 1 in the four fields generates a version number of
1.0.2.1.
|
13.
|
Click OK. The Assembly Details dialog appears.
|
To add commands:
1.
|
Click Next. The Commands dialog appears.
|
2.
|
Click Add. The Add/Edit Command dialog Details tab appears.
|
3.
|
In the Name field, type a name for the command
that you are adding.
|
4.
|
From the Mode drop-down list, select the mode
that the command will run. The Mode determines the style of command
line script that will be used.
|
5.
|
If you selected the Run Program mode, the Program field becomes active. Click the
ellipsis button (...) and
browse for the program that you want to run.
|
6.
|
In the Description field, type a description
of the command.
|
To add arguments and
parameters:
1.
|
Click the Arguments tab.
|
2.
|
In the Command Line field, type the arguments
that you want to supply to the command, or click Insert and select them.
|
3.
|
To provide parameters for an
argument, click Add. The
Add/Edit Parameter dialog
appears.
|
4.
|
In the Name field, type a name for the
parameter that you are adding.
|
5.
|
From the Usage mode drop-down list, select the
mode that you will use for the parameter. The Usage mode has two choices:
|
•
|
Command Argument - Select to use this
input as an argument within your script.
|
•
|
Environment Variable - Select to use
this argument as an environment variable that will be set before
the script runs.
|
6.
|
From the Display style drop-down list, select
the style that you will use to display the parameter. The display
style determines how the user will interact with the input when it
is presented to them. The choices are:
|
•
|
Text - The user will be presented with
a free-form text box for entering a value.
|
•
|
Encrypted Text - The user will be
presented with a masked text box. The data in this field will be
encrypted within the Opalis datastore.
|
•
|
True/False - The user can select True
or False from a browser menu.
|
•
|
Text with selection - The user can
select from a group of Options that you specify.
|
•
|
Date/time - The user can select the
value using a Date/Time Picker control.
|
•
|
File - The user can select the value
using a File Browser control.
|
7.
|
If the parameter requires a
default value, type it in the Default value field.
|
8.
|
To add options to the parameter,
click the ellipsis button beside the Options field and select them.
|
9.
|
Click OK. The Add/Edit Command dialog Arguments tab appears.
|
10.
|
Repeat steps 3 to 9 for each parameter
that you want to add.
|
To create Published Data
items:
1.
|
Click the Published Data tab.
|
•
|
If you selected the
Run Command, Run Program, or Run SSH Command option from the
Mode drop-down list on the
General tab of the
Add/Edit Command dialog,
the following items appear on the Add/Edit Published Data dialog:
|
•
|
In the Name field, type a name for the
Published Data item that you are creating.
|
•
|
From the Source drop-down list, select the
source of the Published Data item. You can choose the Standard Out
and Standard Error streams from the command line.
|
•
|
From the Mode drop-down list, select the mode
that you want to use for the Published Data item. Use Match Pattern to determine if a given
pattern is found within the the Source; this will return True or False.
Use Extract Group to
retrieve each item of data that matches the Pattern that you specify.
|
•
|
In the Pattern field, type the pattern that
you want to apply to the Published Data item.
|
•
|
In the Description field, type a short
description for the Published Data item.
|
•
|
If you selected the
Run Windows Powershell
option from the Mode
drop-down list on the General tab of the Add/Edit Command dialog, the following
items appear on the Add/Edit
Published Data dialog:
|
•
|
In the Name field, type a name for the
Published Data item that you are creating.
|
•
|
In the Property field, type the name of the
Windows Powershell property that you want to populate the new
Published Data item with.
|
•
|
In the Description field, type a description
of the Published Data item.
|
3.
|
Click OK. The Add/Edit Command dialog Published Data tab appears.
|
4.
|
Repeat steps 2 and 3 for each Published
Data item that you want to create.
|
5.
|
Click OK. The Commands dialog appears.
|
To create the
assembly:
1.
|
Click Next. The Quick Integration Kit Command
Line Interface Wizard creates the assembly. The Wizard completed successfully dialog
appears.
|