13 |
14 |
15 | Click **Next**.
16 |
17 | 3. In the script name field, enter 
32 | 
39 | parentval variable and fill in the **Variable Type** field with the value IN.
18 |
19 | [Use Sequence](sample05/pic2.png)
20 |
21 | Find the variable key, exapnd it and fill in the **Variable Type** field with the value INOUT.
22 |
23 | [Use Sequence](sample05/pic3.png)
24 |
25 | Also, find the variable id, exapnd it and fill in the **Variable Type** field with the value INOUT, as shown in the following image:
26 |
27 | [Use Sequence](sample05/pic4.png)
28 |
29 |
30 | ## Step 3: Launch Points tab
31 |
32 | On the **Launch Point** Tab, verify that the launch point USESEQWO is listed and activated in the Launch Point section.
33 |
34 | [Use Sequence](sample05/pic5.png)
35 |
36 | Also, at the Attribute Launch Point section, verify that the **Attribute** field is set to REPORTEDBY value and tjat the variables are listed into the Launch Point Variables, as shown in the following image:
37 |
38 | [Use Sequence](sample05/pic6.png)
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/samples/AS04_workflowcondition.md:
--------------------------------------------------------------------------------
1 | # Automation script for a condition that is based on work log information
2 |
3 | This script returns a value of true or false based on the log type that is defined in a custom condition in the Conditional Expression Manager.
4 |
5 | ### Step 1
6 |
7 | In the Automation Scripts application, select the **Create > Script with an Object Launch Point** action.
8 |
9 | * On the **Automation Script** tab, copy and paste the following script source:
10 | ```kotlin
11 | if logtype == 'WORK':
12 | evalresult=True
13 | else:
14 | evalresult=False
15 | ```
16 |
17 | [Work Flow Condition](sample04/pic1.png)
18 |
19 | ### Step 2
20 |
21 | * On the **Variables** tab, fill in the Script field with WORKLOGCOND variable name and uses the jython script as the Script Language to be used. Also, the Variable Type field must be IN and The Building Type value must as ATTRIBUTE, as shown in the following image:
22 |
23 |
24 | [Work Flow Condition](sample04/pic2.png)
25 |
26 | ### Step 3
27 |
28 | * On the **Launch Points** tab, verify the following values are specified:
29 | - In the **Script** field: WORKLOGCOND
30 | - In the **Script Language** field: jython
31 | - In the **Status** field: Draft
32 | Ensure that the launch point is listed in the "Launch Point" section, as shown in the following image:
33 |
34 | [Work Flow Condition](sample04/pic3.png)
35 |
36 | * In the "Custom Condition Launch Point" section, select the **Active** checkbox to TRUE and, in the ATTRIBUTE field, specify LOGTYPE. Then, click **OK** to proceed.
37 |
38 | [Work Flow Condition](sample04/pic4.png)
39 |
40 | ### Step 5
41 |
42 | * In the Conditional Expression Manager, create the condition by adding a row where the **Condition** field refers to LOGTYPE and the **Class** field contains the CLASS type. Also, in **Expression** field, paste in the following code:
43 |
44 | ```SQL
45 | worklogcond:worklogcond
46 | ```
47 | The (Full Qualifiend Name) (FQN) of the Script Custom Condition class is given, and the **Class** field contains the following Java Type:
48 |
49 | ```java
50 | com.ibm.tivoli.maximo.script.ScriptCustomCondition
51 | ```
52 |
53 | [Work Flow Condition](sample04/pic5.png)
54 |
55 | * The script verifies the values and returns a value of true or false.
56 |
--------------------------------------------------------------------------------
/samples/sample11/compsetactualdates.dbc:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
53 |
54 |
--------------------------------------------------------------------------------
/samples/AS03_notifyUsers.md:
--------------------------------------------------------------------------------
1 | # Notify users of material and service receipts
2 |
3 | You can create an automation script that can notify users of receipts in an email, without sending a separate email for each receipt record. This process uses an escalation to activate a custom action to do send the notification.
4 |
5 | ## Prerequirements:
6 |
7 | This automation script was developed on Maximo Asset Management version 7.5.0.10 and SQL Server.
8 |
9 |
10 | ## Note:
11 |
12 | This automation script works only for purhcase orders where all lines are requested by the same user.
13 |
14 | ## Step 1
15 |
16 | Create a persistent attribute that is named PO.LASTRECDATE (DATETIME 10).
17 | -
18 |
- Optionally, add the attribute to the **List** and **Main** tabs for purchase orders. 19 |
- Turn off Admin mode. 20 |
-
26 |
- Type: Data Related to the Record 27 |
- Object: PO 28 |
- Value: :poline.requestedby 29 |
-
35 |
- Applies To: PO 36 |
- Subject and Message are customizable for your business needs. 37 |
- Add the POREQ role as a recipient. 38 |
- Activate the template. 39 |
-
46 |
- Object: PO 47 |
- Action: PORECCOMM 48 |
- Bound Variables: None 49 |
- Source: See the poreccomm.py script. It is also available at this link. 50 |
-
56 |
- Object: PO 57 |
- Type: Action Group 58 |
- Members: PORECCOMM 59 |
-
83 |
- Applies To: PO 84 |
- Condition: 85 |
11 | 
17 | 
23 | 
41 | 
49 | 
55 | 
62 | WORKORDER and the attribute is LOCATION.
23 | * Define an INOUT variable v_assetnum and bind it to the ASSETNUM attribute of the WORKORDER object.
24 | * Enter these lines of Jython code for the script:
25 |
26 | ```python
27 | ...
28 | if v_assetnum is not None:
29 |
30 | v_assetnum=None
31 | ...
32 | ```
33 |
34 | * Save the launch point and script, and the launch point is already active.
35 |
36 | ## Testing the launch point
37 |
38 | If you have a product environment that has a location that is associated with a single asset, create a work order and select that location. When you tab out of the **Location** field, the **Asset** field remains empty. The following screen captures shows the effect of the launch point and script.
39 |
40 | Maximo Asset Management version 7.5 Work Order Tracking application with standard business rule (**Asset** field is populated):
41 |
42 | [Business Rules](sample09/pic1.jpeg)
43 | | Task | 9 | Description |
| 1 | 11 | If **Run Reports** is available, click this action. 12 | |
| 2 | 13 | In the Reports Selection window that appears, click the **Purchase Order Details Report**. |
| 3 | 15 | In the Request Page window that appears, chose or specify the following: 16 | a. 17 | Schedule (Immediate, At This Time, Recurring) 18 | b. 19 | Email (Recipients, Subject, Comments, File Type, Report Delivery Format) |
| 4 | 21 | On the Request Page window, click **Submit**. |
| 5 | 23 | If report execution was scheduled to run |
| Report schedule record | Used by the reporting framework to store the scheduling details for a report. |
| Cron task instance record for the REPORTSCHEDULE cron task | Used by the Cron Task manager to execute the report on a schedule by placing a job into the report queue. The REPORTSCHEDULE cron task looks up the report schedule record to obtain details of the report execution. |
assetType in the **Variable** field, INOUT in the **Variable Type** field, ATTRIBUTE in the **Binding Type** field, and ASSETTYPE in the the **Launch Point Attribute** field, as shown in the following image:
90 |
91 | [CreateAS](sample10/pic09.gif)
92 |
93 | 8. Click the **New Row** button to create another variable.
94 | Specify values in the **Variable**, **Variable Type**, **Binding Type**, and **Launch Point Attribute** fields. In this example, the values are vendor **Variable** field, INOUT in the **Variable Type** field, ATTRIBUTE in the **Binding Type** field, and VENDOR in the **Launch Point Attribute** field, as shown in the following image:
95 |
96 | [CreateAS](sample10/pic10.gif)
97 |
98 | Click **Next**.
99 |
100 | 9. Enter the following source code:
101 |
102 | ```python
103 | if assettype_internal=="PRODUCTION":
104 | vendor_required=True
105 | else:
106 | vendor_required=False
107 | ```
108 |
109 | **Note:** The _internal is an implicit variable that indicates that the asset type field is associated to a synonym domain.
110 | The _required is an implicit variable for setting mandatory fields.
111 |
112 | Your Source Code screen looks like the following image:
113 |
114 | [CreateAS](sample10/pic11.gif)
115 |
116 | Click **Create** to create the launch point.
117 | A system message is displayed.
118 |
119 | [CreateAS](sample10/pic12.gif)
120 |
121 | Click **Close**.
122 |
123 | 10. From the action menu, click **Create**" and select the **Script with Attribute Launch Point** action.
124 |
125 | Specify values in the **Launch Point**, **Object**, and **Attribute** fields and select the **Run Action** event.
126 |
127 | [CreateAS](sample10/pic13.gif)
128 |
129 | Click **Next**.
130 |
131 | 11. Click the **New Row** button to create another variable.
132 | Specify values in the **Variable**, **Variable Type**, **Binding Type**, and **Launch Point Attribute** fields. In this example, the values are replacecost in the **Variable** field, INOUT in the **Variable Type** field, ATTRIBUTE in the **Binding Type** field, and REPLACECOST in the**Launch Point Attribute** field, as shown in the following image:
133 |
134 | [CreateAS](sample10/pic14.gif)
135 |
136 | Click **Next**.
137 |
138 | 12. Enter a name for the script and enter the following source code:
139 |
140 | ```python
141 | if purchaseprice > 200:
142 | replacecost = purchaseprice/2
143 | ```
144 |
145 | [CreateAS](sample10/pic15.gif)
146 |
147 | Click **Create**.
148 | A system message is displayed.
149 |
150 | [CreateAS](sample10/pic16.gif)
151 |
152 | Click **Close**.
153 |
154 | All three attribute launch points are created.
155 |
156 | ## Testing the attribute launch points
157 |
158 |
159 | ### Steps:
160 |
161 | 1. In the Assets application, open an existing asset.
162 | 2. Enter "Production" for the asset type.
163 |
164 | [CreateAS](sample10/pic17.gif)
165 |
166 | 3. Scroll down to check the **Vendor** field.
167 | Because the asset type is "PRODUCTION", the vendor field is mandatory as required by the "ASSETTYPE" attribute launch point.
168 | You can see that the **Vendor** field has an asterisk to indicate that it is a required field.
169 |
170 | [CreateAS](sample10/pic18.gif)
171 |
172 | 4. In the **Purchase Price** field, enter 1000 and tab out of the field.
173 |
174 | Because the purchase price exceeds 200, the Replacement Cost value is changed to 500. which is half of the purchase price as required by the "CALREPLACECOST" attribute launch point.
175 |
176 | [CreateAS](sample10/pic19.gif)
177 |
178 | 5. In the **Purchase Price** field, enter 50000.
179 |
180 | Click on the red cross to see the following error message: "BMXZZ0001E - Please enter a value between $20 and $20000 and then press Enter."
181 |
182 | [CreateAS](sample10/pic20.gif)
183 |
184 | Now you must click the **Edit My Value** button and enter a cost between $20 and $20000 as required by the "PURCHASEPRICE" attribute launch point.
185 |
--------------------------------------------------------------------------------
/samples/sample03/poreccomm.py:
--------------------------------------------------------------------------------
1 | from __future__ import print_function
2 | # Custom Action Launchpoint PORECCOMM
3 | # Called from Escalation PORECESC
4 | # com.ibm.tivoli.maximo.script.ScriptAction
5 | # PORECCOMM,PORECCOMM,PORECCOMM
6 | # PO.LASTRECDATE is a custom attribute to reflect latest receipt date (MATREC or SERVREC)
7 | # Written against MX 7.5.0.10
8 |
9 | import java
10 | from java.util import Calendar
11 | from java.util import Date
12 | from psdi.server import MXServer
13 | from psdi.mbo import MboConstants
14 | from psdi.mbo import MboSet
15 | from com.ibm.tivoli.maximo.util.mbo import IterableMboSet
16 | servDT = MXServer.getMXServer().getDate()
17 | df = java.text.SimpleDateFormat("MM/dd/yy kk:mm")
18 | dfnow = java.text.SimpleDateFormat("kk:mm:s:S")
19 | today = MXServer.getMXServer().getDate()
20 | now = dfnow.format(today)
21 | today = df.format(today)
22 |
23 | def log(e): print(str(now) + ": "+str(launchPoint)+("__>> %s" % e) + "\r\n")
24 | print("*************")
25 | log("buffer")
26 | log("Entering Script:....."+str(now))
27 |
28 | s_poNum = str(mbo.getString("PONUM") or None)
29 | s_poDesc = str(mbo.getString("DESCRIPTION") or None)
30 | s_poVend = str(mbo.getString("VENDOR.NAME") or None)
31 | s_poType = str(mbo.getString("POTYPE") or None)
32 | b_hasReceipts,b_sendComm = (False,)*2
33 | h_tableBody = ""
34 | d_lastRecDate = mbo.getDate("LASTRECDATE") or None # Custom attribute to display and reference on PO
35 | if(d_lastRecDate is None): d_lastRecDate = mbo.getDate("STATUSDATE")
36 | d_lastRec = d_lastRecDate
37 | d_newLastRec = d_lastRec
38 |
39 | # Some substitution variables to use in HTML
40 | h_left = " style=""text-align:left;"""
41 | h_size = " style=""font-size:90%;"""
42 | h_htmlHead = ""
43 | h_htmlFoot = ""
44 | h_tableBody = ""
45 | h_poHead = "The following has been received from "+str(s_poVend)+" on PO:"+str(s_poNum)+"
"+str(s_poDesc)+"
"
46 | h_tableHead = "The following has been received from "+str(s_poVend)+" on PO:"+str(s_poNum)+"
"+str(s_poDesc)+"
"
58 | h_tableHead = "runscript.sh command line tool.
12 |
13 | ## Skill requirements
14 |
15 | * You **MUST HAVE** knowledge of Maximo instrumentation tools.
16 | * You **MUST HAVE** knowledge in how to work with command line instructions on Maximo Asset Management.
17 | * You **MUST KNOW** about the application server and Maximo deployment structure to easily localize the generated scripts by using the create.bat script file.
18 | * This document will be executed in MAC OS that uses a UNIX-based operating system.
19 | * You know how to use a terminal and how to handle the command prompt, particularly how to execute commands and navigates through directories on the file system.
20 |
21 | ## Software requirements
22 |
23 | * You **MUST HAVE** an instance of Maximo Asset Managenet version 7.5 or later.
24 | * You must know about the MAXIMO_HOME and MAXIMO_CLASSPATH variables.
25 | * You also know about the JAVA_HOME and CLASSPATH variables.
26 |
27 | ## For this sample
28 |
29 | You must have executed the [Schedule Dates](AS01_scheduleDates.md) sample in order to have a script to export and import.
30 |
31 | ## Import and export an automation script from a dbc file
32 |
33 | You can set up the environment to start using the tool to import or export an automation script into a dbc file.
34 | Recently, the latest version of Maximo Asset Management added the psdi.tools.DBCConverter tool, which includes the addition of some parameters that you can use to import and export an automation script to several different extensions. The following parameters are used to export the automation scripts:
35 |
36 | | -sSCRIPT | The source automation script. |
| -n | The name of the automation script. |
| -y | Add delete statement before insert. |
| -f | The file name. Must end with .ora, .sqs, .db2, .sql, or .dbc. For dbc scripts use .dbc |
| -h | The host name - if unspecified, localhost is used. |
| -u | The user in form of a valid e-mail account name. |
| -p | The password for the user. |
| -t | The tenant code - value must be the tenant code for consultant users in multi-tenancy. |
COMPSETACTUALDATES or the given name for the executed sample.
77 |
78 | [Script](sample11/pic1.png)
79 |
80 |
81 | # Steps to export an automation script into a .dbc file
82 |
83 | 1. Open a command prompt or terminal.
84 | 2. Navigate to the following directory: /[MAXIMO_HOME]/tools/maximo/internal
85 | 3. Run the following command to extract the automation script in a dbc file:
86 |
87 | ```
88 | $JAVA_HOME/bin/java -cp "../classes:$MAXIMO_CLASSPATH:mail.jar:/$MAXIMO_HOME/applications/maximo/lib/*:." psdi.tools.DBCConverter -sSCRIPT -n"COMPSETACTUALDATES" -y1 -fcompsetactualsdates.dbc -umaxadmin -pmaxadmin -hlocalhost -t01
89 | ```
90 |
91 | **Note**: Depending on your environment, the slash representation and commands change whether you're using a UNIX-based operating system or a Windows-based operating system.
92 |
93 | The automation script COMPSETACTUALDATES is extracted into a .dbc file. The dbc file is available in the root folder of your WebLogic Server application domain. (i.e /WEBLOGIC_HOME/user_projects/domains/maximo)
94 |
95 |
96 | ## Importing a dbc file into the Automation Scripts application
97 |
98 | ### Prerequisites
99 |
100 | * For this example, you must delete the script that was generated from the [Schedule Dates](AS01_scheduleDates.md) sample by following these steps:
101 |
102 | 1. In the Maximo Asset Management Start Center, select **Go To > System Configuration > Platform Configuration > Automation Scripts**.
103 | 2. Filter the **Script** field to find the automation script COMPSETACTUALDATES.
104 | 3. Select the COMPSETACTUALDATES.
105 | 4. From the action menu, select **Delete Script**.
106 |
107 | [Delete Automation Script](sample11/pic2.jpg)
108 |
109 | 5. On the main tab of the Automation Scripts application, ensure that the COMPSETACTUALDATES script was deleted successfully.
110 |
111 |
112 | # Steps to import an automation script from a .dbc file
113 |
114 | 1. Open a command prompt window.
115 | 2. Use the following commands to navigate to the [MAXIMO_HOME]\tools\maximo\internal directory:
116 | ```
117 | yourmachine-mbp:echo $MAXIMO_HOME
118 | /maximo
119 | yourmachine-mbp:~ user$ cd $MAXIMO_HOME
120 | yourmachine-mbp:maximo user$ cd tools/maximo/internal/
121 | yourmachine-mbp:internal user$
122 | ```
123 | 3. In the internal folder, run the follow command at the command prompt:
124 |
125 | ```
126 | yourmachine-mbp:internal usesr$ ./runscript.sh -c/[WEBLOGIC_HOME]/user_projects/domains/maximo/script -fcompsetactualsdates
127 | ```
128 |
129 | The runscript.sh shell script has the following orientation from the usage prompt:
130 |
131 | ```kotlin
132 | Usage : -c -f