Skip to content

Commit 37cbc07

Browse files
PedroDebeverePedroDebevere
committed
dev guide, api and schema documentation
1 parent 57e07f8 commit 37cbc07

File tree

2,080 files changed

+131991
-35
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,080 files changed

+131991
-35
lines changed

‎.github/workflows/azure-static-web-apps-victorious-sea-0e7978f03.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ jobs:
1919
submodules: true
2020
- name: choco install docfx
2121
run: |
22-
choco install docfx -y --version=2.58
22+
choco install docfx -y
2323
env:
2424
CI: true
2525
- name: build documentation
2626
run: |
27+
docfx metadata
2728
docfx build -t default,templates/slc_template
2829
- name: publish results
2930
uses: actions/upload-artifact@v2.2.4

‎api/.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml
5+
.manifest

‎api/index.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
uid: ApiDocumentation
3+
---
4+
5+
# Api Documentation
6+
7+
## Namespaces
8+
9+
|Namespace|Description|
10+
|--- |--- |
11+
|[Skyline.DataMiner.Scripting](xref:Skyline.DataMiner.Scripting)|This namespace contains classes used to implement logic in QActions of connectors.|
12+
|[Skyline.DataMiner.Automation](xref:Skyline.DataMiner.Automation)|This namespace contains types used to implement logic in Automation scripts.|
13+
|[Skyline.DataMiner.Library.Common](xref:Skyline.DataMiner.Library.Common)|This namespace contains types used for development of protocols and Automation scripts. For more information on how to use types from this namespace, refer to [Introduction](xref:ClassLibraryIntroduction).|
14+
|[Skyline.DataMiner.Library.Automation](xref:Skyline.DataMiner.Library.Automation)|This namespace contains types used for development of Automation scripts.|
15+
|[Skyline.DataMiner.Library.Protocol](xref:Skyline.DataMiner.Library.Protocol)|This namespace contains types used for development of protocols.|
16+
|[Skyline.DataMiner.Net](xref:Skyline.DataMiner.Net)|This namespace contains SLNet types.|
17+
|[Interop.SLDms](xref:Interop.SLDms)|***Deprecated*** This namespace contains types for interacting with a DataMiner System.|
18+
|[Tamir.SharpSsh](xref:Tamir.SharpSsh)|***Deprecated*** This namespace contains classes implementing SSH File Transfer Protocol (SFTP) and Secure Copy (SCP) functionality. **NOTE:** This namespace is obsolete for SCP and SFTP implementations. Please refer to the following page for an alternative for such implementations: https://github.com/sshnet/SSH.NET.|
19+
20+
## Error codes
21+
22+
- [DataMiner error codes](xref:DataMinerErrorCodes)
23+
- [Severity codes](xref:SeverityCodes)
24+
- [Error code table](xref:ErrorCodeTable)

‎develop/devguide/Automation/AutomationActionAssignDummy.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
uid: AutomationActionAssignDummy
3+
---
4+
5+
# Assign dummy
6+
7+
Assign an Automation script's dummy to a specific element by using a variable or a value.
8+
9+
- For a pre-determined element, select Value to select a specific element, and enter the element name or ID.
10+
11+
```xml
12+
<Exe id="2" type="assigndummy">
13+
<Param protocol="1"></Param>
14+
<Value>100/200</Value>
15+
</Exe>
16+
```
17+
18+
- For an element determined by a script variable
19+
20+
```xml
21+
<Exe id="3" type="assigndummy">
22+
<Param protocol="1"></Param>
23+
<Value ref="param1"></Value>
24+
</Exe>
25+
```
26+
27+
The value of the variable or the directly specified value should contain either the dmaID and elementID formatted as "dmaID/elementID" or the element name.
28+
29+
Required items:
30+
31+
- For pre-determined element: Value
32+
- For script variable: Value@ref

‎develop/devguide/Automation/AutomationActionAssignTemplate.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
uid: AutomationActionAssignTemplate
3+
---
4+
5+
# Assign template
6+
7+
Assigns an alarm or trend template to a dummy.
8+
9+
```xml
10+
<Exe id="2" type="settemplate">
11+
<Protocol>1</Protocol>
12+
<Type>alarm</Type>
13+
<Value>Template1</Value>
14+
</Exe>
15+
<Exe id="2" type="settemplate">
16+
<Protocol>1</Protocol>
17+
<Type>alarm</Type>
18+
<Value ref="param1"></Value>
19+
</Exe>
20+
```
21+
22+
Required items:
23+
24+
- Protocol
25+
- Type "alarm" for alarm template, "trending" for trend template
26+
- Value for pre-determined template or Value@ref when determined by script parameter.

‎develop/devguide/Automation/AutomationActionCSharpCode.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
uid: AutomationActionCSharpCode
3+
---
4+
5+
# C# code
6+
7+
Executes C# code.
8+
9+
```xml
10+
<Exe id="2" type="csharp">
11+
<Value><![CDATA[my code]]></Value>
12+
<Param type="using">mynamespace</Param>
13+
<Param type="ref">myreference</Param>
14+
<Param type="scriptRef">my script ref</Param>
15+
<Param type="debug">true</Param>
16+
<Param type="preCompile">true</Param>
17+
<Param type="libraryName">testname</Param>
18+
<Message></Message>
19+
</Exe>
20+
```
21+
22+
Required items:
23+
24+
- Value: The C# code to execute.
25+
- Param (type="using"): The namespace references
26+
- Param (type="ref"): DLL references. To provide multiple DLL references, provide multiple elements with Param@type set to "ref".
27+
- Param (type="scriptRef"), script references.
28+
- Param (type="debug"): Indicates whether to compile in debug mode. Value is either "true" or "false".
29+
- Param (type="preCompile"): Indicates whether to precompile. Value is either "true" or "false".
30+
- Param (type="libraryName"): Library name. Only required when pre-compilation is enabled.

‎develop/devguide/Automation/AutomationActionClearMemory.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
uid: AutomationActionClearMemory
3+
---
4+
5+
# Clear memory
6+
7+
Clears the content of the specified Automation script memory file.
8+
9+
```xml
10+
<Exe id="2" type="clearmemory">
11+
<Value ref="1"></Value>
12+
</Exe>
13+
```
14+
15+
Required items:
16+
17+
- Value@ref: The memory file to clear.

‎develop/devguide/Automation/AutomationActionComment.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
uid: AutomationActionComment
3+
---
4+
5+
# Comment
6+
7+
Provides extra comments to the script.
8+
9+
```xml
10+
<Exe id="2" type="comment">
11+
<Message>myComment</Message>
12+
</Exe>
13+
```
14+
15+
Message: The comment.
16+
17+
## Remarks
18+
19+
> [!NOTE]
20+
>
21+
> - If you add a comment line containing debug=true, debug mode will be enabled. During script execution, all comments will appear as information events. They will also be added to the SLAutomation.txt log file. A comment line containing debug=false disables the debug mode.
22+
> - If you add a comment line containing skipElementChecks=true, the script will not verify the current state of the element. This way, scripts can be executed even if included elements are in a timeout state or not active.
23+
> - If you add a comment line containing skipInformationEvents=true, you will prevent information events from being generated by the SET statements in the script.

‎develop/devguide/Automation/AutomationActionEmail.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
uid: AutomationActionEmail
3+
---
4+
5+
# Email
6+
7+
Sends an email to the specified destination.
8+
9+
```xml
10+
<Exe id="12" type="notification">
11+
<Message>#message</Message>
12+
<Destination type="email" title="subject" cc="cc@cc.com;" bcc="bcc@bcc.com;">to@to.com;
13+
</Destination>
14+
</Exe>
15+
```
16+
17+
- Message: The content of the email
18+
- Destination: The recipients.
19+
- Destination@type: Indicates this action is a notification by email.
20+
- Destination@title: The subject of the email.
21+
- Destination@cc: The carbon copy recipients.
22+
- Destination@bcc: The blind carbon copy recipients.
23+
24+
Required items:
25+
26+
- Destination
27+
- Destination@title
28+
- Destination@type="email"
29+
30+
## Remarks
31+
32+
> [!NOTE]
33+
> To indicate plain text, prepend the message with the # character.

‎develop/devguide/Automation/AutomationActionExit.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
uid: AutomationActionExit
3+
---
4+
5+
# Exit
6+
7+
Terminates the Automation script without delay.
8+
9+
```xml
10+
<Exe id="2" type="exit">
11+
<Message>Reason</Message>
12+
<ScriptSuccess>TRUE</ScriptSuccess>
13+
</Exe>
14+
```
15+
16+
- Message: The reason for termination.
17+
- ScriptSuccess: Indicated whether the script execution was considered successful (true) or failure (false).

‎develop/devguide/Automation/AutomationActionFindInteractiveClient.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
uid: AutomationActionFindInteractiveClient
3+
---
4+
5+
# Find interactive client
6+
7+
Asks an interactive user to attach to the script.
8+
9+
```xml
10+
<Exe id="2" type="findinteractiveclient">
11+
<Timeout>90</Timeout>
12+
<Message>Message</Message>
13+
</Exe>
14+
```
15+
16+
- Timeout: The timeout in s. Specifies how long the script should wait for the user to react. When this timeout expires, the script will continue and the FindInteractiveClient method returns "False".
17+
- Message: The message that will appear in the message box.

‎develop/devguide/Automation/AutomationActionGet.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
uid: AutomationActionGet
3+
---
4+
5+
# Get
6+
7+
Retrieves a parameter or memory value.
8+
9+
- Retrieving a parameter
10+
11+
```xml
12+
<Exe id="2" type="get" destvar="param1">
13+
<Param protocol="1">300</Param>
14+
<Value offset="0"></Value>
15+
</Exe>
16+
```
17+
18+
- Param: Parameter ID
19+
- Param@protocol: Dummy element
20+
- Value@offset: The offset
21+
22+
- Retrieving a memory value
23+
24+
```xml
25+
<Exe id="2" type="get" destvar="param1">
26+
<Type>memory</Type>
27+
<MemoryPos>1:1</MemoryPos>
28+
<Value offset="0"></Value>
29+
</Exe>
30+
```
31+
32+
- Type: "memory"
33+
- MemoryPos: The position of the entry to get in the memory file.
34+
- Value@offset: The offset.

‎develop/devguide/Automation/AutomationActionGoTo.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
uid: AutomationActionGoTo
3+
---
4+
5+
# Go to
6+
7+
Unconditionally transfers control to the statement labeled by the specified identifier.
8+
9+
```xml
10+
<Exe id="2" type="goto">
11+
<Value>label</Value>
12+
</Exe>
13+
```
14+
15+
- Value: The label.

‎develop/devguide/Automation/AutomationActionIf.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
uid: AutomationActionIf
3+
---
4+
5+
# If
6+
7+
Defines an if-else clause.
8+
9+
An if-else clause is implemented using Exe blocks of type "if", "else" and "endif" as illustrated next:
10+
11+
```xml
12+
<Exe id="2" type="if">
13+
<Type>conditions</Type>
14+
<Condition combination="and" type="param" protocol="1" pid="64501" compare="lt" ref="param1"></Condition>
15+
</Exe>
16+
<Exe id="3" type="...">
17+
<!-- Code to execute when condition is met (if-clause) -->
18+
</Exe>
19+
<Exe id="4" type="else"/>
20+
<Exe id="5" type="...">
21+
<!-- Code to execute when condition is not met (else-clause) -->
22+
</Exe>
23+
<Exe id="6" type="endif"/>
24+
```

‎develop/devguide/Automation/AutomationActionInformation.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
uid: AutomationActionInformation
3+
---
4+
5+
# Information
6+
7+
Generates an information event.
8+
9+
```xml
10+
<Exe id="2" type="information">
11+
<Message>This is a test</Message>
12+
</Exe>
13+
```

‎develop/devguide/Automation/AutomationActionLabel.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
uid: AutomationActionLabel
3+
---
4+
5+
# Label
6+
7+
Provides a label to enable transferring program control directly to the specified statement using a goto statement.
8+
9+
```xml
10+
<Exe id="2" type="label">
11+
<Value>myLabel</Value>
12+
</Exe>
13+
```
14+
15+
- Value: The label.

‎develop/devguide/Automation/AutomationActionLog.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
uid: AutomationActionLog
3+
---
4+
5+
# Log
6+
7+
Creates a log message that will be saved in the SLAutomation.txt log file.
8+
9+
- To log a predefined message:
10+
11+
```xml
12+
<Exe id="2" type="logmessage">
13+
<Message>MyLogMessage</Message>
14+
</Exe>
15+
```
16+
17+
- To log the value of a script variable:
18+
19+
```xml
20+
<Exe id="2" type="logmessage">
21+
<Message ref="param1"></Message>
22+
</Exe>
23+
```

‎develop/devguide/Automation/AutomationActionScript.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
uid: AutomationActionScript
3+
---
4+
5+
# Script
6+
7+
Runs another Automation script from within the current script.
8+
9+
```xml
10+
<Exe id="2" type="script">
11+
<Script>Attach to Ticket</Script>
12+
<Param type="DEFER">FALSE</Param>
13+
<Param type="CHECKSETS">TRUE</Param>
14+
<Param type="OPTIONS">11</Param>
15+
</Exe>
16+
```

0 commit comments

Comments
 (0)